Class SchemaElement

  • Direct Known Subclasses:
    SchemaAttribute, SchemaType

    public abstract class SchemaElement
    extends Referenceable

    The SchemaElement object provides a base class for the pieces that make up a schema for an asset. A schema provides information about how the data is structured in the asset. Schemas are typically described as nested structures of schema elements. There are two basic types:

    • SchemaType describes the structure of data.
    • SchemaAttribute describes the use of another schema as part of the structure within a bigger schema.

    Assets are linked to a SchemaType.

    • Field Detail

      • displayName

        protected java.lang.String displayName
      • description

        protected java.lang.String description
    • Constructor Detail

      • SchemaElement

        public SchemaElement()
        Default constructor
      • SchemaElement

        public SchemaElement​(SchemaElement template)
        Copy/clone Constructor.
        Parameters:
        template - template object to copy.
    • Method Detail

      • getDisplayName

        public java.lang.String getDisplayName()
        Return the simple name of the schema element.
        Returns:
        string name
      • setDisplayName

        public void setDisplayName​(java.lang.String name)
        Set up the simple name of the schema element.
        Parameters:
        name - String display name
      • getDescription

        public java.lang.String getDescription()
        Returns the stored description property for the schema element.
        Returns:
        string description
      • setDescription

        public void setDescription​(java.lang.String description)
        Set up the stored description property for the schema element.
        Parameters:
        description - string description
      • cloneSchemaElement

        public abstract SchemaElement cloneSchemaElement()
        Return a clone of this schema element. This method is needed because schema element is abstract.
        Returns:
        Clone of subclass.
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class Referenceable
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class Referenceable
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Return a number that represents the contents of this object.
        Overrides:
        hashCode in class Referenceable
        Returns:
        int