• Home
• io.citrine
• jpif
• 2.1.8
• source code
• Property.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.citrine.jpif.obj.common.Property Maven / Gradle / Ivy

package io.citrine.jpif.obj.common;

import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Information about a property and conditions under which it exists.
 *
 * 
Supported fields:
 * 

 *     
name - Name of the property.
 *     
scalars - List of {@link Scalar}s representing scalar values.
 *     
vectors - List of arrays of {@link Scalar}s, each representing a vector.
 *     
matrices - List of arrays of arrays of {@link Scalar}s, each representing a matrix.
 *     
files - List of arrays of {@link FileReference} objects.
 *     
units - Units of the values.
 *     
conditions - Conditions under which the property was measured or calculated.
 *     
methods - List of {@link Method}s used to perform the measurement or calculation.
 *     
dataType - {@link DataType} of the property.
 *     
references - List of {@link Reference}s for the property.
 *     
contacts - List of people ({@link Person}) to contact about the property.
 *     
licenses - List of {@link License}s for the property.
 *     
tags - List of tags that apply to the property.
 * 
 *
 * @author Kyle Michel
 */
public class Property extends Value {
    // Since java does not allow for multiple inheritance, this class encapsulates an {@link Rcl} object that
    // adds support for reference, contact, and license information.

    /**
     * Set the list of conditions for this property.
     *
     * @param conditions List of {@link Value} objects with the conditions for this property.
     */
    @JsonSetter(value = "conditions")
    protected void setConditions(final List conditions) { // Private since only Jackson should use it
        this.conditions = conditions;
    }

    /**
     * Set the list of conditions for this property.
     *
     * @param condition List of {@link Value} objects with the conditions for this property.
     */
    @JsonSetter(value = "condition")
    protected void setCondition(final List condition) { // Private since only Jackson should use it
        setConditions(condition);
    }

    /**
     * Add a condition for this property.
     *
     * @param condition {@link Value} object with the condition to add.
     * @return This object.
     */
    public Property addCondition(final Value condition) {
        if (this.conditions == null) {
            this.conditions = new ArrayList<>();
        }
        this.conditions.add(condition);
        return this;
    }

    /**
     * Insert a single condition for this property.
     *
     * @param index Index at which to insert the input condition.
     * @param condition {@link Value} object to add for the property.
     * @return This object.
     */
    public Property addCondition(final int index, final Value condition) {
        if (this.conditions == null) {
            this.conditions = new ArrayList<>();
        }
        this.conditions.add(index, condition);
        return this;
    }

    /**
     * Remove a condition from the property.
     *
     * @param condition {@link Value} object to delete.
     * @return True if the object was removed.
     */
    public boolean removeCondition(final Value condition) {
        return (this.conditions != null) && this.conditions.remove(condition);
    }

    /**
     * Get the number of conditions for this property.
     *
     * @return Number of conditions for this property.
     */
    public int numConditions() {
        return (this.conditions == null) ? 0 : this.conditions.size();
    }

    /**
     * Get a condition for this property at a set index.
     *
     * @param index Index of the condition to get.
     * @return {@link Value} object at the input index.
     * @throws IndexOutOfBoundsException if the index is out of range of the conditions list.
     */
    @JsonIgnore
    public Value getCondition(final int index) {
        if (this.conditions == null) {
            throw new IndexOutOfBoundsException("Attempting to access condition " + index + " of "
                    + this.numConditions());
        }
        return this.conditions.get(index);
    }

    /**
     * Get an {@link Iterable} object to iterate over conditions of this property.
     *
     * @return {@link Iterable} object for iterating over conditions of this property.
     */
    public Iterable conditions() {
        return (this.conditions == null) ? Collections.emptyList() : this.conditions;
    }

    /**
     * Get the list of conditions for this property.
     *
     * @return List of {@link Value} objects with conditions for this property.
     */
    @JsonGetter(value = "conditions")
    protected List getConditions() { // Private since only Jackson should use it
        return this.conditions;
    }

    /**
     * Set the list of methods for this property.
     *
     * @param methods List of {@link Method} objects with the methods for this property.
     */
    @JsonSetter(value = "methods")
    @JsonDeserialize(contentUsing = Method.Deserializer.class)
    protected void setMethods(final List methods) { // Private since only Jackson should use it
        this.methods = methods;
    }

