Package org.odpi.openmetadata.accessservices.analyticsmodeling.synchronization.beans

Class SchemaType

  • public class SchemaType
extends SchemaElement

    The SchemaType object provides a base class for the pieces that make up a schema for a data asset. A schema provides information about how the data is structured in the asset. Schemas are typically described as nested structures of linked schema elements. Schemas can also be reused in other schemas.

    • Field Detail

      • versionNumber

        protected String versionNumber

      • author

        protected String author

      • usage

        protected String usage

      • encodingStandard

        protected String encodingStandard

      • namespace

        protected String namespace

    • Constructor Detail

      • SchemaType

        public SchemaType()
        Default constructor

      • SchemaType

        public SchemaType​(SchemaType template)
        Copy/clone Constructor.
        Parameters:
        template - template object to copy.

    • Method Detail

      • cloneSchemaType

        public SchemaType cloneSchemaType()
        Return a clone of this schema type.
        Returns:
        Clone of subclass.

      • getVersionNumber

        public String getVersionNumber()
        Return the version number of the schema element - null means no version number.
        Returns:
        String version number

      • setVersionNumber

        public void setVersionNumber​(String versionNumber)
        Set up the version number of the schema element - null means no version number.
        Parameters:
        versionNumber - String version number

      • getAuthor

        public String getAuthor()
        Return the name of the author of the schema element. Null means the author is unknown.
        Returns:
        String author name

      • setAuthor

        public void setAuthor​(String author)
        Set up the name of the author of the schema element. Null means the author is unknown.
        Parameters:
        author - String author name

      • getUsage

        public String getUsage()
        Return the usage guidance for this schema element. Null means no guidance available.
        Returns:
        String usage guidance

      • setUsage

        public void setUsage​(String usage)
        Set up the usage guidance for this schema element. Null means no guidance available.
        Parameters:
        usage - String usage guidance

      • getEncodingStandard

        public String getEncodingStandard()
        Return the format (encoding standard) used for this schema. It may be XML, JSON, SQL DDL or something else. Null means the encoding standard is unknown or there are many choices.
        Returns:
        String encoding standard

      • setEncodingStandard

        public void setEncodingStandard​(String encodingStandard)
        Set up the format (encoding standard) used for this schema. It may be XML, JSON, SQL DDL or something else. Null means the encoding standard is unknown or there are many choices.
        Parameters:
        encodingStandard - String encoding standard

      • getNamespace

        public String getNamespace()
        Return the name of the namespace that this type belongs to.
        Returns:
        string name

      • setNamespace

        public void setNamespace​(String namespace)
        Set up the name of the namespace that this type belongs to.
        Parameters:
        namespace - string name

      • equals

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

      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class SchemaElement
        Returns:
        print out of variables in a JSON-style

      • hashCode

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