Package org.odpi.openmetadata.frameworks.openmetadata.properties.schema

Class SchemaAttributeProperties

java.lang.Object
org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataRootProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.ReferenceableProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaElementProperties
org.odpi.openmetadata.frameworks.openmetadata.properties.schema.SchemaAttributeProperties
Direct Known Subclasses:
APIParameterProperties, DatabaseTableProperties, DataContainerProperties, DataFieldProperties, EventSchemaAttributeProperties, SchemaAttributeRequestBody, TabularColumnProperties
public class SchemaAttributeProperties extends SchemaElementProperties
SchemaAttributeProperties represents a data field that is part of a complex schema type.

  • Constructor Details

    • SchemaAttributeProperties

      public SchemaAttributeProperties()
      Default constructor

    • SchemaAttributeProperties

      public SchemaAttributeProperties(SchemaAttributeProperties template)
      Copy/clone constructor.
      Parameters:
      template - template schema attribute to copy.

  • Method Details

    • getElementPosition

      public int getElementPosition()
      Return the position of this schema attribute in its parent schema.
      Returns:
      int position in schema - 0 means first

    • setElementPosition

      public void setElementPosition(int elementPosition)
      Set up the position of this schema attribute in its parent schema.
      Parameters:
      elementPosition - int position in schema - 0 means first

    • getMinCardinality

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

    • setMinCardinality

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

    • getMaxCardinality

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

    • setMaxCardinality

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

    • getAllowsDuplicateValues

      public boolean getAllowsDuplicateValues()
      Return whether the same value can be used by more than one instance of this attribute.
      Returns:
      boolean flag

    • setAllowsDuplicateValues

      public void setAllowsDuplicateValues(boolean allowsDuplicateValues)
      Set up whether the same value can be used by more than one instance of this attribute.
      Parameters:
      allowsDuplicateValues - boolean flag

    • getOrderedValues

      public boolean getOrderedValues()
      Return whether the attribute instances are arranged in an order.
      Returns:
      boolean flag

    • setOrderedValues

      public void setOrderedValues(boolean orderedValues)
      Set up whether the attribute instances are arranged in an order.
      Parameters:
      orderedValues - boolean flag

    • getSortOrder

      public DataItemSortOrder getSortOrder()
      Return the order that the attribute instances are arranged in - if any.
      Returns:
      DataItemSortOrder enum

    • setSortOrder

      public void setSortOrder(DataItemSortOrder sortOrder)
      Set up the order that the attribute instances are arranged in - if any.
      Parameters:
      sortOrder - DataItemSortOrder enum

    • 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

    • 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

    • getDefaultValueOverride

      public String getDefaultValueOverride()
      Return any default value for this attribute that would override the default defined in the schema element for this attribute's type (note only used is type is primitive).
      Returns:
      String default value override

    • setDefaultValueOverride

      public void setDefaultValueOverride(String defaultValueOverride)
      Set up any default value for this attribute that would override the default defined in the schema element for this attribute's type (note only used is type is primitive).
      Parameters:
      defaultValueOverride - String default value override

    • getNativeJavaClass

      public String getNativeJavaClass()
      Return the name of the Java class to use to represent this type.
      Returns:
      fully qualified Java class name

    • setNativeJavaClass

      public void setNativeJavaClass(String nativeJavaClass)
      Set up the name of the Java class to use to represent this type.
      Parameters:
      nativeJavaClass - fully qualified Java class name

    • getAliases

      public List<String> getAliases()
      Return a list of alternative names for the attribute.
      Returns:
      list of names

    • setAliases

      public void setAliases(List<String> aliases)
      Set up a list of alternative names for the attribute.
      Parameters:
      aliases - list of names

    • getDataType

      public String getDataType()
      Return the data type for this element. Null means unknown data type.
      Returns:
      string data type name

    • setDataType

      public void setDataType(String dataType)
      Set up the data type for this element. Null means unknown data type.
      Parameters:
      dataType - data type name

    • getDefaultValue

      public String getDefaultValue()
      Return the default value for the element. 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 element. Null means no default value set up.
      Parameters:
      defaultValue - String containing default value

    • getFixedValue

      public String getFixedValue()
      Return a fixed literal value - an alternative to default value.
      Returns:
      string value

    • setFixedValue

      public void setFixedValue(String fixedValue)
      If the column contains a fixed literal value, set this value here - an alternative to default value.
      Parameters:
      fixedValue - string

    • getExternalTypeGUID

      public String getExternalTypeGUID()
      Return the unique identifier of this column's type.
      Returns:
      unique identifier (guid) of the external schema type

    • setExternalTypeGUID

      public void setExternalTypeGUID(String externalTypeGUID)
      If the type of this column is represented by an external (standard type) put its value here. No need to set dataType, FixedType or defaultType
      Parameters:
      externalTypeGUID - unique identifier (guid) of the external schema type

    • getValidValuesSetGUID

      public String getValidValuesSetGUID()
      Return the set of valid values for this column.
      Returns:
      unique identifier (guid) of the valid values set

    • setValidValuesSetGUID

      public void setValidValuesSetGUID(String validValuesSetGUID)
      If the type is controlled by a fixed set of values, set up the unique identifier of the valid values set that lists the valid values.
      Parameters:
      validValuesSetGUID - unique identifier (guid) of the valid values set

    • getSchemaType

      public SchemaTypeProperties getSchemaType()
      Description fo the schema Type.
      Returns:
      schema type properties

    • setSchemaType

      public void setSchemaType(SchemaTypeProperties schemaType)
      Set up the description of the schemaType.
      Parameters:
      schemaType - schema type

    • toString

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

    • hashCode

      public int hashCode()
      Return a number that represents the contents of this object.
      Overrides:
      hashCode in class SchemaElementProperties
      Returns:
      int