Package org.datanucleus.store.rdbms.key
Class PrimaryKey
- java.lang.Object
-
- org.datanucleus.store.rdbms.key.ColumnOrderedKey
-
- org.datanucleus.store.rdbms.key.CandidateKey
-
- org.datanucleus.store.rdbms.key.PrimaryKey
-
public class PrimaryKey extends CandidateKey
Representation of the primary key of a table.
-
-
Field Summary
Fields Modifier and Type Field Description protected List<Column>
columns
Columns that the key relates to.protected String
name
Name of the key.protected Table
table
Table that the key applies to.-
Fields inherited from class org.datanucleus.store.rdbms.key.ColumnOrderedKey
columnOrdering, extensions
-
-
Constructor Summary
Constructors Constructor Description PrimaryKey(Table table)
Creates a primary key.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
assertSameDatastoreObject(Column col)
Utility to assert if the column is for a different table.boolean
equals(Object obj)
Equality operator.String
getColumnList()
Accessor for the column liststatic String
getColumnList(List<Column> cols)
Method to return the list of columns which the key applies to.List<Column>
getColumns()
Accessor for the columns that the key relates to.String
getName()
Accessor for the key name.Table
getTable()
Accessor for the tableint
hashCode()
Hashcode operator.protected static void
setMinSize(List list, int size)
void
setName(String name)
Mutator for the key name.int
size()
Accessor for the size.String
toString()
Stringifier method.-
Methods inherited from class org.datanucleus.store.rdbms.key.ColumnOrderedKey
addColumn, getColumnList, getValueForExtension, setColumn, setColumnOrdering
-
-
-
-
Constructor Detail
-
PrimaryKey
public PrimaryKey(Table table)
Creates a primary key. A default name of the primary key is created by the constructor. This name can be overwritten.- Parameters:
table
- Table that this is the PK for
-
-
Method Detail
-
size
public int size()
Accessor for the size.- Returns:
- The size.
-
equals
public boolean equals(Object obj)
Equality operator.- Overrides:
equals
in classCandidateKey
- Parameters:
obj
- Object to compare against- Returns:
- Whether they are equal.
-
hashCode
public int hashCode()
Hashcode operator.- Overrides:
hashCode
in classCandidateKey
- Returns:
- The hashcode
-
toString
public String toString()
Stringifier method. Generates a form of the PK ready to be used in a DDL statement. e.gPRIMARY KEY (col1,col2)
- Overrides:
toString
in classCandidateKey
- Returns:
- The string form of this object. Ready to be used in a DDL statement.
-
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
-
assertSameDatastoreObject
protected void assertSameDatastoreObject(Column col)
Utility to assert if the column is for a different table.- Parameters:
col
- The column to compare with
-
setMinSize
protected static void setMinSize(List list, int size)
-
-