Package org.odpi.openmetadata.frameworks.connectors.properties

Class AssetSchemaElement

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    AssetSchemaType
    public abstract class AssetSchemaElement
extends AssetReferenceable
    The AssetSchemaElement 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.
    See Also:
    Serialized Form

    • Field Detail

    • Constructor Detail

      • AssetSchemaElement

        protected AssetSchemaElement​(AssetDescriptor parentAsset)
        Constructor used by the subclasses
        Parameters:
        parentAsset - descriptor of asset that this property relates to.

      • AssetSchemaElement

        public AssetSchemaElement​(SchemaElement schemaElementBean)
        Bean constructor
        Parameters:
        schemaElementBean - bean containing the schema element properties

      • AssetSchemaElement

        public AssetSchemaElement​(AssetDescriptor parentAsset,
                          SchemaElement schemaElementBean)
        Bean constructor with parent.
        Parameters:
        parentAsset - descriptor of asset that this property relates to.
        schemaElementBean - bean containing the schema element properties

      • AssetSchemaElement

        public AssetSchemaElement​(AssetDescriptor parentAsset,
                          AssetSchemaElement template)
        Copy/clone Constructor - the parentAsset is passed separately to the template because it is also likely to be being cloned in the same operation and we want the definitions clone to point to the asset clone and not the original asset.
        Parameters:
        parentAsset - description of the asset that this schema element is attached to.
        template - template object to copy.

    • Method Detail

      • setBean

        protected void setBean​(SchemaElement schemaElementBean)
        Set up the bean that contains the properties of the schema element.
        Parameters:
        schemaElementBean - bean containing all of the properties

      • getSchemaElementBean

        protected SchemaElement getSchemaElementBean()
        Return this schema type bean.
        Returns:
        An instance of the appropriate subclass of SchemaElement bean

      • isDeprecated

        public boolean isDeprecated()
        Is the schema element deprecated?
        Returns:
        boolean flag

      • getDisplayName

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

      • getDescription

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

      • toString

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

      • equals

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