• Home
• info.freelibrary
• jiiify-presentation-v3
• 0.10.0
• source code
• AccompanyingCanvas.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

info.freelibrary.iiif.presentation.v3.AccompanyingCanvas Maven / Gradle / Ivy

package info.freelibrary.iiif.presentation.v3; // NOPMD

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

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.core.JsonProcessingException;

import info.freelibrary.util.warnings.Eclipse;
import info.freelibrary.util.warnings.JDK;
import info.freelibrary.util.warnings.PMD;

import info.freelibrary.iiif.presentation.v3.ids.Minter;
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.selectors.MediaFragmentSelector;
import info.freelibrary.iiif.presentation.v3.utils.JSON;
import info.freelibrary.iiif.presentation.v3.utils.JsonKeys;

/**
 * A single canvas that provides additional content for use while rendering the resource. Examples include: 1) an image
 * to show while a duration-only canvas is playing audio, or 2) background audio to play while a user is navigating an
 * image-only manifest.
 */
@SuppressWarnings({ PMD.TOO_MANY_METHODS, PMD.EXCESSIVE_PUBLIC_COUNT, PMD.CYCLOMATIC_COMPLEXITY })
public class AccompanyingCanvas extends AbstractCanvas // NOPMD
        implements CanvasResource { // NOPMD

    /**
     * Creates a new accompanying canvas from the supplied ID.
     *
     * @param aID An accompanying canvas ID
     */
    public AccompanyingCanvas(final URI aID) {
        super(aID);
    }

    /**
     * Creates a new accompanying canvas from the supplied ID in string form.
     *
     * @param aID An accompanying canvas ID
     */
    public AccompanyingCanvas(final String aID) {
        super(aID);
    }

    /**
     * Creates a new accompanying canvas from the supplied ID and label.
     *
     * @param aID An accompanying canvas ID
     * @param aLabel An accompanying canvas label
     */
    public AccompanyingCanvas(final URI aID, final Label aLabel) {
        super(aID, aLabel);
    }

    /**
     * Creates a new accompanying canvas from the supplied ID and label.
     *
     * @param aID An accompanying canvas ID in string form
     * @param aLabel A accompanying canvas label in string form
     */
    public AccompanyingCanvas(final String aID, final String aLabel) {
        super(aID, aLabel);
    }

    /**
     * Creates a new accompanying canvas using the supplied minter to create the canvas ID.
     *
     * @param aMinter A minter that should be used to get an ID for the canvas
     */
    public AccompanyingCanvas(final Minter aMinter) {
        super(aMinter.getCanvasID());
    }

    /**
     * Creates a new accompanying canvas using the supplied minter to create the canvas ID.
     *
     * @param aMinter A minter that will create the canvas ID
     * @param aLabel A accompanying canvas label in string form
     */
    public AccompanyingCanvas(final Minter aMinter, final String aLabel) {
        super(aMinter.getCanvasID(), new Label(aLabel));
    }

    /**
     * Creates a new accompanying canvas using the supplied minter to create the canvas ID.
     *
     * @param aMinter A minter that will create the canvas ID
     * @param aLabel A accompanying canvas label
     */
    public AccompanyingCanvas(final Minter aMinter, final Label aLabel) {
        super(aMinter.getCanvasID(), aLabel);
    }

    /**
     * Creates a new accompanying canvas. This is just used by Jackson's deserialization processes.
     */
    @SuppressWarnings(Eclipse.UNUSED)
    private AccompanyingCanvas() {
        super();
    }

    @Override
    @JsonGetter(JsonKeys.ID)
    public URI getID() {
        return super.getID();
    }

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

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

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

    @Override
    @JsonSetter(JsonKeys.BEHAVIOR)
    public AccompanyingCanvas setBehaviors(final Behavior... aBehaviorArray) {
        return (AccompanyingCanvas) super.setBehaviors(aBehaviorArray);
    }

    @Override
    @JsonSetter(JsonKeys.BEHAVIOR)
    public AccompanyingCanvas setBehaviors(final List aBehaviorList) {
        return (AccompanyingCanvas) super.setBehaviors(aBehaviorList);
    }

    @Override
    public AccompanyingCanvas addBehaviors(final Behavior... aBehaviorArray) {
        return (AccompanyingCanvas) super.addBehaviors(aBehaviorArray);
    }

    @Override
    public AccompanyingCanvas addBehaviors(final List aBehaviorList) {
        return (AccompanyingCanvas) super.addBehaviors(aBehaviorList);
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // begin AbstractCanvas

    @Override
    public AccompanyingCanvas setDuration(final Number aDuration) {
        return (AccompanyingCanvas) super.setDuration(aDuration);
    }

    @Override
    public AccompanyingCanvas setWidthHeight(final int aWidth, final int aHeight) {
        return (AccompanyingCanvas) super.setWidthHeight(aWidth, aHeight);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas paintWith(final Minter aMinter, final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.paint(this, aMinter, false, aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas paintWith(final Minter aMinter, final boolean aChoice,
            final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.paint(this, aMinter, aChoice, aContentArray);
    }

    @Override
    public final AccompanyingCanvas paintWith(final Minter aMinter, final List> aContentList) {
        return (AccompanyingCanvas) super.paint(this, aMinter, false, aContentList.toArray(new ContentResource[0]));
    }

    @Override
    public final AccompanyingCanvas paintWith(final Minter aMinter, final boolean aChoice,
            final List> aContentList) {
        return (AccompanyingCanvas) super.paint(this, aMinter, aChoice, aContentList.toArray(new ContentResource[0]));
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas paintWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.paint(this, aMinter, aCanvasRegion, false, aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas paintWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final boolean aChoice, final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.paint(this, aMinter, aCanvasRegion, aChoice, aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas paintWith(final Minter aMinter, final String aCanvasRegion,
            final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.paint(this, aMinter, new MediaFragmentSelector(aCanvasRegion), false,
                aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas paintWith(final Minter aMinter, final String aCanvasRegion, final boolean aChoice,
            final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.paint(this, aMinter, new MediaFragmentSelector(aCanvasRegion), aChoice,
                aContentArray);
    }

    @Override
    public final AccompanyingCanvas paintWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final List> aContentList) {
        return (AccompanyingCanvas) super.paint(this, aMinter, aCanvasRegion, false,
                aContentList.toArray(new ContentResource[] {}));
    }

    @Override
    public final AccompanyingCanvas paintWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final boolean aChoice, final List> aContentList) {
        return (AccompanyingCanvas) super.paint(this, aMinter, aCanvasRegion, aChoice,
                aContentList.toArray(new ContentResource[] {}));
    }

    @Override
    public final AccompanyingCanvas paintWith(final Minter aMinter, final String aCanvasRegion,
            final List> aContentList) {
        return (AccompanyingCanvas) super.paint(this, aMinter, new MediaFragmentSelector(aCanvasRegion), false,
                aContentList.toArray(new ContentResource[] {}));
    }

    @Override
    public final AccompanyingCanvas paintWith(final Minter aMinter, final String aCanvasRegion, final boolean aChoice,
            final List> aContentList) {
        return (AccompanyingCanvas) super.paint(this, aMinter, new MediaFragmentSelector(aCanvasRegion), aChoice,
                aContentList.toArray(new ContentResource[] {}));
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, false, aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final boolean aChoice,
            final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, aChoice, aContentArray);
    }

    @Override
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final List> aContentList) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, false,
                aContentList.toArray(new ContentResource[0]));
    }

    @Override
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final boolean aChoice,
            final List> aContentList) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, aChoice,
                aContentList.toArray(new ContentResource[0]));
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, aCanvasRegion, false, aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final boolean aChoice, final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, aCanvasRegion, aChoice, aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final String aCanvasRegion,
            final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, new MediaFragmentSelector(aCanvasRegion), false,
                aContentArray);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final String aCanvasRegion,
            final boolean aChoice, final ContentResource... aContentArray) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, new MediaFragmentSelector(aCanvasRegion), aChoice,
                aContentArray);
    }

    @Override
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final List> aContentList) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, aCanvasRegion, false,
                aContentList.toArray(new ContentResource[0]));
    }

    @Override
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final MediaFragmentSelector aCanvasRegion,
            final boolean aChoice, final List> aContentList) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, aCanvasRegion, aChoice,
                aContentList.toArray(new ContentResource[0]));
    }

    @Override
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final String aCanvasRegion,
            final List> aContentList) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, new MediaFragmentSelector(aCanvasRegion), false,
                aContentList.toArray(new ContentResource[0]));
    }

    @Override
    public final AccompanyingCanvas supplementWith(final Minter aMinter, final String aCanvasRegion,
            final boolean aChoice, final List> aContentList) {
        return (AccompanyingCanvas) super.supplement(this, aMinter, new MediaFragmentSelector(aCanvasRegion), aChoice,
                aContentList.toArray(new ContentResource[0]));
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas setSupplementingPages(final AnnotationPage... aPageArray) {
        return (AccompanyingCanvas) super.setSupplementingPages(aPageArray);
    }

    @Override
    public final AccompanyingCanvas
            setSupplementingPages(final List> aPageList) {
        return (AccompanyingCanvas) super.setSupplementingPages(aPageList);
    }

    @Override
    @SafeVarargs
    public final AccompanyingCanvas setPaintingPages(final AnnotationPage... aPageArray) {
        return (AccompanyingCanvas) super.setPaintingPages(aPageArray);
    }

    @Override
    public final AccompanyingCanvas setPaintingPages(final List> aPageList) {
        return (AccompanyingCanvas) super.setPaintingPages(aPageList);
    }

    @Override
    @JsonGetter(JsonKeys.ITEMS)
    public List> getPaintingPages() {
        return super.getPaintingPages();
    }

    @Override
    @JsonIgnore
    public List> getSupplementingPages() {
        return super.getSupplementingPages();
    }

    @Override
    public final AccompanyingCanvas
            setOtherAnnotations(final List>> aAnnotationList) {
        return (AccompanyingCanvas) super.setOtherAnnotations(aAnnotationList);
    }

    @SuppressWarnings(JDK.UNCHECKED)
    @Override
    public final AccompanyingCanvas
            setOtherAnnotations(final AnnotationPage>... aAnnotationArray) {
        return (AccompanyingCanvas) super.setOtherAnnotations(aAnnotationArray);
    }

    @Override
    @JsonIgnore
    public List>> getOtherAnnotations() {
        return super.getOtherAnnotations();
    }

    @Override
    @JsonGetter(JsonKeys.DURATION)
    @JsonInclude(Include.NON_DEFAULT)
    public float getDuration() {
        return super.getDuration();
    }

    @Override
    @JsonGetter(JsonKeys.HEIGHT)
    @JsonInclude(Include.NON_DEFAULT)
    public int getHeight() {
        return super.getHeight();
    }

    @Override
    @JsonGetter(JsonKeys.WIDTH)
    @JsonInclude(Include.NON_DEFAULT)
    public int getWidth() {
        return super.getWidth();
    }

    // end AbstractCanvas

    /**
     * Returns an AccompanyingCanvas from its JSON representation.
     *
     * @param aJsonString An accompanying canvas in string form
     * @throws JsonParsingException If there is trouble reading an accompanying canvas from the supplied string
     * @return The accompanying canvas
     */
    public static AccompanyingCanvas from(final String aJsonString) {
        try {
            return JSON.getReader(AccompanyingCanvas.class).readValue(aJsonString);
        } catch (final JsonProcessingException details) {
            throw new JsonParsingException(details);
        }
    }

}