info.freelibrary.iiif.presentation.v3.ModelContent 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;

import java.net.URI;
import java.util.Arrays;
import java.util.List;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonSetter;

import info.freelibrary.iiif.presentation.v3.properties.Behavior;
import info.freelibrary.iiif.presentation.v3.properties.Homepage;
import info.freelibrary.iiif.presentation.v3.properties.Label;
import info.freelibrary.iiif.presentation.v3.properties.Metadata;
import info.freelibrary.iiif.presentation.v3.properties.PartOf;
import info.freelibrary.iiif.presentation.v3.properties.Provider;
import info.freelibrary.iiif.presentation.v3.properties.Rendering;
import info.freelibrary.iiif.presentation.v3.properties.RequiredStatement;
import info.freelibrary.iiif.presentation.v3.properties.SeeAlso;
import info.freelibrary.iiif.presentation.v3.properties.Summary;
import info.freelibrary.iiif.presentation.v3.properties.behaviors.ResourceBehavior;
import info.freelibrary.iiif.presentation.v3.utils.JsonKeys;

/**
 * Model content that can be associated with an annotation or used as a thumbnail.
 */
@JsonPropertyOrder({ JsonKeys.ID, JsonKeys.TYPE, JsonKeys.THUMBNAIL, JsonKeys.FORMAT, JsonKeys.LANGUAGE })
public class ModelContent extends AbstractContentResource
        implements AnnotationBody, ContentResource, Resource {

    /**
     * Creates a model content resource from the supplied ID.
     *
     * @param aID An model content resource ID in string form
     */
    public ModelContent(final String aID) {
        super(ResourceTypes.MODEL, aID);
    }

    /**
     * Creates a model content resource from the supplied ID.
     *
     * @param aID An model content ID
     */
    public ModelContent(final URI aID) {
        super(ResourceTypes.MODEL, aID);
    }

    /**
     * Creates a model content annotation. This is used by Jackson's deserialization processes.
     */
    private ModelContent() {
        super(ResourceTypes.MODEL);
    }

    @Override
    @JsonIgnore
    public ModelContent setFormat(final MediaType aMediaType) {
        return (ModelContent) super.setFormat(aMediaType);
    }

    @Override
    @JsonSetter(JsonKeys.FORMAT)
    public ModelContent setFormat(final String aMediaType) {
        return (ModelContent) super.setFormat(aMediaType);
    }

    @Override
    @JsonSetter(JsonKeys.PROVIDER)
    public ModelContent setProviders(final Provider... aProviderArray) {
        return setProviders(Arrays.asList(aProviderArray));
    }

    @Override
    @JsonIgnore
    public ModelContent setProviders(final List aProviderList) {
        return (ModelContent) super.setProviders(aProviderList);
    }

    @Override
    public ModelContent clearBehaviors() {
        return (ModelContent) super.clearBehaviors();
    }

    @Override
    @JsonSetter(JsonKeys.BEHAVIOR)
    public ModelContent setBehaviors(final Behavior... aBehaviorArray) {
        return (ModelContent) super.setBehaviors(checkBehaviors(ResourceBehavior.class, true, aBehaviorArray));
    }

    @Override
    public ModelContent setBehaviors(final List aBehaviorList) {
        return (ModelContent) super.setBehaviors(checkBehaviors(ResourceBehavior.class, true, aBehaviorList));
    }

    @Override
    public ModelContent addBehaviors(final Behavior... aBehaviorArray) {
        return (ModelContent) super.addBehaviors(checkBehaviors(ResourceBehavior.class, false, aBehaviorArray));
    }

    @Override
    public ModelContent addBehaviors(final List aBehaviorList) {
        return (ModelContent) super.addBehaviors(checkBehaviors(ResourceBehavior.class, false, aBehaviorList));
    }

    @Override
    public ModelContent setSeeAlsoRefs(final SeeAlso... aSeeAlsoArray) {
        return (ModelContent) super.setSeeAlsoRefs(aSeeAlsoArray);
    }

    @Override
    public ModelContent setSeeAlsoRefs(final List aSeeAlsoList) {
        return (ModelContent) super.setSeeAlsoRefs(aSeeAlsoList);
    }

    @Override
    public ModelContent setServices(final Service... aServiceArray) {
        return (ModelContent) super.setServices(aServiceArray);
    }

    @Override
    public ModelContent setServices(final List> aServiceList) {
        return (ModelContent) super.setServices(aServiceList);
    }

    @Override
    public ModelContent setPartOfs(final PartOf... aPartOfArray) {
        return (ModelContent) super.setPartOfs(aPartOfArray);
    }

    @Override
    public ModelContent setPartOfs(final List aPartOfList) {
        return (ModelContent) super.setPartOfs(aPartOfList);
    }

    @Override
    public ModelContent setRenderings(final Rendering... aRenderingArray) {
        return (ModelContent) super.setRenderings(aRenderingArray);
    }

    @Override
    public ModelContent setRenderings(final List aRenderingList) {
        return (ModelContent) super.setRenderings(aRenderingList);
    }

    @Override
    public ModelContent setHomepages(final Homepage... aHomepageArray) {
        return (ModelContent) super.setHomepages(aHomepageArray);
    }

    @Override
    public ModelContent setHomepages(final List aHomepageList) {
        return (ModelContent) super.setHomepages(aHomepageList);
    }

    @Override
    public ModelContent setThumbnails(final ContentResource... aThumbnailArray) {
        return (ModelContent) super.setThumbnails(aThumbnailArray);
    }

    @Override
    public ModelContent setThumbnails(final List> aThumbnailList) {
        return (ModelContent) super.setThumbnails(aThumbnailList);
    }

    @Override
    public ModelContent setID(final String aID) {
        return (ModelContent) super.setID(aID);
    }

    @Override
    public ModelContent setID(final URI aID) {
        return (ModelContent) super.setID(aID);
    }

    @Override
    public ModelContent setRights(final String aRights) {
        return (ModelContent) super.setRights(aRights);
    }

    @Override
    public ModelContent setRights(final URI aRights) {
        return (ModelContent) super.setRights(aRights);
    }

    @Override
    public ModelContent setRequiredStatement(final RequiredStatement aStatement) {
        return (ModelContent) super.setRequiredStatement(aStatement);
    }

    @Override
    public ModelContent setSummary(final String aSummary) {
        return (ModelContent) super.setSummary(aSummary);
    }

    @Override
    public ModelContent setSummary(final Summary aSummary) {
        return (ModelContent) super.setSummary(aSummary);
    }

    @Override
    public ModelContent setMetadata(final Metadata... aMetadataArray) {
        return (ModelContent) super.setMetadata(aMetadataArray);
    }

    @Override
    public ModelContent setMetadata(final List aMetadataList) {
        return (ModelContent) super.setMetadata(aMetadataList);
    }

    @Override
    public ModelContent setLabel(final String aLabel) {
        return (ModelContent) super.setLabel(aLabel);
    }

    @Override
    public ModelContent setLabel(final Label aLabel) {
        return (ModelContent) super.setLabel(aLabel);
    }
}