|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.openjpa.lib.conf.AbstractProductDerivation
org.apache.openjpa.persistence.PersistenceProductDerivation
public class PersistenceProductDerivation
Sets JPA specification defaults and parses JPA specification XML files.
For globals, looks in openjpa.properties system property for
the location of a file to parse. If no system property is defined, the
default resource location of META-INF/openjpa.xml is used.
For defaults, looks for META-INF/persistence.xml.
Within persistence.xml, look for the named persistence unit, or
if no name given, an OpenJPA unit (preferring an unnamed OpenJPA unit to
a named one).
| Nested Class Summary | |
|---|---|
static class |
PersistenceProductDerivation.ConfigurationParser
SAX handler capable of parsing an JPA persistence.xml file. |
static class |
PersistenceProductDerivation.ConfigurationProviderImpl
Custom configuration provider. |
| Field Summary | |
|---|---|
protected String |
_providerImplName
|
static Specification |
ALIAS_EJB
|
static String |
PREFIX
|
static String |
RSRC_DEFAULT
|
static String |
RSRC_GLOBAL
|
static Specification |
SPEC_JPA
|
static BigDecimal |
VERSION_1_0
|
| Fields inherited from interface org.apache.openjpa.conf.OpenJPAProductDerivation |
|---|
TYPE_PRODUCT_STORE, TYPE_SPEC, TYPE_SPEC_STORE, TYPE_STORE |
| Fields inherited from interface org.apache.openjpa.lib.conf.ProductDerivation |
|---|
TYPE_FEATURE, TYPE_PRODUCT |
| Constructor Summary | |
|---|---|
PersistenceProductDerivation()
|
|
| Method Summary | |
|---|---|
boolean |
afterSpecificationSet(Configuration c)
Called after the specification has been set. |
boolean |
beforeConfigurationLoad(Configuration c)
Provides the instance with the opportunity to mutate conf before the user configuration is applied. |
boolean |
checkPuNameCollisions(Log logger,
String puName)
This method checks to see if the provided puName was
detected in multiple resources. |
List<String> |
getAnchorsInFile(File file)
Return a List file. |
List |
getAnchorsInResource(String resource)
Return a List resource. |
String |
getConfigurationPrefix()
Return the configuration prefix for properties of this product. |
String |
getDefaultResourceLocation()
Return a string identifying the default resource location for this product derivation, if one exists. |
Set<String> |
getSupportedQueryHints()
Return set of Query hint keys recognized by this receiver. |
int |
getType()
Return the type of derivation. |
ConfigurationProvider |
load(File file,
String anchor)
Load given file, or return null if it is not a file this receiver understands. |
ConfigurationProvider |
load(PersistenceUnitInfo pinfo,
Map m)
Load configuration from the given persistence unit with the specified user properties. |
ConfigurationProvider |
load(String rsrc,
String anchor,
ClassLoader loader)
Load the given given resource into the returned ConfigurationProvider, or return null if it is not a resource this receiver understands. |
ConfigurationProvider |
load(String rsrc,
String name,
Map m)
Load configuration from the given resource and unit names, which may be null. |
ConfigurationProvider |
loadDefaults(ClassLoader loader)
Load defaults into the returned ConfigurationProvider, or return null if no defaults are found. |
ConfigurationProvider |
loadGlobals(ClassLoader loader)
Load globals into the returned ConfigurationProvider, or return null if no globals are found. |
void |
putBrokerFactoryAliases(Map<String,String> m)
Load default alias options into the given map. |
void |
validate()
Ensure that this derivation is valid. |
| Methods inherited from class org.apache.openjpa.lib.conf.AbstractProductDerivation |
|---|
beforeConfigurationClose, beforeConfigurationConstruct |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.apache.openjpa.lib.conf.ProductDerivation |
|---|
beforeConfigurationClose, beforeConfigurationConstruct |
| Field Detail |
|---|
public static final Specification SPEC_JPA
public static final Specification ALIAS_EJB
public static final String RSRC_GLOBAL
public static final String RSRC_DEFAULT
public static final BigDecimal VERSION_1_0
public static final String PREFIX
protected String _providerImplName
| Constructor Detail |
|---|
public PersistenceProductDerivation()
| Method Detail |
|---|
public void putBrokerFactoryAliases(Map<String,String> m)
OpenJPAProductDerivation
putBrokerFactoryAliases in interface OpenJPAProductDerivationpublic int getType()
ProductDerivation
getType in interface ProductDerivationpublic String getConfigurationPrefix()
ProductDerivation
getConfigurationPrefix in interface ProductDerivationgetConfigurationPrefix in class AbstractProductDerivationpublic Set<String> getSupportedQueryHints()
ProductDerivation
getSupportedQueryHints in interface ProductDerivationgetSupportedQueryHints in class AbstractProductDerivation
public void validate()
throws Exception
ProductDerivation
validate in interface ProductDerivationvalidate in class AbstractProductDerivationExceptionpublic boolean beforeConfigurationLoad(Configuration c)
ProductDerivationconf before the user configuration is applied.
beforeConfigurationLoad in interface ProductDerivationbeforeConfigurationLoad in class AbstractProductDerivationpublic boolean afterSpecificationSet(Configuration c)
ProductDerivation
afterSpecificationSet in interface ProductDerivationafterSpecificationSet in class AbstractProductDerivation
public ConfigurationProvider load(PersistenceUnitInfo pinfo,
Map m)
throws IOException
IOException
public ConfigurationProvider load(String rsrc,
String name,
Map m)
throws IOException
IOException
public ConfigurationProvider load(String rsrc,
String anchor,
ClassLoader loader)
throws IOException
ProductDerivation
load in interface ProductDerivationload in class AbstractProductDerivationanchor - optional named anchor within a multiple-configuration
resource
IOException
public ConfigurationProvider load(File file,
String anchor)
throws IOException
ProductDerivation
load in interface ProductDerivationload in class AbstractProductDerivationanchor - optional named anchor within a multiple-configuration file
IOExceptionpublic String getDefaultResourceLocation()
ProductDerivationnull.
getDefaultResourceLocation in interface ProductDerivationgetDefaultResourceLocation in class AbstractProductDerivation
public List<String> getAnchorsInFile(File file)
throws IOException
ProductDerivationfile.
The returned names are not fully-qualified, so must be used in
conjunction with file in calls
to ProductDerivation.load(java.io.File, String).
Returns null or an empty list if no anchors could be found.
getAnchorsInFile in interface ProductDerivationgetAnchorsInFile in class AbstractProductDerivationIOException
public List getAnchorsInResource(String resource)
throws Exception
ProductDerivationresource. The returned names are not
fully-qualified, so must be used in conjunction with
resource in calls to ProductDerivation.load(java.io.File, String).
Returns null or an empty list if no anchors could be found.
getAnchorsInResource in interface ProductDerivationgetAnchorsInResource in class AbstractProductDerivationException
public ConfigurationProvider loadGlobals(ClassLoader loader)
throws IOException
ProductDerivation
loadGlobals in interface ProductDerivationloadGlobals in class AbstractProductDerivationIOException
public ConfigurationProvider loadDefaults(ClassLoader loader)
throws IOException
ProductDerivation
loadDefaults in interface ProductDerivationloadDefaults in class AbstractProductDerivationIOException
public boolean checkPuNameCollisions(Log logger,
String puName)
puName was
detected in multiple resources. If a collision is detected, a warning
will be logged and this method will return true.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||