• Home
• info.freelibrary
• jiiify-presentation-v3
• 0.10.0
• source code
• PlaceholderCanvas.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.PlaceholderCanvas Maven / Gradle / Ivy

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.JsonSetter;
import com.fasterxml.jackson.core.JsonProcessingException;

import info.freelibrary.util.warnings.Eclipse;

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 before the main content of the resource is rendered. It may
 * also be used as an advertisement or stand-in for that content. Examples include images, text and sound standing in
 * for video content before the user initiates playback; or a film poster to attract user attention. The content
 * provided by placeholderCanvas differs from a thumbnail: a client might use thumbnail to summarize and navigate
 * multiple resources, then show content from placeholderCanvas as part of the initial presentation of a single
 * resource. A placeholder canvas is likely to have different dimensions to those of the canvas(es) of the resource that
 * has the placeholderCanvas property.
 */
@SuppressWarnings({ "PMD.TooManyMethods", "PMD.ExcessivePublicCount" })
public class PlaceholderCanvas extends AbstractCanvas
        implements Resource, CanvasResource {

    /**
     * Creates a new placeholder canvas from the supplied ID.
     *
     * @param aID A placeholder canvas ID
     */
    public PlaceholderCanvas(final URI aID) {
        super(aID);
    }

    /**
     * Creates a new placeholder canvas from the supplied ID.
     *
     * @param aID A placeholder canvas ID
     */
    public PlaceholderCanvas(final String aID) {
        super(aID);
    }

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

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

    /**
     * Creates a new placeholder 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 PlaceholderCanvas(final Minter aMinter) {
        super(aMinter.getCanvasID());
    }

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

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

    /**
     * Creates a new placeholder canvas. This is used by Jackson for its deserialization processes.
     */
    @SuppressWarnings(Eclipse.UNUSED)
    private PlaceholderCanvas() {
        super();
    }

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

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

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

    @Override
    @JsonSetter(JsonKeys.BEHAVIOR)
    public PlaceholderCanvas setBehaviors(final Behavior... aBehaviorArray) {
        return (PlaceholderCanvas) super.setBehaviors(aBehaviorArray); // Checked in AbstractCanvas
    }

    @Override
    @JsonSetter(JsonKeys.BEHAVIOR)
    public PlaceholderCanvas setBehaviors(final List aBehaviorList) {
        return (PlaceholderCanvas) super.setBehaviors(aBehaviorList); // Checked in AbstractCanvas
    }

    @Override
    public PlaceholderCanvas addBehaviors(final Behavior... aBehaviorArray) {
        return (PlaceholderCanvas) super.addBehaviors(aBehaviorArray); // Checked in AbstractCanvas
    }

    @Override
    public PlaceholderCanvas addBehaviors(final List aBehaviorList) {
        return (PlaceholderCanvas) super.addBehaviors(aBehaviorList); // Checked in AbstractCanvas
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    // begin AbstractCanvas

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

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

    @Override
    @SafeVarargs
    public final PlaceholderCanvas setOtherAnnotations(final AnnotationPage>... aPageArray) {
        return (PlaceholderCanvas) super.setOtherAnnotations(aPageArray);
    }

    @Override
    public final PlaceholderCanvas setOtherAnnotations(final List>> aPageList) {
        return (PlaceholderCanvas) super.setOtherAnnotations(aPageList);
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    }

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

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

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

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

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

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

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

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

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

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

    @Override
    public final PlaceholderCanvas
            setSupplementingPages(final List> aPageArray) {
        return (PlaceholderCanvas) super.setSupplementingPages(aPageArray);
    }

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

    @Override
    public final PlaceholderCanvas setPaintingPages(final List> aPageArray) {
        return (PlaceholderCanvas) super.setPaintingPages(aPageArray);
    }

    // end AbstractCanvas

    /**
     * Returns a PlaceholderCanvas from its JSON representation.
     *
     * @param aJsonString A placeholder canvas in string form
     * @return The placeholder canvas
     */
    public static PlaceholderCanvas fromString(final String aJsonString) {
        try {
            return JSON.getReader(PlaceholderCanvas.class).readValue(aJsonString);
        } catch (final JsonProcessingException details) {
            throw new JsonParsingException(details);
        }
    }

}