    /**
     * Set the list of methods for this property.
     *
     * @param method List of {@link Method} objects with the methods for this property.
     */
    @JsonSetter(value = "method")
    @JsonDeserialize(contentUsing = Method.Deserializer.class)
    protected void setMethod(final List method) { // Private since only Jackson should use it
        setMethods(method);
    }

    /**
     * Set the method that was used.
     *
     * @param method {@link Method} for this property.
     * @return This object
     */
    @JsonIgnore
    @Deprecated
    public Property setMethod(final Method method) {
        setMethod(new ArrayList<>(Collections.singletonList(method)));
        return this;
    }

    /**
     * Add a method for this property.
     *
     * @param method {@link Method} object with the method to add.
     * @return This object.
     */
    public Property addMethod(final Method method) {
        if (this.methods == null) {
            this.methods = new ArrayList<>();
        }
        this.methods.add(method);
        return this;
    }

    /**
     * Insert a single method for this property.
     *
     * @param index Index at which to insert the input method.
     * @param method {@link Method} object to add for the property.
     * @return This object.
     */
    public Property addMethod(final int index, final Method method) {
        if (this.methods == null) {
            this.methods = new ArrayList<>();
        }
        this.methods.add(index, method);
        return this;
    }

    /**
     * Remove a method from the property.
     *
     * @param method {@link Method} object to delete.
     * @return True if the object was removed.
     */
    public boolean removeMethod(final Method method) {
        return (this.methods != null) && this.methods.remove(method);
    }

    /**
     * Get the number of methods for this property.
     *
     * @return Number of methods for this property.
     */
    public int numMethods() {
        return (this.methods == null) ? 0 : this.methods.size();
    }

    /**
     * Get the method that was used.
     *
     * @return {@link Method} that was used.
     */
    @JsonIgnore
    @Deprecated
    public Method getMethod() {
        return (this.numMethods() > 0)
                ? this.getMethod(0)
                : null;
    }

    /**
     * Get a method for this property at a set index.
     *
     * @param index Index of the method to get.
     * @return {@link Method} object at the input index.
     * @throws IndexOutOfBoundsException if the index is out of range of the methods list.
     */
    @JsonIgnore
    public Method getMethod(final int index) {
        if (this.methods == null) {
            throw new IndexOutOfBoundsException("Attempting to access method " + index + " of " + this.numMethods());
        }
        return this.methods.get(index);
    }

    /**
     * Get an {@link Iterable} object to iterate over methods of this property.
     *
     * @return {@link Iterable} object for iterating over methods of this property.
     */
    public Iterable methods() {
        return (this.methods == null) ? Collections.emptyList() : this.methods;
    }

    /**
     * Get the list of methods for this property.
     *
     * @return List of {@link Method} objects with methods for this property.
     */
    @JsonGetter(value = "methods")
    protected List getMethods() { // Private since only Jackson should use it
        return this.methods;
    }

    /**
     * Set the type of the data for the property.
     *
     * @param dataType {@link DataType} object for the property.
     * @return This object.
     */
    @JsonSetter(value = "dataType")
    public Property setDataType(final DataType dataType) {
        this.dataType = dataType;
        return this;
    }

    /**
     * Get the data type of the property.
     *
     * @return {@link DataType}
     */
    @JsonGetter
    public DataType getDataType() {
        return this.dataType;
    }

    /**
     * Set the list of references where information about this item is published.
     *
     * @param references List of {@link Reference} objects with the references for this item.
     */
    @JsonSetter(value = "references")
    protected void setReferences(final List references) { // Private since only Jackson should use it
        this.rcl.setReferences(references);
    }

    /**
     * Set the list of references where information about this item is published.
     *
     * @param reference List of {@link Reference} objects with the references for this item.
     */
    @JsonSetter(value = "reference")
    protected void setReference(final List reference) { // Private since only Jackson should use it
        setReferences(reference);
    }

    /**
     * Add a reference where information about this item is published.
     *
     * @param reference {@link Reference} object with the reference to add for this item.
     * @return This object.
     */
    public Property addReference(final Reference reference) {
        this.rcl.addReference(reference);
        return this;
    }

