Package org.datanucleus.metadata

Class ArrayMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.ContainerMetaData

org.datanucleus.metadata.ArrayMetaData

All Implemented Interfaces:

java.io.Serializable

public class ArrayMetaData
extends ContainerMetaData

Representation of the Meta-Data for an Array.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ContainerComponent	element	Representation of the element of the array.
protected boolean	mayContainPersistableElements	wether this array may contain persistable elements
private static long	serialVersionUID

Fields inherited from class org.datanucleus.metadata.ContainerMetaData

allowNulls

Fields inherited from class org.datanucleus.metadata.MetaData

EXTENSION_CLASS_CREATETIMESTAMP, EXTENSION_CLASS_CREATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_CREATEUSER, EXTENSION_CLASS_CREATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_CREATEUSER_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_MULTITENANT, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_SOFTDELETE, EXTENSION_CLASS_SOFTDELETE_COLUMN_NAME, EXTENSION_CLASS_UPDATETIMESTAMP, EXTENSION_CLASS_UPDATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_UPDATEUSER, EXTENSION_CLASS_UPDATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_UPDATEUSER_COLUMN_NAME, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_CLASS_VIEW_DEFINITION, EXTENSION_CLASS_VIEW_IMPORTS, EXTENSION_INDEX_COLUMN_ORDERING, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_ATTACH, EXTENSION_MEMBER_CASCADE_DETACH, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_CREATE_TIMESTAMP, EXTENSION_MEMBER_CREATE_USER, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_KEY_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_RELATION_DISCRIM_COLUMN, EXTENSION_MEMBER_RELATION_DISCRIM_PK, EXTENSION_MEMBER_RELATION_DISCRIM_VALUE, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATE_TIMESTAMP, EXTENSION_MEMBER_UPDATE_USER, EXTENSION_MEMBER_UPDATEABLE, EXTENSION_MEMBER_VALUE_IMPLEMENTATION_CLASSES, EXTENSION_VERSION_NUMBER_INITIAL_VALUE, extensions, metaDataState, parent, VENDOR_NAME

Constructor Summary

Constructors

Constructor	Description
ArrayMetaData()	Default constructor.
ArrayMetaData(ArrayMetaData arrmd)	Constructor to create a copy of the passed metadata.

Method Summary

Modifier and Type	Method	Description
boolean	elementIsPersistent()
AbstractClassMetaData	getElementClassMetaData(ClassLoaderResolver clr)	Convenience accessor for the Element ClassMetaData.
java.lang.String	getElementType()	Accessor for the element implementation types (when element is a reference type).
java.lang.String[]	getElementTypes()
(package private) void	getReferencedClassMetaData(java.util.List<AbstractClassMetaData> orderedCmds, java.util.Set<AbstractClassMetaData> referencedCmds, ClassLoaderResolver clr)	Accessor for all AbstractClassMetaData referenced by this array.
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
boolean	mayContainPersistableElements()	Returns whether this array may contain persistable elements (as indicated by the user).
void	populate(ClassLoaderResolver clr, java.lang.ClassLoader primary)	Method to populate any defaults, and check the validity of the MetaData.
ArrayMetaData	setDependentElement(boolean dependent)
ArrayMetaData	setElementType(java.lang.String type)
ArrayMetaData	setEmbeddedElement(boolean embedded)
ArrayMetaData	setSerializedElement(boolean serialized)
java.lang.String	toString()

Methods inherited from class org.datanucleus.metadata.ContainerMetaData

allowNulls, getMemberMetaData, getMemberName, populate

Methods inherited from class org.datanucleus.metadata.MetaData

addExtension, addExtensions, getExtensions, getMetaDataManager, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, removeExtension, setExtensions, setInitialised, setParent, setPopulated, setUsed

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

element

protected ContainerComponent element

Representation of the element of the array.

mayContainPersistableElements

protected boolean mayContainPersistableElements

wether this array may contain persistable elements

Constructor Detail

ArrayMetaData

public ArrayMetaData(ArrayMetaData arrmd)

Constructor to create a copy of the passed metadata.

Parameters:

arrmd - The metadata to copy

ArrayMetaData

public ArrayMetaData()

Default constructor. Set the fields using setters, before populate().

Method Detail

populate

public void populate(ClassLoaderResolver clr,
                     java.lang.ClassLoader primary)

Method to populate any defaults, and check the validity of the MetaData.

Parameters:

clr - ClassLoaderResolver to use in loading any classes

primary - the primary ClassLoader to use (or null)

elementIsPersistent

public boolean elementIsPersistent()

getElementClassMetaData

public AbstractClassMetaData getElementClassMetaData(ClassLoaderResolver clr)

Convenience accessor for the Element ClassMetaData.

Parameters:

clr - ClassLoader resolver (in case we need to initialise it)

Returns:

element ClassMetaData

mayContainPersistableElements

public boolean mayContainPersistableElements()

Returns whether this array may contain persistable elements (as indicated by the user). TODO Remove this. The element-type of the array defines such things and this is not the solution

Returns:

whether this array may contain persistable elements

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

getElementType

public java.lang.String getElementType()

Accessor for the element implementation types (when element is a reference type).

Returns:

element implementation types

getElementTypes

public java.lang.String[] getElementTypes()

setElementType

public ArrayMetaData setElementType(java.lang.String type)

setEmbeddedElement

public ArrayMetaData setEmbeddedElement(boolean embedded)

setSerializedElement

public ArrayMetaData setSerializedElement(boolean serialized)

setDependentElement

public ArrayMetaData setDependentElement(boolean dependent)

getReferencedClassMetaData

void getReferencedClassMetaData(java.util.List<AbstractClassMetaData> orderedCmds,
                                java.util.Set<AbstractClassMetaData> referencedCmds,
                                ClassLoaderResolver clr)

Accessor for all AbstractClassMetaData referenced by this array.

Parameters:

orderedCmds - List of ordered AbstractClassMetaData objects (added to).

referencedCmds - Set of all AbstractClassMetaData objects (added to).

clr - the ClassLoaderResolver

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object