Module org.datanucleus

Package org.datanucleus.metadata

Class PersistenceUnitMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.PersistenceUnitMetaData

All Implemented Interfaces:

Serializable

public class PersistenceUnitMetaData
extends MetaData

MetaData representation of a "persistence.xml" persistence unit. Corresponds to the JPA spec section 6.2.1

See Also:

Serialized Form

Field Summary

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_FETCH_FK_ONLY, 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
PersistenceUnitMetaData(String name, String transactionType, URI rootURI)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addClassName(String className)
void	addClassNames(Set<String> classNames)
void	addJarFile(String jarName)
void	addJarFile(URL jarURL)	Method to add a jar file to the persistence unit.
void	addJarFiles(Set<String> jarNames)
void	addMappingFile(String mappingFile)
void	addProperty(String key, String value)
void	clearJarFiles()	Convenience method to clear out all jar files.
Set<String>	getClassNames()
String	getDescription()
boolean	getExcludeUnlistedClasses()
Set	getJarFiles()	Accessor for the jar files for this persistence unit.
String	getJtaDataSource()
Set<String>	getMappingFiles()
String	getName()
String	getNonJtaDataSource()
Properties	getProperties()
String	getProvider()
URI	getRootURI()	Accessor for the persistence unit root.
String	getSharedCacheMode()	Accessor for the persistence unit shared cache mode.
TransactionType	getTransactionType()
String	getValidationMode()	Accessor to the Validation Mode
void	setDescription(String desc)
void	setExcludeUnlistedClasses(boolean flag)
void	setJtaDataSource(String data)
void	setNonJtaDataSource(String data)
void	setProvider(String provider)
void	setSharedCacheMode(String cache)	Mutator for the shared cache mode.
void	setTransactionType(String transType)
void	setValidationMode(String validationMode)	Mutator for the validation mode
String	toString(String prefix, String indent)	Returns a string representation of the object using a prefix This can be used as part of a facility to output a MetaData file.

Methods inherited from class org.datanucleus.metadata.MetaData

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistenceUnitMetaData

public PersistenceUnitMetaData(String name,
                               String transactionType,
                               URI rootURI)

Constructor.

Parameters:

name - Name of the persistence unit

transactionType - Transaction type for this unit

rootURI - Root of the persistence-unit

Method Detail

getName

public String getName()

getRootURI

public URI getRootURI()

Accessor for the persistence unit root.

Returns:

Root of the persistence unit

setTransactionType

public void setTransactionType(String transType)

getTransactionType

public TransactionType getTransactionType()

getSharedCacheMode

public String getSharedCacheMode()

Accessor for the persistence unit shared cache mode.

Returns:

Caching policy: ALL, NONE, ENABLE_SELECTIVE, DISABLE_SELECTIVE, UNSPECIFIED.

setSharedCacheMode

public void setSharedCacheMode(String cache)

Mutator for the shared cache mode.

Parameters:

cache - The shared cache mode: ALL, NONE, ENABLE_SELECTIVE, DISABLE_SELECTIVE, UNSPECIFIED.

getDescription

public String getDescription()

setDescription

public void setDescription(String desc)

getProvider

public String getProvider()

setProvider

public void setProvider(String provider)

getJtaDataSource

public String getJtaDataSource()

setJtaDataSource

public void setJtaDataSource(String data)

getNonJtaDataSource

public String getNonJtaDataSource()

setNonJtaDataSource

public void setNonJtaDataSource(String data)

setValidationMode

public void setValidationMode(String validationMode)

Mutator for the validation mode

Parameters:

validationMode - AUTO, CALLBACK or NONE

getValidationMode

public String getValidationMode()

Accessor to the Validation Mode

Returns:

AUTO, CALLBACK or NONE

setExcludeUnlistedClasses

public void setExcludeUnlistedClasses(boolean flag)

getExcludeUnlistedClasses

public boolean getExcludeUnlistedClasses()

addClassName

public void addClassName(String className)

addClassNames

public void addClassNames(Set<String> classNames)

addJarFile

public void addJarFile(String jarName)

addJarFiles

public void addJarFiles(Set<String> jarNames)

addJarFile

public void addJarFile(URL jarURL)

Method to add a jar file to the persistence unit.

Parameters:

jarURL - Jar file URL

clearJarFiles

public void clearJarFiles()

Convenience method to clear out all jar files.

addMappingFile

public void addMappingFile(String mappingFile)

addProperty

public void addProperty(String key,
                        String value)

getClassNames

public Set<String> getClassNames()

getMappingFiles

public Set<String> getMappingFiles()

getJarFiles

public Set getJarFiles()

Accessor for the jar files for this persistence unit. The contents of the Set may be Strings (the names) or URLs

Returns:

The jar names

getProperties

public Properties getProperties()

toString

public String toString(String prefix,
                       String indent)

Returns a string representation of the object using a prefix This can be used as part of a facility to output a MetaData file.

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.