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. This can be used when building the schema.
      Parameters:
      dataFieldType - string type name

    • getDataFieldDescription

      public String getDataFieldDescription()
      Return description of this data field.
      Returns:
      text

    • setDataFieldDescription

      public void setDataFieldDescription(String dataFieldDescription)
      Set up the description of this data field.
      Parameters:
      dataFieldDescription - text

    • getDataFieldNamespace

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

    • setDataFieldNamespace

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

    • getDataFieldAliases

      public List<String> getDataFieldAliases()
      Return a list of alternative names for the data field.
      Returns:
      list of names

    • setDataFieldAliases

      public void setDataFieldAliases(List<String> dataFieldAliases)
      Set up a list of alternative names for the data field.
      Parameters:
      dataFieldAliases - list of names

    • getDataFieldSortOrder

      public DataItemSortOrder getDataFieldSortOrder()
      Return the order that the data field instances are arranged in - if any.
      Returns:
      DataItemSortOrder enum

    • setDataFieldSortOrder

      public void setDataFieldSortOrder(DataItemSortOrder dataFieldSortOrder)
      Set up the order that the data field instances are arranged in - if any.
      Parameters:
      dataFieldSortOrder - DataItemSortOrder enum

    • getMinCardinality

      public int getMinCardinality()
      Return this minimum number of instances allowed for this data field.
      Returns:
      int

    • setMinCardinality

      public void setMinCardinality(int minCardinality)
      Set up the minimum number of instances allowed for this data field.
      Parameters:
      minCardinality - int

    • getMaxCardinality

      public int getMaxCardinality()
      Return the maximum number of instances allowed for this data field.
      Returns:
      int (-1 means infinite)

    • setMaxCardinality

      public void setMaxCardinality(int maxCardinality)
      Set up the maximum number of instances allowed for this data field.
      Parameters:
      maxCardinality - int (-1 means infinite)

    • getIsNullable

      public boolean getIsNullable()
      Return whether the field is nullable or not.
      Returns:
      boolean

    • setIsNullable

      public void setIsNullable(boolean nullable)
      Set up whether the field is nullable or not.
      Parameters:
      nullable - boolean

    • getMinimumLength

      public int getMinimumLength()
      Return the minimum length of the data.
      Returns:
      int

    • setMinimumLength

      public void setMinimumLength(int minimumLength)
      Set up the minimum length of the data.
      Parameters:
      minimumLength - int

    • getLength

      public int getLength()
      Return the length of the data field.
      Returns:
      int

    • setLength

      public void setLength(int length)
      Set up the length of the data field.
      Parameters:
      length - int

    • getPrecision

      public int getPrecision()
      Return the number of significant digits to the right of decimal point.
      Returns:
      int

    • setPrecision

      public void setPrecision(int precision)
      Set up the number of significant digits to the right of decimal point.
      Parameters:
      precision - int

    • getSignificantDigits

      public int getSignificantDigits()
      Return the number of significant digits before the decimal point (zero means it is an integer).
      Returns:
      int

    • setSignificantDigits

      public void setSignificantDigits(int significantDigits)
      Set up the number of significant digits before the decimal point (zero means it is an integer).
      Parameters:
      significantDigits - int

    • getIsDeprecated

      public boolean getIsDeprecated()
      Return whether the data field is deprecated or not. Default is false.
      Returns:
      boolean flag

    • setIsDeprecated

      public void setIsDeprecated(boolean deprecated)
      Set whether the data field is deprecated or not. Default is false.
      Parameters:
      deprecated - boolean flag

    • getDefaultValue

      public String getDefaultValue()
      Return the default value for the data field. Null means no default value set up.
      Returns:
      String containing default value

    • setDefaultValue

      public void setDefaultValue(String defaultValue)
      Set up the default value for the data field. Null means no default value set up.
      Parameters:
      defaultValue - String containing default value

    • getVersion

      public long getVersion()
      Return the incremental version number.
      Returns:
      long

    • setVersion

      public void setVersion(long version)
      Set up the incremental version number.
      Parameters:
      version - long

    • getVersionIdentifier

      public String getVersionIdentifier()
      Return the descriptive version identifier.
      Returns:
      string

    • setVersionIdentifier

      public void setVersionIdentifier(String versionIdentifier)
      Set up the descriptive version identifier.
      Parameters:
      versionIdentifier - string

    • 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

    • getLinkedDataFields

      public int getLinkedDataFields()
      Return the number of linked data fields.
      Returns:
      integer

    • setLinkedDataFields

      public void setLinkedDataFields(int linkedDataFields)
      Set up the number of linked data fields.
      Parameters:
      linkedDataFields - 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