info.freelibrary.iiif.presentation.v3.ContentAnnotation 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 info.freelibrary.iiif.presentation.v3.properties.TimeMode;

/**
 * An interface that defines methods related to content annotations.
 *
 * @param  A class that implements {@code ContentAnnotation}
 */
interface ContentAnnotation> {

    /**
     * Gets the content resources associated with this annotation.
     *
     * @return The content resources associated with this annotation
     */
    List> getBodies();

    /**
     * Sets the content resources.
     *
     * @param aContentArray An array of content resources
     * @return This annotation
     */
    T setBodies(AnnotationBody... aContentArray);

    /**
     * Sets the content resources.
     *
     * @param aContentList A list of content resources
     * @return This annotation
     */
    T setBodies(List> aContentList);

    /**
     * Gets the target of this annotation.
     * 
     * The return value is an instance of either {@link URI} or {@link SpecificResource}. Users should check the type
     * with instanceof and then cast as appropriate.
     * 
     *
     * @return The target
     */
    Object getTarget();

    /**
     * Sets the target of this annotation.
     *
     * @param aURI A target URI
     * @return This annotation
     */
    T setTarget(URI aURI);

    /**
     * Sets the target of this annotation in string form.
     *
     * @param aURI A target URI supplied in string form
     * @return This annotation
     */
    T setTarget(String aURI);

    /**
     * Sets the target of this annotation.
     *
     * @param aSpecificResource A target specific resource
     * @return This annotation
     */
    T setTarget(SpecificResource aSpecificResource);

    /**
     * Gets the motivation of the annotation.
     *
     * @return The motivation
     */
    String getMotivation();

    /**
     * Gets the time mode.
     *
     * @return The time mode
     */
    TimeMode getTimeMode();

    /**
     * Sets the time mode.
     *
     * @param aTimeMode A time mode
     * @return This annotation
     */
    T setTimeMode(TimeMode aTimeMode);
}