info.freelibrary.iiif.presentation.v3.AbstractResource 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
Show all versions of jiiify-presentation-v3 Show documentation
A Java Library for version 3 of the IIIF Presentation API
package info.freelibrary.iiif.presentation.v3; // NOPMD
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.JsonUnwrapped;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import info.freelibrary.util.Logger;
import info.freelibrary.util.LoggerFactory;
import info.freelibrary.util.warnings.PMD;
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.DisjointChecker;
import info.freelibrary.iiif.presentation.v3.utils.JsonKeys;
import info.freelibrary.iiif.presentation.v3.utils.MessageCodes;
/**
* A resource that can be used as a base for more specific IIIF presentation resources.
*/
@SuppressWarnings({ PMD.EXCESSIVE_IMPORTS, PMD.ABSTRACT_CLASS_WITHOUT_ABSTRACT_METHOD, PMD.GOD_CLASS })
@JsonInclude(JsonInclude.Include.NON_EMPTY)
@JsonPropertyOrder({ JsonKeys.CONTEXT, JsonKeys.ID, JsonKeys.TYPE, JsonKeys.LABEL, JsonKeys.PROVIDER, JsonKeys.PART_OF,
JsonKeys.BEHAVIOR, JsonKeys.HOMEPAGE, JsonKeys.THUMBNAIL, JsonKeys.SUMMARY, JsonKeys.METADATA, JsonKeys.START,
JsonKeys.RIGHTS, JsonKeys.REQUIRED_STATEMENT, JsonKeys.VIEWING_DIRECTION, JsonKeys.RENDERING, JsonKeys.SEE_ALSO,
JsonKeys.ITEMS, JsonKeys.SERVICE, JsonKeys.STRUCTURES, JsonKeys.SERVICES, JsonKeys.NAV_DATE, JsonKeys.ANNOTATIONS })
abstract class AbstractResource> { // NOPMD
/**
* The logger used by abstract resources.
*/
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractResource.class, MessageCodes.BUNDLE);
/**
* The resource type.
*/
@JsonProperty(JsonKeys.TYPE)
protected String myType;
/**
* The resource ID.
*/
@JsonProperty(JsonKeys.ID)
private URI myID;
/**
* The resource label.
*/
private Label myLabel;
/**
* The resource's partOfs.
*/
private List myPartOfs;
/**
* The resource's metadata.
*/
private List myMetadata;
/**
* The resource summary.
*/
private Summary mySummary;
/**
* The resource's providers.
*/
private List myProviders;
/**
* The resource's thumbnails.
*/
@JsonProperty(JsonKeys.THUMBNAIL)
@JsonDeserialize(contentUsing = ContentResourceDeserializer.class)
private List> myThumbnails;
/**
* The resource's requiredStatement.
*/
private RequiredStatement myRequiredStatement;
/**
* The rights URI of the resource.
*/
private URI myRights;
/**
* The resource's homepage.
*/
private List myHomepages;
/**
* The resource renderings.
*/
private List myRenderings;
/**
* The resource's behaviors.
*/
@JsonProperty(JsonKeys.BEHAVIOR)
@JsonDeserialize(using = BehaviorsDeserializer.class)
private List myBehaviors;
/**
* The resource's seeAlsos.
*/
private List mySeeAlsoRefs;
/**
* The resource's services.
*/
@JsonDeserialize(contentUsing = ServiceDeserializer.class)
private List> myServices;
/**
* Creates a new resource from the supplied type.
*
* @param aType A resource type
*/
protected AbstractResource(final String aType) {
myType = Objects.requireNonNull(aType);
}
/**
* Creates a new resource from the supplied ID and type.
*
* @param aType A resource type
* @param aID A URI ID in string form
*/
protected AbstractResource(final String aType, final String aID) {
myType = Objects.requireNonNull(aType);
myID = URI.create(aID);
}
/**
* Creates a new resource from the supplied ID and type.
*
* @param aType A resource type
* @param aID A URI ID
*/
protected AbstractResource(final String aType, final URI aID) {
myType = Objects.requireNonNull(aType);
myID = Objects.requireNonNull(aID);
}
/**
* Creates a new resource from a supplied ID, type, and label.
*
* @param aType A type of resource
* @param aID A URI ID in string form
* @param aLabel A label in string form
*/
protected AbstractResource(final String aType, final String aID, final String aLabel) {
myType = Objects.requireNonNull(aType);
myID = URI.create(aID);
myLabel = new Label(aLabel);
}
/**
* Creates a new resource from a supplied ID and label.
*
* @param aType A type of resource
* @param aID A URI ID
* @param aLabel A label for the resource
*/
protected AbstractResource(final String aType, final URI aID, final Label aLabel) {
myType = Objects.requireNonNull(aType);
myID = Objects.requireNonNull(aID);
myLabel = Objects.requireNonNull(aLabel);
}
/**
* Creates a new resource from string values.
*
* @param aType A type in string form
* @param aID An ID in string form
* @param aLabel A label in string form
* @param aMetadataList A list of metadata properties
* @param aSummary A summary property in string form
* @param aThumbnail A thumbnail
* @param aProvider A resource provider
*/
protected AbstractResource(final String aType, final String aID, final String aLabel,
final List aMetadataList, final String aSummary, final ContentResource aThumbnail,
final Provider aProvider) {
this(aType, URI.create(aID), new Label(aLabel), aMetadataList, new Summary(aSummary), aThumbnail, aProvider);
}
/**
* Creates a new resource from properties.
*
* @param aType A resource type
* @param aID A URI ID
* @param aLabel A label
* @param aMetadataList A list of metadata properties
* @param aSummary A summary property
* @param aThumbnail A thumbnail
* @param aProvider A resource provider
*/
protected AbstractResource(final String aType, final URI aID, final Label aLabel,
final List aMetadataList, final Summary aSummary, final ContentResource aThumbnail,
final Provider aProvider) {
myType = Objects.requireNonNull(aType);
myID = Objects.requireNonNull(aID);
myLabel = Objects.requireNonNull(aLabel);
myMetadata = Objects.requireNonNull(aMetadataList);
mySummary = Objects.requireNonNull(aSummary);
setResourceThumbnails(Arrays.asList(Objects.requireNonNull(aThumbnail)));
setResourceProviders(Arrays.asList(Objects.requireNonNull(aProvider)));
}
/**
* Gets the label.
*
* @return The label
*/
@JsonUnwrapped
public Label getLabel() {
return myLabel;
}
/**
* Sets the resource label from its string form.
*
* @param aLabel A label to assign to the resource
* @return The resource
*/
@JsonIgnore
protected AbstractResource setLabel(final String aLabel) {
myLabel = new Label(aLabel);
return this;
}
/**
* Sets the resource label.
*
* @param aLabel A label to assign to the resource
* @return The resource
*/
@JsonSetter(JsonKeys.LABEL)
protected AbstractResource setLabel(final Label aLabel) {
Objects.requireNonNull(aLabel);
myLabel = aLabel;
return this;
}
/**
* Gets the metadata.
*
* @return The metadata
*/
@JsonGetter(JsonKeys.METADATA)
public List getMetadata() {
if (myMetadata == null) {
myMetadata = new ArrayList<>();
}
return myMetadata;
}
/**
* Sets the resource metadata.
*
* @param aMetadataArray The metadata to associate with the resource
* @return The resource
*/
@JsonSetter(JsonKeys.METADATA)
protected AbstractResource setMetadata(final Metadata... aMetadataArray) {
return setMetadata(Arrays.asList(aMetadataArray));
}
/**
* Sets the resource metadata from a list of metadata.
*
* @param aMetadataList A list of metadata
* @return The resource
*/
@JsonIgnore
protected AbstractResource setMetadata(final List aMetadataList) {
final List metadata = getMetadata();
Objects.requireNonNull(aMetadataList);
metadata.clear();
metadata.addAll(aMetadataList);
return this;
}
/**
* Gets the summary.
*
* @return The summary
*/
@JsonUnwrapped
public Summary getSummary() {
return mySummary;
}
/**
* Sets the resource summary.
*
* @param aSummary The resource summary
* @return The resource
*/
@JsonIgnore
protected AbstractResource setSummary(final String aSummary) {
mySummary = new Summary(aSummary);
return this;
}
/**
* Sets the resource summary.
*
* @param aSummary The resource summary
* @return The resource
*/
protected AbstractResource setSummary(final Summary aSummary) {
Objects.requireNonNull(aSummary);
mySummary = aSummary;
return this;
}
/**
* Gets a list of resource thumbnails, initializing the list if this hasn't been done already.
*
* @return The resource's thumbnails
*/
@JsonGetter(JsonKeys.THUMBNAIL)
public List> getThumbnails() {
return getResourceThumbnails();
}
/**
* Sets the resource's thumbnails.
*
* @param aThumbnailArray A thumbnails array
* @return The resource
*/
@JsonSetter(JsonKeys.THUMBNAIL)
protected AbstractResource setThumbnails(final ContentResource... aThumbnailArray) {
return setResourceThumbnails(Arrays.asList(aThumbnailArray));
}
/**
* Sets the resource's thumbnails.
*
* @param aThumbnailList A thumbnails list
* @return The resource
*/
@JsonIgnore
protected AbstractResource setThumbnails(final List> aThumbnailList) {
return setResourceThumbnails(aThumbnailList);
}
/**
* Gets the required statement.
*
* @return The required statement
*/
@JsonGetter(JsonKeys.REQUIRED_STATEMENT)
public RequiredStatement getRequiredStatement() {
return myRequiredStatement;
}
/**
* Sets the resource's required statement.
*
* @param aStatement A required statement
* @return The resource
*/
@JsonSetter(JsonKeys.REQUIRED_STATEMENT)
protected AbstractResource setRequiredStatement(final RequiredStatement aStatement) {
myRequiredStatement = aStatement;
return this;
}
/**
* Gets the rights.
*
* @return The rights
*/
@JsonProperty
public URI getRights() {
return myRights;
}
/**
* Sets the resource's rights URI.
*
* @param aRights A rights URI
* @return The resource
*/
@JsonProperty
protected AbstractResource setRights(final URI aRights) {
Objects.requireNonNull(aRights);
myRights = aRights;
return this;
}
/**
* Sets the resource's rights URI.
*
* @param aRights A rights URI
* @return The resource
*/
@JsonIgnore
protected AbstractResource setRights(final String aRights) {
return setRights(URI.create(aRights));
}
/**
* Sets the resource's homepages.
*
* @param aHomepageArray An array of homepages
* @return The resource
*/
@JsonSetter(JsonKeys.HOMEPAGE)
protected AbstractResource setHomepages(final Homepage... aHomepageArray) {
return setHomepages(Arrays.asList(aHomepageArray));
}
/**
* Sets the resource's homepages.
*
* @param aHomepageList A list of homepages
* @return The resource
*/
@JsonIgnore
protected AbstractResource setHomepages(final List aHomepageList) {
final List homepages = getHomepages();
Objects.requireNonNull(aHomepageList);
homepages.clear();
homepages.addAll(aHomepageList);
return this;
}
/**
* Gets a list of resource homepages, initializing the list if this hasn't been done already.
*
* @return The resource's homepages
*/
@JsonGetter(JsonKeys.HOMEPAGE)
public List getHomepages() {
if (myHomepages == null) {
myHomepages = new ArrayList<>();
}
return myHomepages;
}
/**
* Sets the resource's providers.
*
* @param aProviderArray An array of providers
* @return The resource
*/
@JsonSetter(JsonKeys.PROVIDER)
protected AbstractResource setProviders(final Provider... aProviderArray) {
return setProviders(Arrays.asList(aProviderArray));
}
/**
* Sets the resource's providers.
*
* @param aProviderList A list of providers
* @return The resource
*/
@JsonIgnore
protected AbstractResource setProviders(final List aProviderList) {
return setResourceProviders(aProviderList);
}
/**
* Gets a list of resource providers, initializing the list if this hasn't been done already.
*
* @return The resource's providers
*/
@JsonGetter(JsonKeys.PROVIDER)
public List getProviders() {
return getResourceProviders();
}
/**
* Sets the resource's renderings.
*
* @param aRenderingArray An array of renderings
* @return The resource
*/
@JsonSetter(JsonKeys.RENDERING)
protected AbstractResource setRenderings(final Rendering... aRenderingArray) {
return setRenderings(Arrays.asList(aRenderingArray));
}
/**
* Sets the resource's renderings.
*
* @param aRenderingList A list of renderings
* @return The resource
*/
@JsonIgnore
protected AbstractResource setRenderings(final List aRenderingList) {
final List renderings = getRenderings();
Objects.requireNonNull(renderings);
renderings.clear();
renderings.addAll(aRenderingList);
return this;
}
/**
* Gets a list of resource renderings, initializing the list if this hasn't been done already.
*
* @return The resource's renderings
*/
@JsonGetter(JsonKeys.RENDERING)
public List getRenderings() {
if (myRenderings == null) {
myRenderings = new ArrayList<>();
}
return myRenderings;
}
/**
* Gets the ID.
*
* @return The ID
*/
@JsonGetter(JsonKeys.ID)
public URI getID() {
return myID;
}
/**
* Sets the resource ID.
*
* @param aID An ID
* @return The resource
*/
@JsonIgnore
protected AbstractResource setID(final String aID) {
myID = URI.create(aID);
return this;
}
/**
* Sets the resource ID.
*
* @param aID An ID
* @return The resource
*/
@JsonIgnore
protected AbstractResource setID(final URI aID) {
Objects.requireNonNull(aID);
myID = aID;
return this;
}
/**
* Sets the resource's partOfs.
*
* @param aPartOfArray An array of partOfs
* @return The resource
*/
@JsonSetter(JsonKeys.PART_OF)
protected AbstractResource setPartOfs(final PartOf... aPartOfArray) {
return setPartOfs(Arrays.asList(aPartOfArray));
}
/**
* Sets the resource's partOfs.
*
* @param aPartOfList A list of partOfs
* @return The resource
*/
@JsonIgnore
protected AbstractResource setPartOfs(final List aPartOfList) {
final List partOfs = getPartOfs();
Objects.requireNonNull(aPartOfList);
partOfs.clear();
partOfs.addAll(aPartOfList);
return this;
}
/**
* Gets a list of resource partOfs, initializing the list if this hasn't been done already.
*
* @return The resource's partOfs
*/
@JsonGetter(JsonKeys.PART_OF)
public List getPartOfs() {
if (myPartOfs == null) {
myPartOfs = new ArrayList<>();
}
return myPartOfs;
}
/**
* Gets the type.
*
* @return The type
*/
@JsonGetter(JsonKeys.TYPE)
public String getType() {
return myType;
}
/**
* Sets the resource's behaviors.
*
* @param aBehaviorArray An array of behaviors
* @return The resource
*/
@JsonIgnore
protected AbstractResource setBehaviors(final Behavior... aBehaviorArray) {
final List behaviors = getBehaviorsList();
Objects.requireNonNull(aBehaviorArray);
behaviors.clear();
behaviors.addAll(Arrays.asList(aBehaviorArray));
return this;
}
/**
* Sets the resource's behaviors.
*
* @param aBehaviorList A list of behaviors
* @return The resource
*/
@JsonSetter(JsonKeys.BEHAVIOR)
protected AbstractResource setBehaviors(final List aBehaviorList) {
// We implement this so it can be overridden, but it should never actually be called because all behavior
// setting should go through checkBehaviors() first, which returns an array for setBehaviors(Behavior...)
throw new UnsupportedOperationException(LOGGER.getMessage(MessageCodes.JPA_057));
}
/**
* Gets the resource's behaviors in an unmodifiable list.
*
* @return The resource's behaviors
*/
@JsonGetter(JsonKeys.BEHAVIOR)
public List getBehaviors() {
return Collections.unmodifiableList(getBehaviorsList());
}
/**
* Add behaviors to the resource.
*
* @param aBehaviorArray An array of behaviors
* @return The resource
*/
protected AbstractResource addBehaviors(final Behavior... aBehaviorArray) {
getBehaviorsList().addAll(Arrays.asList(aBehaviorArray));
return this;
}
/**
* Add behaviors to the resource.
*
* @param aBehaviorList A list of behaviors
* @return The resource
*/
protected AbstractResource addBehaviors(final List aBehaviorList) {
// We implement this so it can be overridden, but it should never actually be called because all behavior
// adding should go through checkBehaviors() first, which returns an array for addBehaviors(Behavior...)
throw new UnsupportedOperationException(LOGGER.getMessage(MessageCodes.JPA_058));
}
/**
* Clears the resource's behaviors.
*
* @return The resource
*/
protected AbstractResource clearBehaviors() {
getBehaviorsList().clear();
return this;
}
/**
* Gets see also reference(s).
*
* @return The see also reference(s)
*/
@JsonGetter(JsonKeys.SEE_ALSO)
public List getSeeAlsoRefs() {
if (mySeeAlsoRefs == null) {
mySeeAlsoRefs = new ArrayList<>();
}
return mySeeAlsoRefs;
}
/**
* Sets the resource's seeAlso references.
*
* @param aSeeAlsoArray An array of seeAlso references
* @return The resource
*/
@JsonIgnore
protected AbstractResource setSeeAlsoRefs(final SeeAlso... aSeeAlsoArray) {
Collections.addAll(getSeeAlsoRefs(), aSeeAlsoArray);
return this;
}
/**
* Sets the resource's seeAlso references.
*
* @param aSeeAlsoList A list of seeAlso references
* @return The resource
*/
@JsonSetter(JsonKeys.SEE_ALSO)
protected AbstractResource setSeeAlsoRefs(final List aSeeAlsoList) {
getSeeAlsoRefs().addAll(aSeeAlsoList);
return this;
}
/**
* Gets a list of resource services, initializing the list if this hasn't been done already.
*
* @return The resource's services
*/
@JsonGetter(JsonKeys.SERVICE)
public List> getServices() {
if (myServices == null) {
myServices = new ArrayList<>();
}
return myServices;
}
/**
* Sets the resource's services.
*
* @param aServiceArray An array of services
* @return The resource
*/
@JsonIgnore
protected AbstractResource setServices(final Service... aServiceArray) {
return setServices(Arrays.asList(aServiceArray));
}
/**
* Sets the resource's services.
*
* @param aServiceList A list of services
* @return The resource
*/
@JsonSetter(JsonKeys.SERVICE)
protected AbstractResource setServices(final List> aServiceList) {
final List> services = getServices();
Objects.requireNonNull(aServiceList);
services.clear();
services.addAll(aServiceList);
return this;
}
/**
* Checks that the supplied behaviors are all implementations of a particular class.
*
* @param aClass A class that implements Behavior
* @param aCleanComparison If the comparison does not check pre-existing behaviors
* @param aBehaviorList A list of behaviors
* @return The checked and valid behaviors
* @throws IllegalArgumentException If the supplied behaviors are disjoint
*/
protected Behavior[] checkBehaviors(final Class aClass, final boolean aCleanComparison,
final List aBehaviorList) {
return checkBehaviors(aClass, aCleanComparison, aBehaviorList.toArray(new Behavior[0]));
}
/**
* Checks that the supplied behaviors are all implementations of a particular class.
*
* @param aClass A class that implements Behavior
* @param aCleanComparison If the comparison does not check pre-existing behaviors
* @param aBehaviorArray An array of behaviors
* @return The checked and valid behaviors
* @throws IllegalArgumentException If the supplied behaviors are disjoint
*/
protected Behavior[] checkBehaviors(final Class aClass, final boolean aCleanComparison,
final Behavior... aBehaviorArray) {
if (aCleanComparison) {
new DisjointChecker().check(aClass, aBehaviorArray);
} else {
new DisjointChecker(getBehaviorsList()).check(aClass, aBehaviorArray);
}
return aBehaviorArray;
}
/**
* Converts a number to a float and throws an exception if the supplied number isn't positive or finite.
*
* @param aNumber A number
* @return A float
*/
protected float convertToFinitePositiveFloat(final Number aNumber) {
final float floatValue = aNumber.floatValue();
if (floatValue > 0 && Double.isFinite(floatValue)) {
return floatValue;
} else {
throw new IllegalArgumentException(LOGGER.getMessage(MessageCodes.JPA_024, floatValue));
}
}
/**
* Gets a list of resource behaviors, initializing the list if this hasn't been done already.
*
* @return A list of resource behaviors
*/
private List getBehaviorsList() {
if (myBehaviors == null) {
myBehaviors = new ArrayList<>();
}
return myBehaviors;
}
/**
* Gets a list of resource thumbnails, initializing the list if this hasn't been done already.
*
* @return The resource's thumbnails
*/
@JsonIgnore
private List> getResourceThumbnails() {
if (myThumbnails == null) {
myThumbnails = new ArrayList<>();
}
return myThumbnails;
}
/**
* Sets the resource's thumbnails.
*
* @param aThumbnailList A list of thumbnails
* @return This resource
*/
@JsonIgnore
private AbstractResource setResourceThumbnails(final List> aThumbnailList) {
final List> thumbnails = getResourceThumbnails();
Objects.requireNonNull(aThumbnailList);
thumbnails.clear();
thumbnails.addAll(aThumbnailList);
return this;
}
/**
* Gets a list of resource providers, initializing the list if this hasn't been done already.
*
* @return The resource's providers
*/
@JsonIgnore
private List getResourceProviders() {
if (myProviders == null) {
myProviders = new ArrayList<>();
}
return myProviders;
}
/**
* Sets the resource's provider.
*
* @param aProviderList A list of providers
* @return This resource
*/
@JsonIgnore
private AbstractResource setResourceProviders(final List aProviderList) {
final List providers = getResourceProviders();
Objects.requireNonNull(aProviderList);
providers.clear();
providers.addAll(aProviderList);
return this;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy