org.jpox.metadata
Class MapMetaData

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

public class MapMetaData
extends ContainerMetaData

Representation of the Meta-Data for a Map.

MetaData Element

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

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

Field Summary
protected  java.lang.Boolean dependentKey
          The dependent-key attribute indicates that the collection's key contains references that are to be deleted if the referring instance is deleted.
protected  java.lang.Boolean dependentValue
          The dependent-value attribute indicates that the collection's value contains references that are to be deleted if the referring instance is deleted.
protected  java.lang.Boolean embeddedKey
          embedded-key tag value.
protected  java.lang.Boolean embeddedValue
          embedded-value tag value.
protected  AbstractClassMetaData keyClassMetaData
          Key-type ClassMetaData.
protected  java.lang.String keyType
          key-type tag value.
protected  java.lang.Boolean serializedKey
          serialized-key tag value.
protected  java.lang.Boolean serializedValue
          serialized-value tag value.
protected  AbstractClassMetaData valueClassMetaData
          Value-type ClassMetaData.
protected  java.lang.String valueType
          value-type 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
MapMetaData(AbstractPropertyMetaData parent, MapMetaData mapmd)
          Constructor to create a copy of the passed metadata using the passed parent.
MapMetaData(AbstractPropertyMetaData parent, java.lang.String keyType, java.lang.String embeddedKey, java.lang.String dependentKey, java.lang.String serializedKey, java.lang.String valueType, java.lang.String embeddedValue, java.lang.String dependentValue, java.lang.String serializedValue)
          Constructor.
 
Method Summary
 AbstractClassMetaData getKeyClassMetaData()
          Accessor for the Key ClassMetaData
 java.lang.String getKeyType()
          Accessor for the key-type tag value.
 AbstractClassMetaData getValueClassMetaData()
          Accessor for the Value ClassMetaData
 java.lang.String getValueType()
          Accessor for the value-type tag value.
 boolean isDependentKey()
          Accessor for the dependent-key attribute indicates that the map's key contains references that are to be deleted if the referring instance is deleted.
 boolean isDependentValue()
          Accessor for the dependent-value attribute indicates that the map's value contains references that are to be deleted if the referring instance is deleted.
 boolean isEmbeddedKey()
          Accessor for the embedded-key tag value.
 boolean isEmbeddedValue()
          Accessor for the embedded-value tag value.
 boolean isSerializedKey()
          Accessor for the serialized-key tag value.
 boolean isSerializedValue()
          Accessor for the serialized-value 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

embeddedKey

protected java.lang.Boolean embeddedKey
embedded-key tag value.


embeddedValue

protected java.lang.Boolean embeddedValue
embedded-value tag value.


serializedKey

protected java.lang.Boolean serializedKey
serialized-key tag value.


serializedValue

protected java.lang.Boolean serializedValue
serialized-value tag value.


keyType

protected java.lang.String keyType
key-type tag value.


valueType

protected java.lang.String valueType
value-type tag value.


keyClassMetaData

protected AbstractClassMetaData keyClassMetaData
Key-type ClassMetaData.


valueClassMetaData

protected AbstractClassMetaData valueClassMetaData
Value-type ClassMetaData.


dependentValue

protected java.lang.Boolean dependentValue
The dependent-value attribute indicates that the collection's value contains references that are to be deleted if the referring instance is deleted.


dependentKey

protected java.lang.Boolean dependentKey
The dependent-key attribute indicates that the collection's key contains references that are to be deleted if the referring instance is deleted.

Constructor Detail

MapMetaData

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

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

MapMetaData

public MapMetaData(AbstractPropertyMetaData parent,
                   java.lang.String keyType,
                   java.lang.String embeddedKey,
                   java.lang.String dependentKey,
                   java.lang.String serializedKey,
                   java.lang.String valueType,
                   java.lang.String embeddedValue,
                   java.lang.String dependentValue,
                   java.lang.String serializedValue)
Constructor.

Parameters:
parent - parent Field
keyType - key-type tag value
embeddedKey - embedded-key tag value
dependentKey - dependent-key tag value
serializedKey - serialized-key tag value
valueType - value-type tag value
embeddedValue - embedded-value tag value
dependentValue - dependent-value tag value
serializedValue - serialized-value tag 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 loading any key/value types

getKeyType

public java.lang.String getKeyType()
Accessor for the key-type tag value. May be comma-separated if several key types are possible.

Returns:
key-type tag value

getKeyClassMetaData

public AbstractClassMetaData getKeyClassMetaData()
Accessor for the Key ClassMetaData

Returns:
key ClassMetaData

getValueType

public java.lang.String getValueType()
Accessor for the value-type tag value. May be comma-separated if several value types are possible.

Returns:
value-type tag value

getValueClassMetaData

public AbstractClassMetaData getValueClassMetaData()
Accessor for the Value ClassMetaData

Returns:
value ClassMetaData

isEmbeddedKey

public boolean isEmbeddedKey()
Accessor for the embedded-key tag value.

Returns:
embedded-key tag value

isEmbeddedValue

public boolean isEmbeddedValue()
Accessor for the embedded-value tag value.

Returns:
embedded-value tag value

isSerializedKey

public boolean isSerializedKey()
Accessor for the serialized-key tag value.

Returns:
serialized-key tag value

isSerializedValue

public boolean isSerializedValue()
Accessor for the serialized-value tag value.

Returns:
serialized-value tag value

isDependentKey

public boolean isDependentKey()
Accessor for the dependent-key attribute indicates that the map's key contains references that are to be deleted if the referring instance is deleted.

Returns:
dependent-key tag value

isDependentValue

public boolean isDependentValue()
Accessor for the dependent-value attribute indicates that the map's value contains references that are to be deleted if the referring instance is deleted.

Returns:
dependent-value 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.