CollectionReference.java

package info.textgrid.services.textapi.apiv2;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

/**
 * Simple reference for a collection inside a TextAPI v2 Collection.
 * Holds the collection IRI (id) and a short title taken from the
 * metadata of the referenced collection.
 */
@JsonPropertyOrder({
    "id",
    "shortTitle"
})
@JsonInclude(JsonInclude.Include.NON_NULL)
public class CollectionReference {

    private String id;
    private String shortTitle;

    /**
     * Required collection IRI.
     */
    public String getId() {
        return id;
    }

    public CollectionReference setId(String id) {
        this.id = id;
        return this;
    }

    /**
     * Short title of the referenced collection, extracted from its metadata.
     */
    public String getShortTitle() {
        return shortTitle;
    }

    public CollectionReference setShortTitle(String shortTitle) {
        this.shortTitle = shortTitle;
        return this;
    }
}