org.jpox.metadata
Class CollectionMetaData

java.lang.Object
  extended byorg.jpox.metadata.MetaData
      extended byorg.jpox.metadata.ExtendableMetaData
          extended byorg.jpox.metadata.ContainerMetaData
              extended byorg.jpox.metadata.CollectionMetaData
All Implemented Interfaces:
java.io.Serializable

public class CollectionMetaData
extends ContainerMetaData

Representation of the MetaData of a collection.

MetaData Element

Represents the following MetaData Element
 <!ELEMENT collection (extension)*>
 <!ATTLIST collection element-type CDATA #IMPLIED>
 <!ATTLIST collection embedded-element (true|false) #IMPLIED>
 <!ATTLIST collection dependent-element (true|false) #IMPLIED>
 <!ATTLIST collection serialized-element (true|false) #IMPLIED>
 

Since:
1.1
Version:
$Revision: 1.25 $
See Also:
Serialized Form

Field Summary
protected  java.lang.Boolean dependentElement
          dependent-element tag value.
protected  AbstractClassMetaData elementClassMetaData
          Element-type ClassMetaData
protected  java.lang.String elementType
          Element-type tag value.
protected  java.lang.Boolean embeddedElement
          Embedded-element tag value.
protected  java.lang.Boolean serializedElement
          Serialized-element 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
CollectionMetaData(AbstractPropertyMetaData parent, CollectionMetaData colmd)
          Constructor to create a copy of the passed metadata using the passed parent.
CollectionMetaData(AbstractPropertyMetaData parent, java.lang.String elementType, java.lang.String embeddedElement, java.lang.String dependentElement, java.lang.String serializedElement)
          Constructor.
 
Method Summary
 AbstractClassMetaData getElementClassMetaData()
          Accessor for the Element ClassMetaData
 java.lang.String getElementType()
          Accessor for the element-type tag value.
 boolean isDependentElement()
          Accessor for The dependent-element attribute indicates that the collection's element contains a reference that is to be deleted if the referring instance is deleted.
 boolean isEmbeddedElement()
          Accessor for the embedded-element tag value
 boolean isSerializedElement()
          Accessor for the serialized-element tag value
 void populate(ClassLoaderResolver clr)
          Method to populate any defaults, and check the validity of the MetaData.
 java.lang.String toString()
          Returns 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.
 
Methods inherited from class org.jpox.metadata.ContainerMetaData
getAbstractPropertyMetaData, getFieldName, getMetaDataManager
 
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, initialise, 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

elementType

protected java.lang.String elementType
Element-type tag value. Default is Object (JDO2 Spec [18.13.1]).


elementClassMetaData

protected AbstractClassMetaData elementClassMetaData
Element-type ClassMetaData


embeddedElement

protected java.lang.Boolean embeddedElement
Embedded-element tag value.


serializedElement

protected java.lang.Boolean serializedElement
Serialized-element tag value.


dependentElement

protected java.lang.Boolean dependentElement
dependent-element tag value. The dependent-element attribute indicates that the collection's element contains a reference that is to be deleted if the referring instance is deleted.

Constructor Detail

CollectionMetaData

public CollectionMetaData(AbstractPropertyMetaData parent,
                          CollectionMetaData colmd)
Constructor to create a copy of the passed metadata using the passed parent.

Parameters:
parent - The parent
colmd - The metadata to copy

CollectionMetaData

public CollectionMetaData(AbstractPropertyMetaData parent,
                          java.lang.String elementType,
                          java.lang.String embeddedElement,
                          java.lang.String dependentElement,
                          java.lang.String serializedElement)
Constructor.

Parameters:
parent - The parent Field element
elementType - The type of element
embeddedElement - Whether elements are embedded
dependentElement - attribute dependent-element value
serializedElement - attribute serialized-element value
Method Detail

populate

public void populate(ClassLoaderResolver clr)
Method to populate any defaults, and check the validity of the MetaData.

Parameters:
clr - ClassLoaderResolver to use for any loading operations

getElementType

public java.lang.String getElementType()
Accessor for the element-type tag value. This can contain comma-separated values.

Returns:
element-type tag value

getElementClassMetaData

public AbstractClassMetaData getElementClassMetaData()
Accessor for the Element ClassMetaData

Returns:
element ClassMetaData

isEmbeddedElement

public boolean isEmbeddedElement()
Accessor for the embedded-element tag value

Returns:
embedded-element tag value

isDependentElement

public boolean isDependentElement()
Accessor for The dependent-element attribute indicates that the collection's element contains a reference that is to be deleted if the referring instance is deleted.

Returns:
dependent-element tag value

isSerializedElement

public boolean isSerializedElement()
Accessor for the serialized-element tag value

Returns:
serialized-element tag value

toString

public java.lang.String toString()
Returns 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.

Overrides:
toString in class ExtendableMetaData
Parameters:
prefix - prefix string
indent - indent string
Returns:
a string representation of the object.


Copyright © -2007 . All Rights Reserved.