info.freelibrary.iiif.presentation.v3.OtherContent 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.Map;
import java.util.Optional;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;

import info.freelibrary.util.warnings.PMD;

import info.freelibrary.iiif.presentation.v3.utils.JSON;
import info.freelibrary.iiif.presentation.v3.utils.JsonKeys;

/**
 * A content resource for other types of resources than those described by the
 * IIIF Presentation API specification. The format returned by this
 * class is always JSON. Look in the {@link JsonNode} if the wrapped context has a format in its JSON representation.
 */
@JsonPropertyOrder({ JsonKeys.ID, JsonKeys.TYPE })
public class OtherContent implements AnnotationBody, ContentResource {

    /**
     * The ID for other content.
     */
    private URI myID;

    /**
     * The type for other content.
     */
    private String myType;

    /**
     * The other content's JSON wrapped in a JsonNode.
     */
    private JsonNode myJsonNode;

    /**
     * Creates a generic content resource.
     *
     * @param aJsonNode Unspecified JSON
     */
    public OtherContent(final JsonNode aJsonNode) {
        myJsonNode = initializeObject(aJsonNode);
    }

    @Override
    @JsonIgnore
    public Optional getFormat() {
        return Optional.of(MediaType.APPLICATION_JSON);
    }

    @Override
    @JsonIgnore
    public OtherContent setFormat(final MediaType aMediaType) {
        // Our other content is always JSON because it's just a wrapper for JSON
        return this;
    }

    @Override
    @JsonSetter(JsonKeys.FORMAT)
    public OtherContent setFormat(final String aMediaType) {
        // Our other content is always JSON because it's just a wrapper for JSON
        return this;
    }

    @Override
    @JsonGetter(JsonKeys.ID)
    public URI getID() {
        return myID;
    }

    @Override
    @JsonIgnore
    public OtherContent setID(final String aID) {
        myID = URI.create(aID);
        return this;
    }

    @Override
    @JsonIgnore
    public OtherContent setID(final URI aID) {
        myID = aID;
        return this;
    }

    @Override
    @JsonIgnore
    public String getType() {
        return myType;
    }

    /**
     * Updates the content of this resource with the supplied JSON content. Changes to the JsonNode after it's been used
     * to update this resource are not persisted. Another call to setJSON(JsonNode) is required to persist
     * any additional changes.
     *
     * @param aJsonNode A JSON node
     * @return This content
     */
    @JsonIgnore
    public OtherContent setJSON(final JsonNode aJsonNode) {
        myJsonNode = initializeObject(aJsonNode.deepCopy());
        return this;
    }

    /**
     * Gets a JSON representation of this resource. Changes to the returned JsonNode are not automatically propagated
     * back to this resource. If the JsonNode is modified, you must use the setJSON(JsonNode) method to
     * persist those modifications.
     *
     * @return A JSON representation of this content resource
     */
    @JsonIgnore
    public JsonNode getJSON() {
        return myJsonNode.deepCopy();
    }

    /**
     * Gets the generic content as an object map for Jackson.
     *
     * @return An object map representing the other content
     */
    @JsonValue
    @SuppressWarnings(PMD.UNUSED_PRIVATE_METHOD) // It's used by Jackson's serialization processes
    private Map toObjectMap() { // NOPMD
        return JSON.convertValue(myJsonNode, new TypeReference>() {});
    }

    /**
     * Gets the format as a string for Jackson's deserialization process.
     *
     * @return The format in string form
     */
    @JsonGetter(JsonKeys.FORMAT)
    private Optional getFormatAsString() {
        return Optional.of(MediaType.APPLICATION_JSON.toString());
    }

    /**
     * Initializes this object with content from the supplied JsonNode.
     *
     * @param aJsonNode JSON content
     * @return The supplied JsonNode
     */
    private JsonNode initializeObject(final JsonNode aJsonNode) {
        final JsonNode idNode = aJsonNode.get(JsonKeys.ID);
        final JsonNode typeNode = aJsonNode.get(JsonKeys.TYPE);

        if (idNode != null && idNode.isTextual()) {
            myID = URI.create(idNode.textValue());
        }

        if (typeNode != null && typeNode.isTextual()) {
            myType = typeNode.textValue();
        }

        return aJsonNode;
    }

}