    /**
     * Insert a single reference for this property.
     *
     * @param index Index at which to insert the input reference.
     * @param reference {@link Reference} object to add for the property.
     * @return This object.
     */
    public Property addReference(final int index, final Reference reference) {
        this.rcl.addReference(index, reference);
        return this;
    }

    /**
     * Remove a reference from the property.
     *
     * @param reference {@link Reference} object to delete.
     * @return True if the object was removed.
     */
    public boolean removeReference(final Reference reference) {
        return this.rcl.removeReference(reference);
    }

    /**
     * Get the number of references for this item.
     *
     * @return Number of references for this item.
     */
    public int numReferences() {
        return this.rcl.numReferences();
    }

    /**
     * Get a reference for this item at a set index.
     *
     * @param index Index of the reference to get.
     * @return {@link Reference} object at the input index.
     * @throws IndexOutOfBoundsException if the index is out of range of the reference list.
     */
    @JsonIgnore
    public Reference getReference(final int index) {
        return this.rcl.getReference(index);
    }

    /**
     * Get an {@link Iterable} object to iterate over references for this item.
     *
     * @return {@link Iterable} object for iterating over references for this item.
     */
    public Iterable references() {
        return this.rcl.references();
    }

    /**
     * Get the list of references for this item.
     *
     * @return List of {@link Reference} objects with references for this item.
     */
    @JsonGetter(value = "references")
    protected List getReferences() { // Private since only Jackson should use it
        return this.rcl.getReferences();
    }

    /**
     * Set the list of people to contact for information about this item.
     *
     * @param contacts List of {@link Person} objects with the contacts for this item.
     */
    @JsonSetter(value = "contacts")
    @JsonDeserialize(contentUsing = Person.Deserializer.class)
    protected void setContacts(final List contacts) { // Private since only Jackson should use it
        this.rcl.setContacts(contacts);
    }

    /**
     * Set the list of people to contact for information about this item.
     *
     * @param contact List of {@link Person} objects with the contacts for this item.
     */
    @JsonSetter(value = "contact")
    @JsonDeserialize(contentUsing = Person.Deserializer.class)
    protected void setContact(final List contact) { // Private since only Jackson should use it
        setContacts(contact);
    }

    /**
     * Add a person to contact for information about this item.
     *
     * @param contact {@link Person} object with the contact to add.
     * @return This object.
     */
    public Property addContact(final Person contact) {
        this.rcl.addContact(contact);
        return this;
    }

    /**
     * Insert a single person to contact for information about this property.
     *
     * @param index Index at which to insert the input contact.
     * @param contact {@link Person} object to add for the property.
     * @return This object.
     */
    public Property addContact(final int index, final Person contact) {
        this.rcl.addContact(index, contact);
        return this;
    }

    /**
     * Remove a contact from the property.
     *
     * @param contact {@link Person} object to delete.
     * @return True if the object was removed.
     */
    public boolean removeContact(final Person contact) {
        return this.rcl.removeContact(contact);
    }

    /**
     * Get the number of contacts for this item.
     *
     * @return Number of contacts for this item..
     */
    public int numContacts() {
        return this.rcl.numContacts();
    }

    /**
     * Get a contact at a set index.
     *
     * @param index Index of the contact to get.
     * @return {@link Person} object with the contact at the input index.
     * @throws IndexOutOfBoundsException if the index is out of range of the contact list.
     */
    @JsonIgnore
    public Person getContact(final int index) {
        return this.rcl.getContact(index);
    }

    /**
     * Get an {@link Iterable} object to iterate over contacts for this item.
     *
     * @return {@link Iterable} object for iterating over contacts for this item.
     */
    public Iterable contacts() {
        return this.rcl.contacts();
    }

    /**
     * Get the list of contacts for this item.
     *
     * @return List of {@link Person} objects with contacts for this item.
     */
    @JsonGetter(value = "contacts")
    private List getContacts() { // Private since only Jackson should use it
        return this.rcl.getContacts();
    }

    /**
     * Set the list of licenses for this item.
     *
     * @param licenses List of {@link License} objects with licenses for this item.
     */
    @JsonSetter(value = "licenses")
    @JsonDeserialize(contentUsing = License.Deserializer.class)
    protected void setLicenses(final List licenses) { // Private since only Jackson should use it
        this.rcl.setLicenses(licenses);
    }

