org.datanucleus.metadata

Class KeyMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.AbstractElementMetaData

org.datanucleus.metadata.KeyMetaData

All Implemented Interfaces:

Serializable, ColumnMetaDataContainer

public class KeyMetaData
extends AbstractElementMetaData

This element specifies the mapping for the key component of maps. The serialised attribute specifies that the key values are to be serialised into the named column.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.datanucleus.metadata.AbstractElementMetaData

columnMetaData, columnName, columns, embeddedMetaData, foreignKeyMetaData, indexed, indexMetaData, mappedBy, unique, uniqueMetaData

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

Constructors

Constructor and Description
KeyMetaData() Default constructor.
KeyMetaData(KeyMetaData kmd) Constructor to create a copy of the passed metadata using the provided parent.

Method Summary

Methods

Modifier and Type	Method and Description
void	populate(ClassLoaderResolver clr, ClassLoader primary, MetaDataManager mmgr) Populate the MetaData.
String	toString(String prefix, String indent) Returns a string representation of the object using a prefix This can be used as part of a facility to output a MetaData file.

Methods inherited from class org.datanucleus.metadata.AbstractElementMetaData

addColumn, getColumnMetaData, getColumnName, getDeleteAction, getEmbeddedMetaData, getForeignKeyMetaData, getIndexed, getIndexMetaData, getMappedBy, getUniqueMetaData, getUpdateAction, initialise, isUnique, newColumnMetaData, newEmbeddedMetaData, newForeignKeyMetaData, newIndexMetaData, newUniqueMetaData, setColumnName, setDeleteAction, setDeleteAction, setEmbeddedMetaData, setForeignKeyMetaData, setIndexed, setIndexMetaData, setMappedBy, setUnique, setUnique, setUniqueMetaData, setUpdateAction, setUpdateAction

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

Constructor Detail

KeyMetaData

public KeyMetaData(KeyMetaData kmd)

Constructor to create a copy of the passed metadata using the provided parent.

Parameters:

kmd - The metadata to copy

KeyMetaData

public KeyMetaData()

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

Method Detail

populate

public void populate(ClassLoaderResolver clr,
            ClassLoader primary,
            MetaDataManager mmgr)

Populate the MetaData.

Overrides:

populate in class AbstractElementMetaData

Parameters:

clr - Class loader to use

primary - the primary ClassLoader to use (or null)

mmgr - MetaData manager

toString

public String toString(String prefix,
              String indent)

Returns a string representation of the object using a prefix This can be used as part of a facility to output a MetaData file.

Overrides:

toString in class MetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.