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

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonSetter;

import info.freelibrary.iiif.presentation.v3.properties.Label;
import info.freelibrary.iiif.presentation.v3.properties.Metadata;
import info.freelibrary.iiif.presentation.v3.properties.NavDate;
import info.freelibrary.iiif.presentation.v3.properties.Provider;
import info.freelibrary.iiif.presentation.v3.properties.Summary;
import info.freelibrary.iiif.presentation.v3.utils.JsonKeys;

/**
 * A navigable resource.
 */
class NavigableResource> extends AbstractResource> {

    /**
     * The date of the navigable resource.
     */
    private NavDate myNavDate;

    /**
     * Creates a navigable resource.
     *
     * @param aType A resource type in string form
     */
    protected NavigableResource(final String aType) {
        super(aType);
    }

    /**
     * Creates a navigable resource.
     *
     * @param aType A resource type in string form
     * @param aID An ID in string form
     */
    protected NavigableResource(final String aType, final URI aID) {
        super(aType, aID);
    }

    /**
     * Creates a navigable resource.
     *
     * @param aType A resource type in string form
     * @param aID An ID in string form
     * @param aLabel A descriptive label, in string form
     */
    protected NavigableResource(final String aType, final String aID, final String aLabel) {
        super(aType, aID, aLabel);
    }

    /**
     * Creates a navigable resource.
     *
     * @param aType A resource type in string form
     * @param aID An ID
     * @param aLabel A descriptive label
     */
    protected NavigableResource(final String aType, final URI aID, final Label aLabel) {
        super(aType, aID, aLabel);
    }

    /**
     * Creates a navigable resource.
     *
     * @param aType A resource type in string form
     * @param aID An ID in string form
     * @param aLabel A descriptive label in string form
     * @param aMetadataList A list of metadata properties
     * @param aSummary A summary in string form
     * @param aThumbnail A thumbnail
     * @param aProvider A resource provider
     */
    protected NavigableResource(final String aType, final String aID, final String aLabel,
            final List aMetadataList, final String aSummary, final ContentResource aThumbnail,
            final Provider aProvider) {
        super(aType, aID, aLabel, aMetadataList, aSummary, aThumbnail, aProvider);
    }

    /**
     * Creates a navigable resource.
     *
     * @param aType A resource type in string form
     * @param aID An ID
     * @param aLabel A descriptive label
     * @param aMetadataList A list of metadata properties
     * @param aSummary A summary
     * @param aThumbnail A thumbnail
     * @param aProvider A resource provider
     */
    protected NavigableResource(final String aType, final URI aID, final Label aLabel,
            final List aMetadataList, final Summary aSummary, final ContentResource aThumbnail,
            final Provider aProvider) {
        super(aType, aID, aLabel, aMetadataList, aSummary, aThumbnail, aProvider);
    }

    /**
     * Gets a navigation date.
     *
     * @return The navigation date
     */
    @JsonGetter(JsonKeys.NAV_DATE)
    public NavDate getNavDate() {
        return myNavDate;
    }

    /**
     * Sets a navigation date.
     *
     * @param aNavDate The navigation date
     * @return The navigable resource
     */
    @JsonSetter(JsonKeys.NAV_DATE)
    protected NavigableResource setNavDate(final NavDate aNavDate) {
        myNavDate = aNavDate;
        return this;
    }
}