    /**
     * Set the list of licenses for this item.
     *
     * @param license List of {@link License} objects with licenses for this item.
     */
    @JsonSetter(value = "license")
    @JsonDeserialize(contentUsing = License.Deserializer.class)
    protected void setLicense(final List license) { // Private since only Jackson should use it
        setLicenses(license);
    }

    /**
     * Add a license for this item.
     *
     * @param license {@link License} object with the license to add.
     * @return This object.
     */
    public Property addLicense(final License license) {
        this.rcl.addLicense(license);
        return this;
    }

    /**
     * Insert a single license for this property.
     *
     * @param index Index at which to insert the input license.
     * @param license {@link License} object to add for the property.
     * @return This object.
     */
    public Property addLicense(final int index, final License license) {
        this.rcl.addLicense(index, license);
        return this;
    }

    /**
     * Remove a license from this property.
     *
     * @param license {@link License} object to delete.
     * @return True if the object was removed.
     */
    public boolean removeLicense(final License license) {
        return this.rcl.removeLicense(license);
    }

    /**
     * Get the number of licenses for this item.
     *
     * @return Number of licenses for this item..
     */
    @JsonIgnore
    public int numLicenses() {
        return this.rcl.numLicenses();
    }

    /**
     * Get a license at a set index.
     *
     * @param index Index of the license to get.
     * @return {@link License} object with the license at the input index.
     * @throws IndexOutOfBoundsException if the index is out of range of the license list.
     */
    @JsonIgnore
    public License getLicense(final int index) {
        return this.rcl.getLicense(index);
    }

    /**
     * Get an {@link Iterable} object to iterate over licenses for this item.
     *
     * @return {@link Iterable} object for iterating over licenses for this item.
     */
    public Iterable licenses() {
        return this.rcl.licenses();
    }

    /**
     * Get the list of licenses for this item.
     *
     * @return List of {@link License} objects with licenses for this item.
     */
    @JsonGetter(value = "licenses")
    protected List getLicenses() { // Private since only Jackson should use it
        return this.rcl.getLicenses();
    }

    @Override
    @JsonSetter(value = "name")
    public Property setName(final String name) {
        super.setName(name);
        return this;
    }

    @Override
    public Property addScalar(final Scalar scalar) {
        super.addScalar(scalar);
        return this;
    }

    @Override
    public Property addScalar(final int index, final Scalar scalar) {
        super.addScalar(index, scalar);
        return this;
    }

    @Override
    public Property addScalar(final String scalar) {
        super.addScalar(scalar);
        return this;
    }

    @Override
    public Property addScalar(final int index, final String scalar) {
        super.addScalar(index, scalar);
        return this;
    }

    @Override
    public Property addScalar(final Number scalar) {
        super.addScalar(scalar);
        return this;
    }

    @Override
    public Property addScalar(final int index, final Number scalar) {
        super.addScalar(index, scalar);
        return this;
    }

    @Override
    public Property addVector(final Scalar[] vector) {
        super.addVector(vector);
        return this;
    }

    @Override
    public Property addVector(final int index, final Scalar[] vector) {
        super.addVector(index, vector);
        return this;
    }

    @Override
    public Property addVector(final String[] vector) {
        super.addVector(vector);
        return this;
    }

    @Override
    public Property addVector(final int index, final String[] vector) {
        super.addVector(index, vector);
        return this;
    }

    @Override
    public Property addVector(final Number[] vector) {
        super.addVector(vector);
        return this;
    }

    @Override
    public Property addVector(final int index, final Number[] vector) {
        super.addVector(index, vector);
        return this;
    }

    @Override
    public Property addMatrix(final Scalar[][] matrix) {
        super.addMatrix(matrix);
        return this;
    }

    @Override
    public Property addMatrix(final int index, final Scalar[][] matrix) {
        super.addMatrix(index, matrix);
        return this;
    }

    @Override
    public Property addMatrix(final String[][] matrix) {
        super.addMatrix(matrix);
        return this;
    }

    @Override
    public Property addMatrix(final int index, final String[][] matrix) {
        super.addMatrix(index, matrix);
        return this;
    }

