org.datanucleus.metadata

Class PersistenceFileMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.PersistenceFileMetaData

All Implemented Interfaces:

Serializable

public class PersistenceFileMetaData
extends MetaData

Representation of a Meta-Data "persistence.xml" file. Contains a set of "persistence-unit" meta-data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	filename Filename of the "persistence.xml"
protected HashSet<PersistenceUnitMetaData>	persistenceUnits Persistence units defined in this file.

Fields inherited from class org.datanucleus.metadata.MetaData

extensions, LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME, VENDOR_NAME_OLD

Constructor Summary

Constructors

Constructor and Description
PersistenceFileMetaData(String filename) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addPersistenceUnit(PersistenceUnitMetaData pumd) Method to add a persistence unit
String	getFilename() Accessor for the filename
int	getNoOfPersistenceUnits() Accessor for the number of persistence units.
PersistenceUnitMetaData	getPersistenceUnit(String name) Accessor for the Meta-Data of a persistence unit with a given name.
PersistenceUnitMetaData[]	getPersistenceUnits() Accessor for the persistence units in this "persistence.xml" file.
void	setFilename(String filename) Mutator for the filename for this MetaData file.
String	toString(String indent) Returns a string representation of the object.

Methods inherited from class org.datanucleus.metadata.MetaData

addExtension, addExtension, assertIfInitialised, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

filename

protected String filename

Filename of the "persistence.xml"

persistenceUnits

protected HashSet<PersistenceUnitMetaData> persistenceUnits

Persistence units defined in this file.

Constructor Detail

PersistenceFileMetaData

public PersistenceFileMetaData(String filename)

Constructor.

Parameters:

filename - The file where this is stored (or null).

Method Detail

getFilename

public String getFilename()

Accessor for the filename

Returns:

The filename of this MetaData file.

getNoOfPersistenceUnits

public int getNoOfPersistenceUnits()

Accessor for the number of persistence units.

Returns:

no of persistence units.

getPersistenceUnit

public PersistenceUnitMetaData getPersistenceUnit(String name)

Accessor for the Meta-Data of a persistence unit with a given name.

Parameters:

name - Name of the persistence unit

Returns:

Meta-Data for the persistence unit

getPersistenceUnits

public PersistenceUnitMetaData[] getPersistenceUnits()

Accessor for the persistence units in this "persistence.xml" file.

Returns:

The persistence units

setFilename

public void setFilename(String filename)

Mutator for the filename for this MetaData file.

Parameters:

filename - The filename of this MetaData file.

addPersistenceUnit

public void addPersistenceUnit(PersistenceUnitMetaData pumd)

Method to add a persistence unit

Parameters:

pumd - The PersistenceUnitMetaData to add.

toString

public String toString(String indent)

Returns a string representation of the object.

Parameters:

indent - The indent

Returns:

a string representation of the object.