nl.vpro.domain.media.UsedLanguage 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

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.

There is a newer version: 8.3.1

Show newest version

package nl.vpro.domain.media;

import lombok.Setter;

import java.io.Serializable;
import java.util.*;
import java.util.stream.Collectors;

import jakarta.persistence.*;
import jakarta.xml.bind.annotation.*;

import org.checkerframework.checker.nullness.qual.NonNull;
import org.meeuw.i18n.languages.LanguageCode;
import org.meeuw.i18n.languages.validation.Language;

import nl.vpro.i18n.Displayable;
import nl.vpro.i18n.LocalizedString;
import nl.vpro.validation.WarningValidatorGroup;

/**
 * Combines a language (as a {@link Locale}) with its role for a {@link MediaObject}, as a {@link Usage}
 * @since 8.2
 */
@XmlType(name = "usedLanguageType")
@Embeddable
public record UsedLanguage (

    @PomsValidCountry(groups = WarningValidatorGroup.class)
    @Language(mayContainCountry = true, groups = WarningValidatorGroup.class)
    @Column(name = "languages")
    @XmlAttribute(name = "code", required = true)
    @NonNull Locale code,

    @Column
    @Enumerated(EnumType.STRING)
    @NonNull Usage usage

) implements Displayable, Serializable {

    public static UsedLanguage of(Locale locale) {
        return new UsedLanguage(locale, Usage.AUDIODESCRIPTION);
    }

    public static UsedLanguage of(LanguageCode code) {
        return new UsedLanguage(code.toLocale(), Usage.AUDIODESCRIPTION);
    }

    public static UsedLanguage dubbed(LanguageCode code) {
        return new UsedLanguage(code.toLocale(), Usage.DUBBED);
    }

    public static UsedLanguage of(String code) {
        return of(LanguageCode.get(code).orElseThrow());
    }

    public static List of(List locale) {
        return locale.stream().map(UsedLanguage::of).collect(Collectors.toList());
    }

    public static List asList(Locale... locale) {
        return Arrays.stream(locale).map(UsedLanguage::of).collect(Collectors.toList());
    }

    @Override
    public LocalizedString getDisplayName(Locale locale) {
        return LocalizedString.of(code().getDisplayName(locale), locale);
    }

    /**
     * Just to map the enum of kafka objects.
     */
    public static Usage usageOf(Enum value) {
        if (value == null) {
            return Usage.AUDIODESCRIPTION;
        }
        return Usage.valueOf(value.name().toUpperCase());
    }


    @XmlType(name = "languageUsageEnum")
    public enum Usage {
        /**
         * The language is spoken
         */
        AUDIODESCRIPTION,

        /**
         * The language is used for dubbing
         */
        DUBBED,

        /**
         * ?
         */
        SUPPLEMENTAL,

        /**
         * The (sign) language is used as a translation
         * For subtitles see {@link AvailableSubtitles}
         */
        SIGNING
    }

    @XmlTransient
    public static abstract class AbstractWrapper {


        protected Locale code;

        @Setter
        protected UsedLanguage.Usage usage;

        public AbstractWrapper() {
        }

        public AbstractWrapper(String code){
            this.code = new Locale(code);
            this.usage = null;
        }

        public AbstractWrapper(UsedLanguage language) {
            this.code = language == null ? null : language.code();
            this.usage = language == null || language.usage() == null || language.usage() == UsedLanguage.Usage.AUDIODESCRIPTION ?  null : language.usage();
        }


        public Locale getCode() {
            return code;
        }
        public void setCode(Locale code) {
            this.code = code;

        }
        public UsedLanguage getUsedLanguage() {
            if (code == null) {
                throw new IllegalStateException();
            }
            return  (usage == null ? UsedLanguage.of(code) : new UsedLanguage(code, usage));
        }

        @XmlAttribute
        public UsedLanguage.Usage getUsage() {
            return usage == null || usage == UsedLanguage.Usage.AUDIODESCRIPTION ? null : usage;
        }

    }



}