Class Key

java.lang.Object
org.datanucleus.store.rdbms.key.Key
Direct Known Subclasses:
ColumnOrderedKey, ForeignKey, PrimaryKey
abstract class Key extends Object
Abstract representation of a Key to a table.

  • Field Details

    • name

      protected String name
      Name of the key.

    • table

      protected Table table
      Table that the key applies to.

    • columns

      protected List<Column> columns
      Columns that the key relates to.

  • Constructor Details

    • Key

      protected Key(Table table)
      Constructor.
      Parameters:
      table - The table

  • Method Details

    • setName

      public void setName(String name)
      Mutator for the key name.
      Parameters:
      name - The key name

    • getName

      public String getName()
      Accessor for the key name.
      Returns:
      Key name

    • getTable

      public Table getTable()
      Accessor for the table
      Returns:
      table

    • getColumns

      public List<Column> getColumns()
      Accessor for the columns that the key relates to.
      Returns:
      the List of columns.

    • getColumnList

      public String getColumnList()
      Accessor for the column list
      Returns:
      The column list

    • getNumberOfColumns

      public int getNumberOfColumns()
      Accessor for the number of columns.
      Returns:
      The number of columns.

    • addColumn

      public void addColumn(Column col)
      Class to add a column to the key
      Parameters:
      col - The column to add

    • setColumn

      public void setColumn(int seq, Column col)
      Sets a column in a specified position seq for this index.
      Parameters:
      seq - the specified position for the col
      col - the Column

    • assertSameDatastoreObject

      protected void assertSameDatastoreObject(Column col)
      Utility to assert if the column is for a different table.
      Parameters:
      col - The column to compare with

    • hashCode

      public int hashCode()
      Hashcode operator.
      Overrides:
      hashCode in class Object
      Returns:
      The hashcode

    • equals

      public boolean equals(Object obj)
      Equality operator.
      Overrides:
      equals in class Object
      Parameters:
      obj - Object to compare against
      Returns:
      Whether they are equal.

    • setListMinimumSize

      protected static void setListMinimumSize(List<?> list, int size)

    • getColumnList

      public static String getColumnList(List<Column> cols)
      Method to return the list of columns which the key applies to.
      Parameters:
      cols - The columns.
      Returns:
      The column list.