MetaData (DataNucleus Core 4.1.17-SNAPSHOT API)

java.lang.Object
- org.datanucleus.metadata.MetaData

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractClassMetaData, AbstractElementMetaData, AbstractMemberMetaData, ColumnMetaData, ConstraintMetaData, ContainerMetaData, DiscriminatorMetaData, EmbeddedMetaData, EventListenerMetaData, FetchGroupMemberMetaData, FetchGroupMetaData, FetchPlanMetaData, FileMetaData, IdentityMetaData, ImplementsMetaData, InheritanceMetaData, JoinMetaData, OrderMetaData, PackageMetaData, PersistenceFileMetaData, PersistenceUnitMetaData, PrimaryKeyMetaData, QueryMetaData, QueryResultMetaData, SequenceMetaData, StoredProcQueryMetaData, StoredProcQueryParameterMetaData, TableGeneratorMetaData, VersionMetaData
```
public class MetaData
extends Object
implements Serializable
```
Base class for all MetaData.
MetaData Lifecycle
The states represent the lifecycle of a MetaData object. The lifecycle goes as follows :
1. MetaData object is created (values passed in from a parsed file, or manually generated)
2. MetaData object is populated (maybe pass in a class that it represents, creating any additional information that wasn't in the initial data).
3. MetaData object is initialised (any internal arrays are set up, and additions of data is blocked from this point).
4. MetaData object is added to with runtime information like actual column names and types in use.
MetaData Extensability

All MetaData elements are extensible with extensions for a "vendor-name". Extensions take the form of a key and a value.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH` Class : when using multitenancy, defines the length of column used for the mutitenancy discriminator.
`static String`	`EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME` Class : when using multitenancy, defines the column name used for the mutitenancy discriminator.
`static String`	`EXTENSION_CLASS_MULTITENANCY_DISABLE` Class : when using multitenancy, disables its use for this class.
`static String`	`EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE` Class : when using multitenancy, defines the jdbc-type used for the mutitenancy discriminator column.
`static String`	`EXTENSION_CLASS_READ_ONLY` Class : read only.
`static String`	`EXTENSION_CLASS_VERSION_FIELD_NAME` Class : define the name of a field that will store the version of this class.
`static String`	`EXTENSION_MEMBER_CACHEABLE` Member : whether the field is (L2) cacheable (for JPA).
`static String`	`EXTENSION_MEMBER_CALENDAR_ONE_COLUMN` Member : when the field is Calendar, signifies that it should be stored as a single column.
`static String`	`EXTENSION_MEMBER_CASCADE_PERSIST` Member : whether the field is cascade-persist (for JDO).
`static String`	`EXTENSION_MEMBER_CASCADE_REFRESH` Member : whether the field is cascade-refresh (for JDO).
`static String`	`EXTENSION_MEMBER_CASCADE_UPDATE` Member : whether the field is cascade-update (for JDO).
`static String`	`EXTENSION_MEMBER_COMPARATOR_NAME` Member : name of comparator class when of SortedSet/SortedMap type.
`static String`	`EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS` Member : whether this member (collection/map/array) should allow null elements/keys/values.
`static String`	`EXTENSION_MEMBER_ENUM_GETTER_BY_VALUE` Member : when field is enum, name of the method to return the enum given the value.
`static String`	`EXTENSION_MEMBER_ENUM_VALUE_GETTER` Member : when field is enum, name of the method to get the "value" of the enum.
`static String`	`EXTENSION_MEMBER_FETCH_FK_ONLY` Member : whether to fetch just the FK (and not populate the related object).
`static String`	`EXTENSION_MEMBER_IMPLEMENTATION_CLASSES` Member : implementation class names, when the member is of a interface/reference type.
`static String`	`EXTENSION_MEMBER_INSERTABLE` Member : whether the field is insertable (for JDO).
`static String`	`EXTENSION_MEMBER_LIST_ORDERING` Member : the ordering clause to use for this List field.
`static String`	`EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL` Member : when this field has a value generator, only apply it when the field is not set.
`static String`	`EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED`
`static String`	`EXTENSION_MEMBER_TYPE_CONVERTER_NAME` Member : name of type converter to use.
`static String`	`EXTENSION_MEMBER_UPDATEABLE` Member : whether the field is updateable (for JDO).
`protected Collection<ExtensionMetaData>`	`extensions` List of extensions for this MetaData element.
`static int`	`METADATA_CREATED_STATE` State representing the start state of MetaData, representing the initial values passed in.
`static int`	`METADATA_INITIALISED_STATE` State reflecting that MetaData object has been initialised with any internal info required.
`static int`	`METADATA_POPULATED_STATE` State reflecting that MetaData has been populated with real class definition adding any defaulted info.
`static int`	`METADATA_USED_STATE` State reflecting that MetaData object has been modified with usage information (e.g defaulted column names).
`protected int`	`metaDataState` State of the MetaData.
`protected MetaData`	`parent` Parent MetaData object, allowing hierarchical MetaData structure.
`static String`	`VENDOR_NAME` Vendor name (DataNucleus) used for extensions.

Constructor Summary

Constructors
Constructor and Description

MetaData()

MetaData(MetaData parent)
Constructor.

MetaData(MetaData parent, MetaData copy)
Copy constructor.

Constructors
Constructor and Description
`MetaData()`
`MetaData(MetaData parent)` Constructor.
`MetaData(MetaData parent, MetaData copy)` Copy constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetaData`	`addExtension(String key, String value)`
`MetaData`	`addExtension(String vendor, String key, String value)`
`ExtensionMetaData[]`	`getExtensions()`
`int`	`getNoOfExtensions()`
`MetaData`	`getParent()`
`String`	`getValueForExtension(String key)` Accessor for the value of a particular extension.
`String[]`	`getValuesForExtension(String key)` Accessor for the value of a particular extension, but splitting it into separate parts.
`boolean`	`hasExtension(String key)`
`void`	`initialise(ClassLoaderResolver clr, MetaDataManager mmgr)`
`boolean`	`isInitialised()`
`boolean`	`isPopulated()`
`boolean`	`isUsed()`
`ExtensionMetaData`	`newExtensionMetaData(String vendor, String key, String value)` Method to create a new ExtensionMetaData, add it, and return it.
`MetaData`	`removeExtension(String key)`
`void`	`setParent(MetaData md)`
`String`	`toString()` Accessor for a string representation of the object.
`String`	`toString(String prefix, String indent)` Returns a string representation of the object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - METADATA_CREATED_STATE
```
public static final int METADATA_CREATED_STATE
```
    State representing the start state of MetaData, representing the initial values passed in.
    
    See Also:
    
    Constant Field Values
  - METADATA_POPULATED_STATE
```
public static final int METADATA_POPULATED_STATE
```
    State reflecting that MetaData has been populated with real class definition adding any defaulted info.
    
    See Also:
    
    Constant Field Values
  - METADATA_INITIALISED_STATE
```
public static final int METADATA_INITIALISED_STATE
```
    State reflecting that MetaData object has been initialised with any internal info required.
    
    See Also:
    
    Constant Field Values
  - METADATA_USED_STATE
```
public static final int METADATA_USED_STATE
```
    State reflecting that MetaData object has been modified with usage information (e.g defaulted column names).
    
    See Also:
    
    Constant Field Values
  - metaDataState
```
protected int metaDataState
```
    State of the MetaData.
  - parent
```
protected MetaData parent
```
    Parent MetaData object, allowing hierarchical MetaData structure.
  - VENDOR_NAME
```
public static final String VENDOR_NAME
```
    Vendor name (DataNucleus) used for extensions.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_CLASS_READ_ONLY
```
public static final String EXTENSION_CLASS_READ_ONLY
```
    Class : read only.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_CLASS_MULTITENANCY_DISABLE
```
public static final String EXTENSION_CLASS_MULTITENANCY_DISABLE
```
    Class : when using multitenancy, disables its use for this class.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME
```
public static final String EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME
```
    Class : when using multitenancy, defines the column name used for the mutitenancy discriminator.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH
```
public static final String EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH
```
    Class : when using multitenancy, defines the length of column used for the mutitenancy discriminator.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE
```
public static final String EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE
```
    Class : when using multitenancy, defines the jdbc-type used for the mutitenancy discriminator column.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_CLASS_VERSION_FIELD_NAME
```
public static final String EXTENSION_CLASS_VERSION_FIELD_NAME
```
    Class : define the name of a field that will store the version of this class.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_TYPE_CONVERTER_NAME
```
public static final String EXTENSION_MEMBER_TYPE_CONVERTER_NAME
```
    Member : name of type converter to use.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED
```
public static final String EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED
```
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_COMPARATOR_NAME
```
public static final String EXTENSION_MEMBER_COMPARATOR_NAME
```
    Member : name of comparator class when of SortedSet/SortedMap type.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_IMPLEMENTATION_CLASSES
```
public static final String EXTENSION_MEMBER_IMPLEMENTATION_CLASSES
```
    Member : implementation class names, when the member is of a interface/reference type.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_ENUM_VALUE_GETTER
```
public static final String EXTENSION_MEMBER_ENUM_VALUE_GETTER
```
    Member : when field is enum, name of the method to get the "value" of the enum.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_ENUM_GETTER_BY_VALUE
```
public static final String EXTENSION_MEMBER_ENUM_GETTER_BY_VALUE
```
    Member : when field is enum, name of the method to return the enum given the value.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_CALENDAR_ONE_COLUMN
```
public static final String EXTENSION_MEMBER_CALENDAR_ONE_COLUMN
```
    Member : when the field is Calendar, signifies that it should be stored as a single column.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_INSERTABLE
```
public static final String EXTENSION_MEMBER_INSERTABLE
```
    Member : whether the field is insertable (for JDO).
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_UPDATEABLE
```
public static final String EXTENSION_MEMBER_UPDATEABLE
```
    Member : whether the field is updateable (for JDO).
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_CASCADE_PERSIST
```
public static final String EXTENSION_MEMBER_CASCADE_PERSIST
```
    Member : whether the field is cascade-persist (for JDO).
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_CASCADE_UPDATE
```
public static final String EXTENSION_MEMBER_CASCADE_UPDATE
```
    Member : whether the field is cascade-update (for JDO).
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_CASCADE_REFRESH
```
public static final String EXTENSION_MEMBER_CASCADE_REFRESH
```
    Member : whether the field is cascade-refresh (for JDO).
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_CACHEABLE
```
public static final String EXTENSION_MEMBER_CACHEABLE
```
    Member : whether the field is (L2) cacheable (for JPA).
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_FETCH_FK_ONLY
```
public static final String EXTENSION_MEMBER_FETCH_FK_ONLY
```
    Member : whether to fetch just the FK (and not populate the related object).
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS
```
public static final String EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS
```
    Member : whether this member (collection/map/array) should allow null elements/keys/values.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_LIST_ORDERING
```
public static final String EXTENSION_MEMBER_LIST_ORDERING
```
    Member : the ordering clause to use for this List field.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL
```
public static final String EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL
```
    Member : when this field has a value generator, only apply it when the field is not set.
    
    See Also:
    
    Constant Field Values
  - extensions
```
protected Collection<ExtensionMetaData> extensions
```
    List of extensions for this MetaData element.
- Constructor Detail
  - MetaData
```
public MetaData()
```
  - MetaData
```
public MetaData(MetaData parent)
```
    Constructor. Taking the parent MetaData object (if any).
    
    Parameters:
    
    parent - The parent MetaData object.
  - MetaData
```
public MetaData(MetaData parent,
                MetaData copy)
```
    Copy constructor. Taking the parent MetaData object, and an object to copy from.
    
    Parameters:
    
    parent - The parent MetaData object.
    
    copy - The metadata to copy from
- Method Detail
  - initialise
```
public void initialise(ClassLoaderResolver clr,
                       MetaDataManager mmgr)
```
  - setParent
```
public void setParent(MetaData md)
```
  - addExtension
```
public MetaData addExtension(String vendor,
                             String key,
                             String value)
```
  - addExtension
```
public MetaData addExtension(String key,
                             String value)
```
  - newExtensionMetaData
```
public ExtensionMetaData newExtensionMetaData(String vendor,
                                              String key,
                                              String value)
```
    Method to create a new ExtensionMetaData, add it, and return it.
    
    Parameters:
    
    vendor - The vendor name
    
    key - Key of the extension
    
    value - Value
    
    Returns:
    
    The extension
  - removeExtension
```
public MetaData removeExtension(String key)
```
  - getParent
```
public MetaData getParent()
```
  - isPopulated
```
public boolean isPopulated()
```
  - isInitialised
```
public boolean isInitialised()
```
  - isUsed
```
public boolean isUsed()
```
  - getNoOfExtensions
```
public int getNoOfExtensions()
```
  - getExtensions
```
public ExtensionMetaData[] getExtensions()
```
  - hasExtension
```
public boolean hasExtension(String key)
```
  - getValueForExtension
```
public String getValueForExtension(String key)
```
    Accessor for the value of a particular extension.
    
    Parameters:
    
    key - The key of the extension
    
    Returns:
    
    The value of the extension (null if not existing)
  - getValuesForExtension
```
public String[] getValuesForExtension(String key)
```
    Accessor for the value of a particular extension, but splitting it into separate parts. This is for extension tags that have a value as comma separated.
    
    Parameters:
    
    key - The key of the extension
    
    Returns:
    
    The value(s) of the extension (null if not existing)
  - toString
```
public String toString()
```
    Accessor for a string representation of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - toString
```
public String toString(String prefix,
                       String indent)
```
    Returns a string representation of the object.
    
    Parameters:
    
    prefix - prefix string
    
    indent - indent string
    
    Returns:
    
    a string representation of the object.

Class MetaData

MetaData Lifecycle

MetaData Extensability

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

METADATA_CREATED_STATE

METADATA_POPULATED_STATE

METADATA_INITIALISED_STATE

METADATA_USED_STATE

metaDataState

parent

VENDOR_NAME

EXTENSION_CLASS_READ_ONLY

EXTENSION_CLASS_MULTITENANCY_DISABLE

EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME

EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH

EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE

EXTENSION_CLASS_VERSION_FIELD_NAME

EXTENSION_MEMBER_TYPE_CONVERTER_NAME

EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED

EXTENSION_MEMBER_COMPARATOR_NAME

EXTENSION_MEMBER_IMPLEMENTATION_CLASSES

EXTENSION_MEMBER_ENUM_VALUE_GETTER

EXTENSION_MEMBER_ENUM_GETTER_BY_VALUE

EXTENSION_MEMBER_CALENDAR_ONE_COLUMN

EXTENSION_MEMBER_INSERTABLE

EXTENSION_MEMBER_UPDATEABLE

EXTENSION_MEMBER_CASCADE_PERSIST

EXTENSION_MEMBER_CASCADE_UPDATE

EXTENSION_MEMBER_CASCADE_REFRESH

EXTENSION_MEMBER_CACHEABLE

EXTENSION_MEMBER_FETCH_FK_ONLY

EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS

EXTENSION_MEMBER_LIST_ORDERING

EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL

extensions

Constructor Detail

MetaData

MetaData

MetaData

Method Detail

initialise

setParent

addExtension

addExtension

newExtensionMetaData

removeExtension

getParent

isPopulated

isInitialised

isUsed

getNoOfExtensions

getExtensions

hasExtension

getValueForExtension

getValuesForExtension

toString

toString