Package org.datanucleus.metadata
Class PersistenceUnitMetaData
- java.lang.Object
-
- org.datanucleus.metadata.MetaData
-
- org.datanucleus.metadata.PersistenceUnitMetaData
-
- All Implemented Interfaces:
java.io.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 Modifier and Type Field Description (package private) java.util.Set<java.lang.String>
classNames
Names of the classes specified.(package private) java.lang.String
description
Description of the persistence unit.(package private) boolean
excludeUnlistedClasses
Whether to exclude unlisted classes.(package private) java.util.Set<java.lang.Object>
jarFiles
Names/URLs of the JAR files specified.(package private) java.lang.String
jtaDataSource
JTA data source for the persistence unit.(package private) java.util.Set<java.lang.String>
mappingFileNames
Names of the mapping files specified.(package private) java.lang.String
name
Name of the persistence unit.(package private) java.lang.String
nonJtaDataSource
Non-JTA data source for the persistence unit.(package private) java.util.Properties
properties
Vendor properties.(package private) java.lang.String
provider
Provider for the persistence unit.(package private) java.net.URI
rootURI
Root of the persistence unit.private static long
serialVersionUID
(package private) java.lang.String
sharedCacheMode
L2 cache mode for persistable objects.(package private) TransactionType
transactionType
Transaction type for this persistence unit.(package private) java.lang.String
validationMode
Validation Mode for Bean Validator.-
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 PersistenceUnitMetaData(java.lang.String name, java.lang.String transactionType, java.net.URI rootURI)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addClassName(java.lang.String className)
void
addClassNames(java.util.Set<java.lang.String> classNames)
void
addJarFile(java.lang.String jarName)
void
addJarFile(java.net.URL jarURL)
Method to add a jar file to the persistence unit.void
addJarFiles(java.util.Set<java.lang.String> jarNames)
void
addMappingFile(java.lang.String mappingFile)
void
addProperty(java.lang.String key, java.lang.String value)
void
clearJarFiles()
Convenience method to clear out all jar files.java.util.Set<java.lang.String>
getClassNames()
java.lang.String
getDescription()
boolean
getExcludeUnlistedClasses()
java.util.Set
getJarFiles()
Accessor for the jar files for this persistence unit.java.lang.String
getJtaDataSource()
java.util.Set<java.lang.String>
getMappingFiles()
java.lang.String
getName()
java.lang.String
getNonJtaDataSource()
java.util.Properties
getProperties()
java.lang.String
getProvider()
java.net.URI
getRootURI()
Accessor for the persistence unit root.java.lang.String
getSharedCacheMode()
Accessor for the persistence unit shared cache mode.TransactionType
getTransactionType()
java.lang.String
getValidationMode()
Accessor to the Validation Modevoid
setDescription(java.lang.String desc)
void
setExcludeUnlistedClasses(boolean flag)
void
setJtaDataSource(java.lang.String data)
void
setNonJtaDataSource(java.lang.String data)
void
setProvider(java.lang.String provider)
void
setSharedCacheMode(java.lang.String cache)
Mutator for the shared cache mode.void
setTransactionType(java.lang.String transType)
void
setValidationMode(java.lang.String validationMode)
Mutator for the validation modejava.lang.String
toString(java.lang.String prefix, java.lang.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, setInitialised, setParent, setPopulated, setUsed
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
name
java.lang.String name
Name of the persistence unit.
-
rootURI
java.net.URI rootURI
Root of the persistence unit. This can be used if wanting to scan for classes, to find the root to scan from.
-
transactionType
TransactionType transactionType
Transaction type for this persistence unit.
-
description
java.lang.String description
Description of the persistence unit.
-
provider
java.lang.String provider
Provider for the persistence unit.
-
validationMode
java.lang.String validationMode
Validation Mode for Bean Validator.
-
jtaDataSource
java.lang.String jtaDataSource
JTA data source for the persistence unit.
-
nonJtaDataSource
java.lang.String nonJtaDataSource
Non-JTA data source for the persistence unit.
-
classNames
java.util.Set<java.lang.String> classNames
Names of the classes specified.
-
jarFiles
java.util.Set<java.lang.Object> jarFiles
Names/URLs of the JAR files specified.
-
mappingFileNames
java.util.Set<java.lang.String> mappingFileNames
Names of the mapping files specified.
-
properties
java.util.Properties properties
Vendor properties.
-
excludeUnlistedClasses
boolean excludeUnlistedClasses
Whether to exclude unlisted classes.
-
sharedCacheMode
java.lang.String sharedCacheMode
L2 cache mode for persistable objects.
-
-
Constructor Detail
-
PersistenceUnitMetaData
public PersistenceUnitMetaData(java.lang.String name, java.lang.String transactionType, java.net.URI rootURI)
Constructor.- Parameters:
name
- Name of the persistence unittransactionType
- Transaction type for this unitrootURI
- Root of the persistence-unit
-
-
Method Detail
-
getName
public java.lang.String getName()
-
getRootURI
public java.net.URI getRootURI()
Accessor for the persistence unit root.- Returns:
- Root of the persistence unit
-
setTransactionType
public void setTransactionType(java.lang.String transType)
-
getTransactionType
public TransactionType getTransactionType()
-
getSharedCacheMode
public java.lang.String getSharedCacheMode()
Accessor for the persistence unit shared cache mode.- Returns:
- Caching policy: ALL, NONE, ENABLE_SELECTIVE, DISABLE_SELECTIVE, UNSPECIFIED.
-
setSharedCacheMode
public void setSharedCacheMode(java.lang.String cache)
Mutator for the shared cache mode.- Parameters:
cache
- The shared cache mode: ALL, NONE, ENABLE_SELECTIVE, DISABLE_SELECTIVE, UNSPECIFIED.
-
getDescription
public java.lang.String getDescription()
-
setDescription
public void setDescription(java.lang.String desc)
-
getProvider
public java.lang.String getProvider()
-
setProvider
public void setProvider(java.lang.String provider)
-
getJtaDataSource
public java.lang.String getJtaDataSource()
-
setJtaDataSource
public void setJtaDataSource(java.lang.String data)
-
getNonJtaDataSource
public java.lang.String getNonJtaDataSource()
-
setNonJtaDataSource
public void setNonJtaDataSource(java.lang.String data)
-
setValidationMode
public void setValidationMode(java.lang.String validationMode)
Mutator for the validation mode- Parameters:
validationMode
- AUTO, CALLBACK or NONE
-
getValidationMode
public java.lang.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(java.lang.String className)
-
addClassNames
public void addClassNames(java.util.Set<java.lang.String> classNames)
-
addJarFile
public void addJarFile(java.lang.String jarName)
-
addJarFiles
public void addJarFiles(java.util.Set<java.lang.String> jarNames)
-
addJarFile
public void addJarFile(java.net.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(java.lang.String mappingFile)
-
addProperty
public void addProperty(java.lang.String key, java.lang.String value)
-
getClassNames
public java.util.Set<java.lang.String> getClassNames()
-
getMappingFiles
public java.util.Set<java.lang.String> getMappingFiles()
-
getJarFiles
public java.util.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 java.util.Properties getProperties()
-
toString
public java.lang.String toString(java.lang.String prefix, java.lang.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 stringindent
- indent string- Returns:
- a string representation of the object.
-
-