Package org.odpi.openmetadata.frameworks.connectors.tabulardatasets

Record Class TabularColumnDescription

java.lang.Object
java.lang.Record
org.odpi.openmetadata.frameworks.connectors.tabulardatasets.TabularColumnDescription
Record Components:
columnName - name of the column
columnDataType - type of the column
description - description of the data in the column
isNullable - is a null value allowed in this column?
isIdentifier - is this field all or part of the table's unique identifier?
public record TabularColumnDescription(String columnName, DataType columnDataType, String description, boolean isNullable, boolean isIdentifier) extends Record
Create a tabular column definition. This can be extracted from the data, or used to set up a new data set. The column name is defined in a canonical name format - space separated words where each word is capitalized/

  • Constructor Details

    • TabularColumnDescription

      public TabularColumnDescription(String columnName, DataType columnDataType, String description, boolean isNullable, boolean isIdentifier)
      Creates an instance of a TabularColumnDescription record class.
      Parameters:
      columnName - the value for the columnName record component
      columnDataType - the value for the columnDataType record component
      description - the value for the description record component
      isNullable - the value for the isNullable record component
      isIdentifier - the value for the isIdentifier record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • columnName

      public String columnName()
      Returns the value of the columnName record component.
      Returns:
      the value of the columnName record component

    • columnDataType

      public DataType columnDataType()
      Returns the value of the columnDataType record component.
      Returns:
      the value of the columnDataType record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • isNullable

      public boolean isNullable()
      Returns the value of the isNullable record component.
      Returns:
      the value of the isNullable record component

    • isIdentifier

      public boolean isIdentifier()
      Returns the value of the isIdentifier record component.
      Returns:
      the value of the isIdentifier record component