org.jpox.metadata
Class OrderMetaData

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

All Implemented Interfaces:

java.io.Serializable, ColumnMetaDataContainer

public class OrderMetaData
extends ExtendableMetaData
implements ColumnMetaDataContainer

Representation of Order MetaData - the ordering of the elements of a List.

MetaData Element

The MetaData element represented here is as follows

 <!ELEMENT order (extension*, column*, index?, extension*)>
 <!ATTLIST order column CDATA #IMPLIED>
 <!ATTLIST order indexed (true|false|unique) #IMPLIED>
 <!ATTLIST order mapped-by CDATA #IMPLIED>
 

Version:

$Revision: 1.7 $

See Also:

Serialized Form

Field Summary

protected ColumnMetaData[]	columnMetaData Contains the metadata for column
protected IndexedValue	indexed The indexing value
protected IndexMetaData	indexMetaData IndexMetaData.
protected java.lang.String	mappedBy Name of the field in the element that is the ordering field.

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

OrderMetaData(MetaData parent, OrderMetaData omd)
Constructor to create a copy of the passed metadata using the provided parent.

OrderMetaData(java.lang.String column, java.lang.String indexed, java.lang.String mappedBy)
Constructor.

Method Summary

void	addColumn(ColumnMetaData colmd) Add a new ColumnMetaData element
java.lang.String	getColumn() Accessor for the column name
ColumnMetaData[]	getColumnMetaData() Accessor for the Column MetaData for the columns
IndexMetaData	getIndexMetaData() Accessor for indexMetaData
java.lang.String	getMappedBy() Accessor for the field in the element that provides the ordering.
void	initialise() Method to initialise the object, creating internal convenience arrays.
void	setIndexMetaData(IndexMetaData indexMetaData) Mutator for the index MetaData
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 This can be used as part of a facility to output a MetaData file.

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

indexMetaData

protected IndexMetaData indexMetaData

IndexMetaData.

indexed

protected IndexedValue indexed

The indexing value

mappedBy

protected final java.lang.String mappedBy

Name of the field in the element that is the ordering field.

columnMetaData

protected ColumnMetaData[] columnMetaData

Contains the metadata for column

Constructor Detail

OrderMetaData

public OrderMetaData(MetaData parent,
                     OrderMetaData omd)

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

Parameters:

parent - The parent

omd - The metadata to copy

OrderMetaData

public OrderMetaData(java.lang.String column,
                     java.lang.String indexed,
                     java.lang.String mappedBy)

Constructor.

Parameters:

column - Name of column

indexed - The indexed value

mappedBy - The field in the element that provides the ordering

Method Detail

initialise

public void initialise()

Method to initialise the object, creating internal convenience arrays. Initialises all sub-objects.

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 Column MetaData

setIndexMetaData

public final void setIndexMetaData(IndexMetaData indexMetaData)

Mutator for the index MetaData

Parameters:

indexMetaData - The indexMetaData to set.

getMappedBy

public java.lang.String getMappedBy()

Accessor for the field in the element that provides the ordering.

Returns:

Field in the value that provides the ordering.

getColumnMetaData

public final ColumnMetaData[] getColumnMetaData()

Accessor for the Column MetaData for the columns

Specified by:

getColumnMetaData in interface ColumnMetaDataContainer

Returns:

Returns the columnMetaData.

getColumn

public final java.lang.String getColumn()

Accessor for the column name

Returns:

Returns the column.

getIndexMetaData

public final IndexMetaData getIndexMetaData()

Accessor for indexMetaData

Returns:

Returns the indexMetaData.

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 This can be used as part of a facility to output a MetaData file.

Overrides:

toString in class ExtendableMetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.