Package org.odpi.openmetadata.frameworks.opensurvey

Record Class DatabaseElementAnnotation

java.lang.Object
java.lang.Record
org.odpi.openmetadata.frameworks.opensurvey.DatabaseElementAnnotation
Record Components:
annotationProperties - properties of the annotation
databaseName - name of the database
schemaName - name of the schema, or null for a database annotation
tableName - name of the table or view, or null for a database or schema annotation
columnName - name of the column, or null unless this is a column annotation
public record DatabaseElementAnnotation(AnnotationProperties annotationProperties, String databaseName, String schemaName, String tableName, String columnName) extends Record
An annotation produced by a database survey, together with the names of the database resource that it describes. The names are those used by the database itself. A database annotation has only the database name set; a schema annotation adds the schema name; a table annotation adds the table name; and a column annotation adds the column name. SurveyDatabaseElementResolver uses the names to find the catalogued element that the annotation is linked to.

  • Constructor Details

    • DatabaseElementAnnotation

      public DatabaseElementAnnotation(AnnotationProperties annotationProperties, String databaseName, String schemaName, String tableName, String columnName)
      Creates an instance of a DatabaseElementAnnotation record class.
      Parameters:
      annotationProperties - the value for the annotationProperties record component
      databaseName - the value for the databaseName record component
      schemaName - the value for the schemaName record component
      tableName - the value for the tableName record component
      columnName - the value for the columnName 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • annotationProperties

      public AnnotationProperties annotationProperties()
      Returns the value of the annotationProperties record component.
      Returns:
      the value of the annotationProperties record component

    • databaseName

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

    • schemaName

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

    • tableName

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

    • columnName

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