org.jpox.metadata
Class ArrayMetaData

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

public class ArrayMetaData
extends ContainerMetaData

Representation of the Meta-Data for an Array.

Represents the following MetaData Element

 <!ELEMENT array (extension)*>
 <!ATTLIST array element-type CDATA #IMPLIED>
 <!ATTLIST array embedded-element (true|false) #IMPLIED>
 <!ATTLIST array serialized-element (true|false) #IMPLIED>
 <!ATTLIST array dependent-element (true|false) #IMPLIED>
 

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

Field Summary
protected  java.lang.Boolean dependentElement
          Whether the array elements are to be treated as dependent when removing from the array.
protected  AbstractClassMetaData elementClassMetaData
          Element-type ClassMetaData
protected  java.lang.String elementType
          Implementation type(s) of elements that can be stored (when it is of a reference type).
protected  java.lang.Boolean embeddedElement
          Whether the array elements are embedded.
protected  java.lang.Boolean serializedElement
          Whether the array elements are serialized.
 
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
ArrayMetaData(AbstractPropertyMetaData parent, ArrayMetaData arrmd)
          Constructor to create a copy of the passed metadata using the passed parent.
ArrayMetaData(AbstractPropertyMetaData parent, java.lang.String elementType, java.lang.String embeddedElement, java.lang.String serializedElement, java.lang.String dependentElement)
          Constructor.
 
Method Summary
 AbstractClassMetaData getElementClassMetaData()
          Accessor for the Element ClassMetaData
 java.lang.String getElementType()
          Accessor for the element implementation types (when element is a reference type).
 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 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
Implementation type(s) of elements that can be stored (when it is of a reference type).


elementClassMetaData

protected AbstractClassMetaData elementClassMetaData
Element-type ClassMetaData


embeddedElement

protected java.lang.Boolean embeddedElement
Whether the array elements are embedded.


serializedElement

protected java.lang.Boolean serializedElement
Whether the array elements are serialized.


dependentElement

protected java.lang.Boolean dependentElement
Whether the array elements are to be treated as dependent when removing from the array.

Constructor Detail

ArrayMetaData

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

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

ArrayMetaData

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

Parameters:
parent - The parent Field
elementType - Implementation type(s) of element possible (when it is a reference type).
embeddedElement - Whether the element is embedded into the join table
serializedElement - Whether the element is serialised into the join table
dependentElement - Whether the element is dependent for deletion purposes
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 in loading any classes

getElementType

public java.lang.String getElementType()
Accessor for the element implementation types (when element is a reference type). The return can contain comma-separated values.

Returns:
element implementation types

getElementClassMetaData

public AbstractClassMetaData getElementClassMetaData()
Accessor for the Element ClassMetaData

Returns:
element ClassMetaData

isEmbeddedElement

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

Returns:
embedded-element value

isSerializedElement

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

Returns:
serialized-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

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 - The prefix string
indent - The indent string
Returns:
a string representation of the object.


Copyright © -2007 . All Rights Reserved.