Class CandidateKey

java.lang.Object

org.datanucleus.store.rdbms.key.Key

org.datanucleus.store.rdbms.key.ColumnOrderedKey

org.datanucleus.store.rdbms.key.CandidateKey

public class CandidateKey
extends ColumnOrderedKey

Representation of a Candidate key. This represents a UNIQUE candidate key on a column or columns.

Field Summary

Fields inherited from class ColumnOrderedKey

columnOrdering, extensions

Fields inherited from class Key

columns, name, table

Constructor Summary

Constructors

Constructor	Description
CandidateKey(Table table, Map<String,String> extensions)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Equality operator.
int	hashCode()	Hashcode operator.
String	toString()	Stringify method.

Methods inherited from class ColumnOrderedKey

addColumn, getColumnList, getValueForExtension, setColumn, setColumnOrdering

Methods inherited from class Key

assertSameDatastoreObject, getColumnList, getColumnList, getColumns, getName, getNumberOfColumns, getTable, setListMinimumSize, setName

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CandidateKey

public CandidateKey(Table table,
 Map<String,String> extensions)

Constructor.

Parameters:

table - Table to apply this key to

extensions - Any extensions for this unique constraint

Method Details

equals

public boolean equals(Object obj)

Description copied from class: Key

Equality operator.

Overrides:

equals in class Key

Parameters:

obj - Object to compare against

Returns:

Whether they are equal.

hashCode

public int hashCode()

Description copied from class: Key

Hashcode operator.

Overrides:

hashCode in class Key

Returns:

The hashcode

toString

public String toString()

Stringify method. Returns

UNIQUE (col1, ...)

.

Overrides:

toString in class Object

Returns:

String version of this object.