org.jpox.metadata
Class IdentityMetaData

java.lang.Object
  org.jpox.metadata.MetaData
      org.jpox.metadata.ExtendableMetaData
          org.jpox.metadata.IdentityMetaData

All Implemented Interfaces:

java.io.Serializable, ColumnMetaDataContainer

public class IdentityMetaData
extends ExtendableMetaData
implements ColumnMetaDataContainer

Representation of the Meta-Data for an identity of a class.
The datastore-identity element declares the strategy for implementing datastore identity for the class, including the mapping of the identity columns of the relational table.
<!ELEMENT datastore-identity ((extension)*, (column)*, (extension)*)?>
<!ATTLIST datastore-identity column CDATA #IMPLIED>
<!ATTLIST datastore-identity strategy CDATA #IMPLIED>
<!ATTLIST datastore-identity sequence CDATA #IMPLIED>

Since:

1.1

Version:

$Revision: 1.10 $

See Also:

Serialized Form

Field Summary

protected java.lang.String	column column name value.
protected ColumnMetaData[]	columnMetaData Contains the metadata for column
protected java.lang.String	sequence sequence tag value.
protected IdentityStrategy	strategy strategy tag value.

Fields inherited from class org.jpox.metadata.ExtendableMetaData

extensions, JPOX_VENDOR_NAME

Fields inherited from class org.jpox.metadata.MetaData

LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent

Constructor Summary

IdentityMetaData(AbstractClassMetaData parent, java.lang.String column, java.lang.String strategy, java.lang.String sequence)
Constructor

Method Summary

void	addColumn(ColumnMetaData colmd) Add a new ColumnMetaData element
java.lang.String	getColumn() Accessor for the column
ColumnMetaData[]	getColumnMetaData() Accessor for columnMetaData
java.lang.String	getSequence() Accessor for the sequence name
IdentityStrategy	getStrategyValue() Accessor for the strategy tag value
void	initialise() Method to initialise all internal convenience arrays needed.
java.lang.String	toString() Accessor for a string representation of the object.
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.jpox.metadata.ExtendableMetaData

addExtension, addExtension, getExtension, getExtensions, getNoOfExtensions, getValueForExtension, getValuesForExtension, getValuesForExtensionStartingWith, hasExtension, removeExtension

Methods inherited from class org.jpox.metadata.MetaData

getParent, isCreated, isInitialised, isPopulated, isUsed, populate, setInitialised, setPopulated, setUsed

Methods inherited from class java.lang.Object

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

Field Detail

column

protected java.lang.String column

column name value.

strategy

protected IdentityStrategy strategy

strategy tag value.

sequence

protected java.lang.String sequence

sequence tag value.

columnMetaData

protected ColumnMetaData[] columnMetaData

Contains the metadata for column

Constructor Detail

IdentityMetaData

public IdentityMetaData(AbstractClassMetaData parent,
                        java.lang.String column,
                        java.lang.String strategy,
                        java.lang.String sequence)

Constructor

Parameters:

parent - parent AbstractClassMetaData instance

column - column

strategy - strategy

sequence - sequence name

Method Detail

initialise

public void initialise()

Method to initialise all internal convenience arrays needed.

Overrides:

initialise in class MetaData

addColumn

public void addColumn(ColumnMetaData colmd)

Add a new ColumnMetaData element

Specified by:

addColumn in interface ColumnMetaDataContainer

Parameters:

colmd - The ColumnMetaData to add

getColumnMetaData

public final ColumnMetaData[] getColumnMetaData()

Accessor for columnMetaData

Specified by:

getColumnMetaData in interface ColumnMetaDataContainer

Returns:

Returns the columnMetaData.

getColumn

public java.lang.String getColumn()

Accessor for the column

Returns:

column

getStrategyValue

public IdentityStrategy getStrategyValue()

Accessor for the strategy tag value

Returns:

strategy tag value

getSequence

public java.lang.String getSequence()

Accessor for the sequence name

Returns:

sequence name

toString

public java.lang.String toString()

Accessor for a string representation of the object.

Overrides:

toString in class ExtendableMetaData

Returns:

a string representation of the object.

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 ExtendableMetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.