Package org.odpi.openmetadata.frameworks.discovery.properties

Class DataField

java.lang.Object
org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
org.odpi.openmetadata.frameworks.discovery.properties.DataField
All Implemented Interfaces:
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:

  • Constructor Details

    • DataField

      public DataField()
      Default constructor

    • DataField

      public DataField(DataField template)
      Copy clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • 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 String getDataFieldName()
      Return the name of this data field.
      Returns:
      string name

    • setDataFieldName

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

    • getDataFieldType

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

    • setDataFieldType

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

    • getDataFieldDescription

      public String getDataFieldDescription()

    • setDataFieldDescription

      public void setDataFieldDescription(String dataFieldDescription)

    • getDataFieldAliases

      public List<String> getDataFieldAliases()

    • setDataFieldAliases

      public void setDataFieldAliases(List<String> dataFieldAliases)

    • getDataFieldSortOrder

      public DataItemSortOrder getDataFieldSortOrder()

    • setDataFieldSortOrder

      public void setDataFieldSortOrder(DataItemSortOrder dataFieldSortOrder)

    • getDefaultValue

      public String getDefaultValue()

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • getAdditionalProperties

      public Map<String,String> getAdditionalProperties()
      Return any additional properties.
      Returns:
      map of property name to property value

    • setAdditionalProperties

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