org.datanucleus.metadata
Class PrimaryKeyMetaData

java.lang.Object
  org.datanucleus.metadata.MetaData
      org.datanucleus.metadata.PrimaryKeyMetaData

All Implemented Interfaces:

java.io.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

protected ColumnMetaData[]	columnMetaData MetaData for columns to be used in PK.
protected java.lang.String	columnName Column name of PK.
protected java.util.List	columns the columns elements to be included in the index.
protected java.lang.String	name PK constraint name.

Fields inherited from class org.datanucleus.metadata.MetaData

extensions, LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME, VENDOR_NAME_OLD

Constructor Summary

PrimaryKeyMetaData()
Default constructor.

Method Summary

void	addColumn(ColumnMetaData colmd) Add a new ColumnMetaData element
ColumnMetaData[]	getColumnMetaData() Accessor for columnMetaData
java.lang.String	getColumnName()
java.lang.String	getName()
void	initialise(ClassLoaderResolver clr, MetaDataManager mmgr) Initialisation method.
ColumnMetaData	newColumnMetadata() Method to create a new column, add it, and return it.
PrimaryKeyMetaData	setColumnName(java.lang.String name)
PrimaryKeyMetaData	setName(java.lang.String name)
java.lang.String	toString(java.lang.String prefix, java.lang.String indent) Returns a string representation of the object using a prefix

Methods inherited from class org.datanucleus.metadata.MetaData

addExtension, addExtension, assertIfInitialised, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

PK constraint name.

columnName

protected java.lang.String columnName

Column name of PK.

columnMetaData

protected ColumnMetaData[] columnMetaData

MetaData for columns to be used in PK.

columns

protected java.util.List columns

the columns elements to be included in the index. Suitable to be empty when this metadata is contained within a field, element, key, value, or join elements

Constructor Detail

PrimaryKeyMetaData

public PrimaryKeyMetaData()

Default constructor. Set the fields using setters, before populate().

Method Detail

initialise

public void initialise(ClassLoaderResolver clr,
                       MetaDataManager mmgr)

Initialisation method. This should be called AFTER using the populate method if you are going to use populate. It creates the internal convenience arrays etc needed for normal operation.

Overrides:

initialise in class MetaData

getName

public java.lang.String getName()

setName

public PrimaryKeyMetaData setName(java.lang.String name)

setColumnName

public PrimaryKeyMetaData setColumnName(java.lang.String name)

getColumnName

public java.lang.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.

toString

public java.lang.String toString(java.lang.String prefix,
                                 java.lang.String indent)

Returns a string representation of the object using a prefix

Overrides:

toString in class MetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.