info.freelibrary.iiif.presentation.v3.properties.I18nProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jiiify-presentation-v3 Show documentation
A Java Library for version 3 of the IIIF Presentation API
There is a newer version: 0.12.4
Show newest version

package info.freelibrary.iiif.presentation.v3.properties;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonValue;

import info.freelibrary.util.Logger;
import info.freelibrary.util.LoggerFactory;
import info.freelibrary.util.StringUtils;

import info.freelibrary.iiif.presentation.v3.utils.MessageCodes;

/**
 * A base class for label, summary, attribution and metadata's label and value fields.
 */
class I18nProperty> {

    /**
     * The logger used by I18nProperty.
     */
    private static final Logger LOGGER = LoggerFactory.getLogger(I18nProperty.class, MessageCodes.BUNDLE);

    /**
     * A list of internationalized values.
     */
    protected final List myI18ns;

    /**
     * Creates a property from an array of internationalizations.
     *
     * @param aI18nArray An array of internationalizations for the property
     */
    I18nProperty(final I18n... aI18nArray) {
        myI18ns = new ArrayList<>();
        addCheckedI18ns(aI18nArray);
    }

    /**
     * Creates a property from an array of string(s).
     *
     * @param aStringArray An array of strings for the property
     */
    I18nProperty(final String... aStringArray) {
        myI18ns = new ArrayList<>();
        addCheckedStrings(aStringArray);
    }

    /**
     * Sets the string value of the property, removing all other previous strings.
     *
     * @param aStringArray A string value
     * @return True if the property's value was set
     */
    @JsonIgnore
    protected I18nProperty setStrings(final String... aStringArray) {
        myI18ns.clear();
        return addCheckedStrings(aStringArray);
    }

    /**
     * Sets the internationalization of the property, removing all other previous internationalizations.
     *
     * @param aI18nArray An array of I18n(s).
     * @return True if the property's value was set
     */
    protected I18nProperty setI18ns(final I18n... aI18nArray) {
        myI18ns.clear();
        return addCheckedI18ns(aI18nArray);
    }

    /**
     * Gets a list of the property's internationalizations.
     *
     * @return A list of the property's internationalizations
     */
    public List getI18ns() {
        return myI18ns;
    }

    /**
     * Returns the first string value (regardless of language). If there isn't one it returns a null;
     *
     * @return A string value for the property
     */
    public String getString() {
        if (hasStrings()) {
            return myI18ns.get(0).getStrings().get(0);
        } else {
            return null;
        }
    }

    /**
     * Returns whether the property has any internationalizations.
     *
     * @return True if the property has internationalizations; else, false
     */
    public boolean hasStrings() {
        return !myI18ns.isEmpty();
    }

    /**
     * Tests if the supplied object equals this one.
     *
     * @return True if they are equal; else, false
     */
    @Override
    public boolean equals(final Object aObject) {
        if (aObject != null && getClass().getName().equals(aObject.getClass().getName())) {
            return toMap().equals(((I18nProperty) aObject).toMap());
        } else {
            return false;
        }
    }

    /**
     * Returns a hash code for this property.
     *
     * @return A hash code
     */
    @Override
    public int hashCode() {
        return toMap().hashCode();
    }

    /**
     * Returns a string representation of this property.
     *
     * @return A string representation of this property
     */
    @Override
    public String toString() {
        if (hasStrings()) {
            final Iterator iterator = myI18ns.iterator();
            final StringBuilder builder = new StringBuilder();

            while (iterator.hasNext()) {
                final I18n i18n = iterator.next();
                final String[] strings = i18n.getStrings().toArray(new String[i18n.size()]);

                builder.append(i18n.getLang()).append('=');
                builder.append(StringUtils.toString(strings, '|')).append(System.lineSeparator());
            }

            return builder.toString();
        } else {
            return null;
        }
    }

    /**
     * Adds a string value to the property.
     *
     * @param aStringArray An array of strings to add to the property
     * @return The property
     */
    protected I18nProperty addStrings(final String... aStringArray) {
        return addCheckedStrings(aStringArray);
    }

    /**
     * Adds an internationalization to the property.
     *
     * @param aI18nArray A list of internationalizations
     * @return The property
     */
    protected I18nProperty addI18ns(final I18n... aI18nArray) {
        return addCheckedI18ns(aI18nArray);
    }

    /**
     * Gets the JSON value of the property.
     *
     * @return The value(s) of the property
     */
    @JsonValue
    protected Object toMap() {
        if (hasStrings()) {
            final Map map = new LinkedHashMap<>(); // maintains insertion order
            final Iterator iterator = myI18ns.iterator();

            while (iterator.hasNext()) {
                final I18n i18n = iterator.next();

                map.put(i18n.getLang(), i18n.getStrings());
            }

            return map;
        } else {
            return null;
        }
    }

    /**
     * Adds strings to the I18nProperty after they've been checked and confirmed to not be null.
     *
     * @param aStringArray An array of strings
     * @return The property
     */
    private I18nProperty addCheckedStrings(final String... aStringArray) {
        Objects.requireNonNull(aStringArray, MessageCodes.JPA_001);

        for (final String string : aStringArray) {
            Objects.requireNonNull(string, MessageCodes.JPA_001);

            if (!myI18ns.add(new I18n(I18n.DEFAULT_LANG, string))) {
                throw new UnsupportedOperationException(LOGGER.getMessage(MessageCodes.JPA_043, string));
            }
        }

        return this;
    }

    /**
     * Adds internationalized values to the I18nProperty after they've been checked and confirmed to not be null.
     *
     * @param aI18nArray An array of internationalized values
     * @return The property
     */
    private I18nProperty addCheckedI18ns(final I18n... aI18nArray) {
        Objects.requireNonNull(aI18nArray, MessageCodes.JPA_001);

        for (final I18n i18n : aI18nArray) {
            Objects.requireNonNull(i18n, MessageCodes.JPA_001);

            if (!myI18ns.add(i18n)) {
                throw new UnsupportedOperationException(LOGGER.getMessage(MessageCodes.JPA_043, i18n.toString()));
            }
        }

        return this;
    }
}