Class SchemaAnalysisAnnotation

  • All Implemented Interfaces:
    java.io.Serializable

    public class SchemaAnalysisAnnotation
    extends Annotation
    SchemaAnalysisAnnotation is used to describe the results of reviewing the structure of the content of an asset. This structure is expressed as what is called a schema. Of then the schema describes a set of nested data fields that each have a name and a type.
    See Also:
    Serialized Form
    • Constructor Detail

      • SchemaAnalysisAnnotation

        public SchemaAnalysisAnnotation()
        Default constructor
      • SchemaAnalysisAnnotation

        public SchemaAnalysisAnnotation​(SchemaAnalysisAnnotation template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getSchemaName

        public java.lang.String getSchemaName()
        Return the name of the schema - this will be used in the creation of the schema object and reflects the content associated with the asset. The schema that is created/validated is unique to the asset.
        Returns:
        name of schema
      • setSchemaName

        public void setSchemaName​(java.lang.String schemaName)
        Set up the name of the schema - this will be used in the creation of the schema object and reflects the content associated with the asset. The schema that is created/validated is unique to the asset.
        Parameters:
        schemaName - name of schema
      • getSchemaTypeName

        public java.lang.String getSchemaTypeName()
        Return the name of the schema type for this asset.
        Returns:
        name
      • setSchemaTypeName

        public void setSchemaTypeName​(java.lang.String schemaTypeName)
        Set up the name of the schema type for this asset.
        Parameters:
        schemaTypeName - name
      • getDiscoveredDataFields

        public int getDiscoveredDataFields()
        Return the number of discovered data fields in this schema.
        Returns:
        integer
      • setDiscoveredDataFields

        public void setDiscoveredDataFields​(int discoveredDataFields)
        Set up the number of discovered data fields in this schema.
        Parameters:
        discoveredDataFields - integer
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class Annotation
        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 Annotation
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Create a hash code for this element type.
        Overrides:
        hashCode in class Annotation
        Returns:
        int hash code