    @Override
    public Property addMatrix(final Number[][] matrix) {
        super.addMatrix(matrix);
        return this;
    }

    @Override
    public Property addMatrix(final int index, final Number[][] matrix) {
        super.addMatrix(index, matrix);
        return this;
    }

    @Override
    public Property addFile(final FileReference file) {
        super.addFile(file);
        return this;
    }

    @Override
    public Property addFile(final int index, final FileReference file) {
        super.addFile(file);
        return this;
    }

    @Override
    @JsonSetter(value = "units")
    public Property setUnits(final String units) {
        super.setUnits(units);
        return this;
    }

    @Override
    public Property addTag(final String tag) {
        super.addTag(tag);
        return this;
    }

    @Override
    public Property addTag(final int index, final String tag) {
        super.addTag(index, tag);
        return this;
    }

    @Override
    @JsonAnySetter
    public Property addUnsupportedField(final String key, final Object value) {
        super.addUnsupportedField(key, value);
        return this;
    }

    /** List of conditions for the property. */
    private List conditions;

    /** Method used to obtain the property. */
    private List methods;

    /** Type of the data represented by the property. */
    private DataType dataType;

    /** Encapsulated Rcl object. */
    private final Rcl rcl = new Rcl();

    /**
     * Enumeration of data types.
     *
     * @author Kyle Michel
     */
    public enum DataType {

        /** Machine learning data type. */
        MACHINE_LEARNING(0, "MACHINE_LEARNING"),

        /** Computational data type. */
        COMPUTATIONAL(1, "COMPUTATIONAL", "CALCULATED"),

        /** Experimental data type. */
        EXPERIMENTAL(2, "EXPERIMENTAL"),

        /** A fit to a set of data. */
        FIT(3, "FIT");

        /**
         * Get the name of the data type.
         *
         * @return Name of the data type.
         */
        @JsonValue
        public String getName() {
            return this.name;
        }

        /**
         * Get the code for the data type.
         *
         * @return Integer with the code for the data type.
         */
        @JsonIgnore
        public int getCode() {
            return this.code;
        }

        /**
         * Get a data type given a lookup string.
         *
         * @param dataTypeName String with the name of the data type.
         * @return {@link DataType} object corresponding to lookup or a null pointer if the name is not valid.
         */
        @JsonCreator
        public static DataType get(final String dataTypeName) {
            return (dataTypeName == null)
                    ? null
                    : NAME_TO_DATA_TYPE_MAP.get(normalizeName(dataTypeName));
        }

        /**
         * Constructor.
         *
         * @param  code Code to assign to the object.
         * @param  name Name to assign to the object.
         */
        DataType(final int code, final String... name) {
            this.code = code;
            this.name = name[0];
            this.lookup = Collections.unmodifiableList(getLookupStrings(name));
        }

        /**
         * Generate a list of lookup strings from a list of names.
         *
         * @param  name List of names to convert to lookups.
         * @return List of lookup strings.
         */
        private static List getLookupStrings(final String[] name) {
            List res = new ArrayList<>(name.length);
            for (String i : name) {
                res.add(normalizeName(i));
            }
            return res;
        }

        /**
         * Normalize the input string to get a lookup name.
         *
         * @param name String to normalize.
         * @return Normalized version of the input name.
         */
        private static String normalizeName(final String name) {
            return name.trim().substring(0, LOOKUP_LENGTH).toLowerCase();
        }

        /** Code for the data type. */
        protected final int code;

        /** Name of the data type. */
        protected final String name;

        /** Lookup of the data type. */
        protected final List lookup;

        /** Number of characters to use in lookup. */
        protected static final int LOOKUP_LENGTH = 3;

        /** Map of lookup strings to their enumerated values. */
        protected static final Map NAME_TO_DATA_TYPE_MAP =
                Collections.unmodifiableMap(buildLookupMap());

        /**
         * Build the map of lookup strings to their data type.
         *
         * @return Map of lookup strings to their data type.
         */
        private static Map buildLookupMap() {
            Map res = new HashMap<>(values().length);
            for (DataType i : values()) {
                for (String j : i.lookup) {
                    res.put(j, i);
                }
            }
            return res;
        }
    }
}