info.freelibrary.iiif.presentation.v3.properties.AbstractLinkProperty 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.properties;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
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.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.core.JsonProcessingException;
import info.freelibrary.util.Logger;
import info.freelibrary.util.LoggerFactory;
import info.freelibrary.iiif.presentation.v3.JsonParsingException;
import info.freelibrary.iiif.presentation.v3.MediaType;
import info.freelibrary.iiif.presentation.v3.utils.JSON;
import info.freelibrary.iiif.presentation.v3.utils.JsonKeys;
import info.freelibrary.iiif.presentation.v3.utils.MessageCodes;
/**
* A linking class that specific linking properties can extend.
*/
@JsonPropertyOrder({ JsonKeys.ID, JsonKeys.TYPE, JsonKeys.LABEL, JsonKeys.FORMAT, JsonKeys.PROFILE, JsonKeys.LANGUAGE })
abstract class AbstractLinkProperty> implements Localized {
/**
* The AbstractLinkProperty logger.
*/
private static final Logger LOGGER = LoggerFactory.getLogger(AbstractLinkProperty.class, MessageCodes.BUNDLE);
/**
* The size of a single value array.
*/
private static final int SINGLE_VALUE_ARRAY_SIZE = 1;
/**
* The link property ID.
*/
private URI myID;
/**
* The link property type.
*/
private String myType;
/**
* The link property format.
*/
private MediaType myFormat;
/**
* The link property profile.
*/
private URI myProfile;
/**
* The link property label.
*/
private Label myLabel;
/**
* The link property languages.
*/
private List myLanguages;
/**
* Creates an abstract link property.
*
* @param aID An ID in string form
* @param aType A resource type
*/
protected AbstractLinkProperty(final String aID, final String aType) {
this(URI.create(aID), aType);
}
/**
* Creates an abstract link property.
*
* @param aID An ID
* @param aType A resource type
*/
protected AbstractLinkProperty(final URI aID, final String aType) {
myID = Objects.requireNonNull(aID);
myType = Objects.requireNonNull(aType);
}
/**
* Creates an abstract link property.
*
* @param aID An ID in string form
* @param aType A resource type
* @param aLabel A label in string form
*/
protected AbstractLinkProperty(final String aID, final String aType, final String aLabel) {
this(URI.create(aID), aType, new Label(aLabel));
}
/**
* Creates an abstract link property.
*
* @param aID An ID
* @param aType A resource type
* @param aLabel A label
*/
protected AbstractLinkProperty(final URI aID, final String aType, final Label aLabel) {
myID = Objects.requireNonNull(aID);
myType = Objects.requireNonNull(aType);
myLabel = Objects.requireNonNull(aLabel);
}
/**
* Creates an abstract link property for the Jackson deserialization process.
*/
protected AbstractLinkProperty() {
// This is intentionally empty
}
/**
* Creates an abstract link property with a supplied type.
*
* @param aType The type of link property
*/
protected AbstractLinkProperty(final String aType) {
myType = Objects.requireNonNull(aType);
}
/**
* Sets the ID.
*
* @param aID An ID
* @return The resource whose ID is being set
*/
protected AbstractLinkProperty setID(final URI aID) {
myID = Objects.requireNonNull(aID);
return this;
}
/**
* Gets the ID.
*
* @return An ID
*/
@JsonGetter(JsonKeys.ID)
public URI getID() {
return myID;
}
/**
* Sets the resource type.
*
* @param aType A resource type
* @return The resource whose type is being set
*/
protected AbstractLinkProperty setType(final String aType) {
myType = Objects.requireNonNull(aType);
return this;
}
/**
* Gets the resource type.
*
* @return The resource type
*/
public String getType() {
return myType;
}
/**
* Gets format as a media type.
*
* @return An optional media type format
*/
@JsonIgnore
public Optional getFormat() {
return Optional.ofNullable(myFormat);
}
/**
* Gets format as a string.
*
* @return An optional string format
*/
@JsonGetter(JsonKeys.FORMAT)
@JsonInclude(Include.NON_EMPTY)
protected Optional getFormatAsString() {
return myFormat != null ? Optional.of(myFormat.toString()) : Optional.empty();
}
/**
* Sets format in string form.
*
* @param aFormat A resource's format
* @return The resource whose format is being set
*/
@JsonSetter(JsonKeys.FORMAT)
protected AbstractLinkProperty setFormat(final String aFormat) {
myFormat = MediaType.fromString(aFormat).orElse(null);
return this;
}
/**
* Sets format.
*
* @param aFormat A resource's format
* @return The resource whose format is being set
*/
@JsonIgnore
protected AbstractLinkProperty setFormat(final MediaType aFormat) {
myFormat = Objects.requireNonNull(aFormat);
return this;
}
/**
* Gets the resource's languages.
*
* @return A list of the resource's languages
*/
@Override
@JsonIgnore
public List getLanguages() {
if (myLanguages == null) {
myLanguages = new ArrayList<>();
}
return myLanguages;
}
/**
* Gets the profile.
*
* @return An optional profile URI
*/
@JsonIgnore
public Optional getProfile() {
return Optional.ofNullable(myProfile);
}
/**
* Sets the profile.
*
* @param aProfile A profile
* @return The resource whose profile is being set
*/
@JsonIgnore
protected AbstractLinkProperty setProfile(final URI aProfile) {
myProfile = Objects.requireNonNull(aProfile);
return this;
}
/**
* Gets a descriptive label.
*
* @return A descriptive label
*/
@JsonGetter(JsonKeys.LABEL)
@JsonInclude(Include.NON_EMPTY)
protected Label getNullableLabel() {
return myLabel;
}
/**
* Sets the descriptive label.
*
* @param aLabel A descriptive label
* @return The resource whose label is being set
*/
@JsonSetter(JsonKeys.LABEL)
protected AbstractLinkProperty setLabel(final Label aLabel) {
myLabel = Objects.requireNonNull(aLabel);
return this;
}
/**
* Gets a hash code for this property.
*
* @return A hash code
*/
@Override
public int hashCode() {
return Objects.hash(myID, myType, myFormat, myProfile, myLabel);
}
/**
* Tests whether the supplied object is equal to this one.
*
* @return True if the objects are equal; else, false
*/
@Override
public boolean equals(final Object aObject) {
if (aObject instanceof AbstractLinkProperty) {
final AbstractLinkProperty otherLink = (AbstractLinkProperty) aObject;
return Objects.equals(myID, otherLink.myID) //
&& Objects.equals(myType, otherLink.myType) //
&& Objects.equals(myFormat, otherLink.myFormat) //
&& Objects.equals(myProfile, otherLink.myProfile) //
&& Objects.equals(myLabel, otherLink.myLabel);
} else {
return false;
}
}
/**
* Returns a JSON string representing this resource.
*
* @return A JSON string representing this resource
*/
@Override
public String toString() {
try {
return JSON.getWriter(this.getClass()).writeValueAsString(this);
} catch (final JsonProcessingException details) {
throw new JsonParsingException(details);
}
}
/**
* Used by Jackson's serialization processes.
*
* @return A form of language ready to be serialized
*/
@JsonGetter(JsonKeys.LANGUAGE)
@JsonInclude(Include.NON_EMPTY)
protected Object getLanguageProperty() {
final List languages = getLanguages();
if (languages.size() == SINGLE_VALUE_ARRAY_SIZE) {
return languages.get(0);
} else {
return languages;
}
}
/**
* Used by Jackson's deserialization processes.
*
* @param aObject An object to be deserialized
* @return This resource
* @throws IllegalArgumentException If the object supplied is unsupported
*/
@JsonSetter(JsonKeys.LANGUAGE)
protected AbstractLinkProperty setLanguageProperty(final Object aObject) {
if (aObject instanceof String) {
return (AbstractLinkProperty) setLanguages((String) aObject);
} else if (aObject instanceof String[]) {
return (AbstractLinkProperty) setLanguages((String[]) aObject);
} else if (aObject instanceof List) {
final List list = (List) aObject;
if (!list.isEmpty() && list.get(0) instanceof String) {
return (AbstractLinkProperty) setLanguages(list.toArray(new String[0]));
}
} else {
throw new IllegalArgumentException(LOGGER.getMessage(MessageCodes.JPA_052, aObject.getClass().getName()));
}
return this;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy