Class DataField

  • All Implemented Interfaces:
    java.io.Serializable

    public class DataField
    extends PropertyBase
    DataField describes a single data field (column, attribute or property) discovered during the analysis of an asset. It provides an anchor for annotations that are specific to the field.
    See Also:
    Serialized Form
    • Constructor Detail

      • DataField

        public DataField()
        Default constructor
      • DataField

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

      • getDataFieldPosition

        public int getDataFieldPosition()
        Return the position (index) of the data field in the schema.
        Returns:
        integer
      • setDataFieldPosition

        public void setDataFieldPosition​(int dataFieldPosition)
        Set up the position (index) of the data field in the schema.
        Parameters:
        dataFieldPosition - integer
      • getDataFieldName

        public java.lang.String getDataFieldName()
        Return the name of this data field.
        Returns:
        string name
      • setDataFieldName

        public void setDataFieldName​(java.lang.String dataFieldName)
        Set up the name of this data field.
        Parameters:
        dataFieldName - string name
      • getDataFieldType

        public java.lang.String getDataFieldType()
        Return the name of type of this data field.
        Returns:
        string type name
      • setDataFieldType

        public void setDataFieldType​(java.lang.String dataFieldType)
        Set up the name of type of this data field.
        Parameters:
        dataFieldType - string type name
      • getDataFieldDescription

        public java.lang.String getDataFieldDescription()
      • setDataFieldDescription

        public void setDataFieldDescription​(java.lang.String dataFieldDescription)
      • getDataFieldAliases

        public java.util.List<java.lang.String> getDataFieldAliases()
      • setDataFieldAliases

        public void setDataFieldAliases​(java.util.List<java.lang.String> dataFieldAliases)
      • setDataFieldSortOrder

        public void setDataFieldSortOrder​(DataItemSortOrder dataFieldSortOrder)
      • getDefaultValue

        public java.lang.String getDefaultValue()
      • setDefaultValue

        public void setDefaultValue​(java.lang.String defaultValue)
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.String> getAdditionalProperties()
        Return any additional properties.
        Returns:
        map of property name to property value
      • setAdditionalProperties

        public void setAdditionalProperties​(java.util.Map<java.lang.String,​java.lang.String> additionalProperties)
        Set up any additional properties.
        Parameters:
        additionalProperties - map of property name to property value
      • getDataFieldAnnotations

        public int getDataFieldAnnotations()
        Return the number of the annotations currently attached to this data field.
        Returns:
        integer
      • setDataFieldAnnotations

        public void setDataFieldAnnotations​(int dataFieldAnnotations)
        Set up the number of the annotations currently attached to this data field.
        Parameters:
        dataFieldAnnotations - integer
      • getNestedDataFields

        public int getNestedDataFields()
        Return the number of nested data fields.
        Returns:
        integer
      • setNestedDataFields

        public void setNestedDataFields​(int nestedDataFields)
        Set up the number of nested data fields.
        Parameters:
        nestedDataFields - integer
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        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 java.lang.Object
        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 java.lang.Object
        Returns:
        int hash code