nl.vpro.nicam.Kijkwijzer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of media-domain Show documentation
Show all versions of media-domain Show documentation
The basic domain classes for 'media', the core of POMS. Also, the 'update' XML bindings for it.
It also contains some closely related domain classes like the enum to contain NICAM kijkwijzer settings.
package nl.vpro.nicam;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import java.io.Serial;
import java.io.Serializable;
import java.util.*;
import org.apache.commons.lang3.StringUtils;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import nl.vpro.domain.media.AgeRating;
import nl.vpro.domain.media.ContentRating;
/**
*
* See about kijkwijzer
*
* Combines an {@link AgeRating} with {@link ContentRating}s (which can be seen as the 'reason' for the rating).
*
*
* There are several ways to code a kijkwijzer in a string.
*
*
* For the content ratings, this is pretty straight forward. Every rating is assigned a simple {@link ContentRating#toChar()}. A string of those chars represents the content ratings.
*
*
* Age ratings are represented in different ways, but always as an integer. Prior to 5.12 it was always one digit. See {@link #toDonnaCode()} and {@link #toCode()}
*
*
* With the arrival of new age ratings {@link AgeRating#_14} and {@link AgeRating#_18} it was unclear what the new digits would be for those, and we decided to simply introduce a new format where the age rating is always represented with two digits, and where the correspondence is more straightforward (the integer associated with e.g. {@link AgeRating#_14} became 14) (using {@link #toPaddedCode(AgeRating)}
*
*
*
* @author Michiel Meeuwissen
* @since 4.2
*/
@Data
@Slf4j
public class Kijkwijzer implements NicamRated, Serializable {
@Serial
private static final long serialVersionUID = 9201478832377124830L;
private final AgeRating ageRating;
private final List<@NonNull ContentRating> contentRatings;
@Deprecated
public static Kijkwijzer parse(String value) {
AgeRating ageRating = null;
List contentRatings = new ArrayList<>();
if (value != null) {
for (char c : value.toCharArray()) {
switch (c) {
case '2':
ageRating = AgeRating._6;
break;
case '3':
ageRating = AgeRating._9;
break;
case '4':
ageRating = AgeRating._12;
break;
case '5':
ageRating = AgeRating._16;
break;
default:
contentRatings.add(
ContentRating.valueOf(c)
);
}
}
}
return new Kijkwijzer(ageRating, contentRatings);
}
@Deprecated
public static Kijkwijzer parseDonna(String value){
AgeRating ageRating = null;
List contentRatings = new ArrayList<>();
if (value != null) {
for (char c : value.toCharArray()) {
switch (c) {
case '1':
ageRating = AgeRating.ALL;
break;
case '2':
ageRating = AgeRating._6;
break;
case '5':
ageRating = AgeRating._9;
break;
case '3':
ageRating = AgeRating._12;
break;
case '4':
ageRating = AgeRating._16;
break;
default:
contentRatings.add(ContentRating.valueOf(c));
}
}
}
return new Kijkwijzer(ageRating, contentRatings);
}
/**
* @since 5.12
*/
public static Optional parsePaddedCode(final CharSequence value) {
if (StringUtils.isEmpty(value)) {
return Optional.empty();
}
try {
AgeRating ageRating = parsePaddedAgeRating(value);
List contentRatings = parseContentRatings(value);
return Optional.of(new Kijkwijzer(ageRating, contentRatings));
} catch (IllegalArgumentException iae) {
return Optional.empty();
}
}
@Nullable
private static AgeRating parsePaddedAgeRating(final CharSequence value) {
StringBuilder ageRatingString = new StringBuilder();
for (int i = 0; i < value.length(); i++) {
char c = value.charAt(i);
if (Character.isDigit(c) || (c == '-' && ageRatingString.length() == 0)) {
ageRatingString.append(c);
}
}
if (ageRatingString.length() == 0) {
return null;
} else if (ageRatingString.length() == 1) {
throw new IllegalArgumentException("age rating is not padded " + ageRatingString);
} else if (ageRatingString.length() == 2) {
return AgeRating.valueOf(Integer.parseInt(ageRatingString.toString()));
} else {
throw new IllegalArgumentException("age rating is not padded " + ageRatingString);
}
}
private static List parseContentRatings(final CharSequence value) {
List contentRatings = new ArrayList<>();
for (int i = 0; i < value.length(); i++) {
char c = value.charAt(i);
if (! Character.isDigit(c)) {
ContentRating r = ContentRating.valueOf(c);
if (r != null) {
contentRatings.add(r);
} else {
log.warn("Unrecognized content rating char {}", c);
}
}
}
return contentRatings;
}
@Nullable
@Deprecated
public static Character toCode(@Nullable AgeRating ageRating) {
if (ageRating == null) {
return null;
}
switch (ageRating) {
case _6:
return '2';
case _9:
return '3';
case _12:
return '4';
case _16:
return '5';
case _14:
case _18:
log.warn("We don't know the code of {}", ageRating);
return null;
default:
case ALL:
return null;
}
}
/**
* Returns the age rating as a padded int, always 2 chars.
*
* @return the agerating as a padded int, or the empty string if the given age rating is {@code null}
*/
public static String toPaddedCode(@Nullable AgeRating ageRating) {
if (ageRating == null) {
return "";
}
return String.format("%02d", ageRating.getIntValue());
}
@Nullable
public static Character toDonnaCode(@Nullable AgeRating ageRating) {
if (ageRating == null) {
return null;
}
switch (ageRating) {
case _6: return '2';
case _9: return '5';
case _12: return '3';
case _16: return '4';
default:
case ALL:
return '1';
}
}
public static Kijkwijzer of(NicamRated nicamRated) {
return new Kijkwijzer(nicamRated.getAgeRating(), nicamRated.getContentRatings());
}
public Kijkwijzer(@Nullable AgeRating ageRating, Collection<@NonNull ContentRating> contentRatings) {
this.ageRating = ageRating;
this.contentRatings = Collections.unmodifiableList(contentRatings == null ? new ArrayList<>() : new ArrayList<>(contentRatings));
}
public Kijkwijzer(@Nullable AgeRating ageRating, @NonNull ContentRating... contentRatings) {
this(ageRating, Arrays.asList(contentRatings));
}
public Kijkwijzer() {
this(null, new ArrayList<>());
}
public Kijkwijzer withAgeRating(AgeRating ageRating) {
return new Kijkwijzer(ageRating, contentRatings);
}
public Kijkwijzer withContentRating(ContentRating... contentRating) {
List result = new ArrayList<>(contentRatings);
result.addAll(Arrays.asList(contentRating));
return new Kijkwijzer(ageRating, result);
}
public Kijkwijzer withContentRatings(List contentRatings) {
return new Kijkwijzer(ageRating, contentRatings);
}
@Deprecated
public String toDonnaCode() {
StringBuilder result = new StringBuilder();
Character ageRatingCode = toDonnaCode(ageRating);
if (ageRatingCode != null) {
result.append(ageRatingCode);
}
appendContentRatings(result);
return result.toString();
}
@Deprecated
public String toCode() {
StringBuilder result = new StringBuilder();
Character ageRatingCode = toCode(ageRating);
if (ageRatingCode != null) {
result.append(ageRatingCode);
}
appendContentRatings(result);
return result.toString();
}
/**
* A short string representing this NICAM rating, a 2 digit integer {@link #toPaddedCode(AgeRating)} followed by the {@link ContentRating#toChar()}s of the content ratings.
* @since 5.12
*/
public String toPaddedCode() {
StringBuilder result = new StringBuilder();
result.append(toPaddedCode(ageRating));
appendContentRatings(result);
return result.toString();
}
private void appendContentRatings(StringBuilder result) {
for (ContentRating rating : contentRatings) {
if (rating == null) {
// impossible, but hibernate seems to cause it some times
log.warn("null rating in {}", contentRatings);
} else {
result.append(rating.toChar());
}
}
}
}