Class PrimaryKeyMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.PrimaryKeyMetaData

All Implemented Interfaces:

Serializable, ColumnMetaDataContainer

public class PrimaryKeyMetaData
extends MetaData
implements ColumnMetaDataContainer

Representation of a primary key constraint. Can also be used for specifying surrogate keys, but we doesn't support this.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	columnName	Column name of PK.
protected List<ColumnMetaData>	columns
protected String	name	PK constraint name.
private static final long	serialVersionUID

Fields inherited from class MetaData

EXTENSION_CLASS_CREATETIMESTAMP, EXTENSION_CLASS_CREATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_CREATEUSER, EXTENSION_CLASS_CREATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_CREATEUSER_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_MULTITENANT, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_SOFTDELETE, EXTENSION_CLASS_SOFTDELETE_COLUMN_NAME, EXTENSION_CLASS_UPDATETIMESTAMP, EXTENSION_CLASS_UPDATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_UPDATEUSER, EXTENSION_CLASS_UPDATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_UPDATEUSER_COLUMN_NAME, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_CLASS_VIEW_DEFINITION, EXTENSION_CLASS_VIEW_IMPORTS, EXTENSION_INDEX_COLUMN_ORDERING, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_ATTACH, EXTENSION_MEMBER_CASCADE_DETACH, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_CREATE_TIMESTAMP, EXTENSION_MEMBER_CREATE_USER, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_KEY_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_RELATION_DISCRIM_COLUMN, EXTENSION_MEMBER_RELATION_DISCRIM_PK, EXTENSION_MEMBER_RELATION_DISCRIM_VALUE, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATE_TIMESTAMP, EXTENSION_MEMBER_UPDATE_USER, EXTENSION_MEMBER_UPDATEABLE, EXTENSION_MEMBER_VALUE_IMPLEMENTATION_CLASSES, EXTENSION_VERSION_NUMBER_INITIAL_VALUE, extensions, metaDataState, parent, VENDOR_NAME

Constructor Summary

Constructors

Constructor	Description
PrimaryKeyMetaData()

Method Summary

Modifier and Type	Method	Description
void	addColumn(ColumnMetaData colmd)	Add a new ColumnMetaData element
final ColumnMetaData[]	getColumnMetaData()	Accessor for columnMetaData
String	getColumnName()
String	getName()
ColumnMetaData	newColumnMetaData()	Method to create a new column, add it, and return it.
PrimaryKeyMetaData	setColumnName(String name)
PrimaryKeyMetaData	setName(String name)

Methods inherited from class MetaData

addExtension, addExtensions, getExtensions, getMetaDataManager, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, removeExtension, setExtensions, setInitialised, setParent, setPopulated, setUsed

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

name

protected String name

PK constraint name.

columnName

protected String columnName

Column name of PK.

columns

protected List<ColumnMetaData> columns

Constructor Details

PrimaryKeyMetaData

public PrimaryKeyMetaData()

Method Details

getName

public String getName()

setName

public PrimaryKeyMetaData setName(String name)

setColumnName

public PrimaryKeyMetaData setColumnName(String name)

getColumnName

public String getColumnName()

addColumn

public void addColumn(ColumnMetaData colmd)

Add a new ColumnMetaData element

Specified by:

addColumn in interface ColumnMetaDataContainer

Parameters:

colmd - The ColumnMetaData to add

newColumnMetaData

public ColumnMetaData newColumnMetaData()

Method to create a new column, add it, and return it.

Returns:

The column metadata

getColumnMetaData

public final ColumnMetaData[] getColumnMetaData()

Accessor for columnMetaData

Specified by:

getColumnMetaData in interface ColumnMetaDataContainer

Returns:

Returns the columnMetaData.