MappingRepository (OpenJPA Parent POM 2.4.2 API)

java.lang.Object
- org.apache.openjpa.meta.MetaDataRepository
- - org.apache.openjpa.jdbc.meta.MappingRepository

All Implemented Interfaces:

Serializable, PCRegistry.RegisterClassListener, Configurable, Closeable, MetaDataModes
```
public class MappingRepository
extends MetaDataRepository
```
Repository of object/relational mapping information.

Author:

Abe White

See Also:
Serialized Form

Field Summary
- Fields inherited from class org.apache.openjpa.meta.MetaDataRepository
  _locking, _preload, _preloadComplete, EMPTY_CLASSES, EMPTY_FIELDS, EMPTY_METAS, EMPTY_NON_PERSISTENT, EMPTY_ORDERS, EMPTY_XMLMETAS, VALIDATE_MAPPING, VALIDATE_META, VALIDATE_NONE, VALIDATE_RUNTIME, VALIDATE_UNENHANCED
- Fields inherited from interface org.apache.openjpa.meta.MetaDataModes
  MODE_ALL, MODE_ANN_MAPPING, MODE_MAPPING, MODE_MAPPING_INIT, MODE_META, MODE_NONE, MODE_QUERY

Constructor Summary

Constructors
Constructor and Description

MappingRepository()
Default constructor.

Constructors
Constructor and Description
`MappingRepository()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`QueryResultMapping`	`addQueryResultMapping(Class cls, String name)` Add a query result mapping.
`void`	`clear()` Clear the cache of parsed metadata.
`protected ValueHandler`	`defaultHandler(ValueMapping val)` Determine the default handler to use for the given value.
`protected ValueHandler`	`defaultHandler(ValueMapping val, boolean adapting)` Determine the default handler to use for the given value.
`protected ClassStrategy`	`defaultStrategy(ClassMapping cls)` Determine the default strategy to use for the given class.
`protected ClassStrategy`	`defaultStrategy(ClassMapping cls, boolean adapting)` Determine the default strategy to use for the given class.
`protected DiscriminatorStrategy`	`defaultStrategy(Discriminator discrim)` Determine the default strategy to use for the given discriminator.
`protected DiscriminatorStrategy`	`defaultStrategy(Discriminator discrim, boolean adapting)` Determine the default strategy to use for the given discriminator.
`protected FieldStrategy`	`defaultStrategy(FieldMapping field, boolean installHandlers)` Determine the default strategy to use for the given field.
`protected FieldStrategy`	`defaultStrategy(FieldMapping field, boolean installHandlers, boolean adapting)` Determine the default strategy to use for the given field.
`protected VersionStrategy`	`defaultStrategy(Version version)` Determine the default strategy to use for the given version.
`protected VersionStrategy`	`defaultStrategy(Version version, boolean adapting)` Determine the default strategy to use for the given version.
`protected VersionStrategy`	`defaultStrategy(Version vers, FieldMapping vfield)` Return the default version strategy, given a version field.
`protected FieldStrategy`	`defaultTypeStrategy(FieldMapping field, boolean installHandlers, boolean adapting)` Return the built-in strategy for the field's type, or null if none.
`void`	`endConfiguration()` Invoked upon completion of bean property configuration for this object.
`protected ClassMapping`	`findBaseClassMapping(ClassMapping mapping)` Finds the base class mapping for the specified mapping.
`FieldMapping`	`getBi_1ToM_JoinTableField(FieldMapping field)`
`FieldMapping`	`getBi_MTo1_JoinTableField(FieldMapping field)`
`QueryResultMapping`	`getCachedQueryResultMapping(Class cls, String name)` Return the cached query result mapping with the given name, or null if none.
`DBDictionary`	`getDBDictionary()` Convenient access to dictionary for mappings.
`ClassMapping[]`	`getImplementorMappings(Class<?> cls, ClassLoader envLoader, boolean mustExist)`
`ClassMapping`	`getMapping(Class<?> cls, ClassLoader envLoader, boolean mustExist)`
`ClassMapping`	`getMapping(Object oid, ClassLoader envLoader, boolean mustExist)`
`MappingDefaults`	`getMappingDefaults()` Mapping defaults.
`ClassMapping[]`	`getMappings()`
`QueryResultMapping`	`getQueryResultMapping(Class<?> cls, String name, ClassLoader loader, boolean mustExist)` Return the query result mapping for the given name.
`QueryResultMapping[]`	`getQueryResultMappings()` Return all cached query result mappings.
`SchemaGroup`	`getSchemaGroup()` Representation of the database schema.
`StrategyInstaller`	`getStrategyInstaller()` Installs mapping strategies on components.
`protected FieldStrategy`	`handlerCollectionStrategy(FieldMapping field, ValueHandler ehandler, boolean installHandlers)` Return the collection strategy for the given element handler, or null if none.
`protected FieldStrategy`	`handlerMapStrategy(FieldMapping field, ValueHandler khandler, ValueHandler vhandler, boolean krel, boolean vrel, boolean installHandlers)` Return the map strategy for the given key and value handlers / relations, or null if none.
`protected boolean`	`hasInheritanceStrategy(ClassMapping mapping)` Determines whether an inhertance strategy has been set on the specified mapping.
`boolean`	`hasJoinColumn(FieldMapping field)`
`boolean`	`hasJoinTable(FieldMapping field)`
`protected ClassStrategy`	`instantiateClassStrategy(String name, ClassMapping cls)` Return the strategy for the given name.
`protected DiscriminatorStrategy`	`instantiateDiscriminatorStrategy(String name, Discriminator discrim)` Instantiate the given discriminator strategy.
`protected VersionStrategy`	`instantiateVersionStrategy(Class<?> strat, Version version, String props)` Instantiate the given version strategy.
`protected VersionStrategy`	`instantiateVersionStrategy(String name, Version version)` Instantiate the given version strategy.
`boolean`	`isBi1To1JT(FieldMapping field)`
`boolean`	`isBidirectional(FieldMapping field)`
`boolean`	`isBiMTo1JT(FieldMapping field)`
`boolean`	`isNonDefaultMappingAllowed()`
`boolean`	`isUni1To1JT(FieldMapping field)`
`boolean`	`isUni1ToMFK(FieldMapping field)`
`boolean`	`isUniMTo1JT(FieldMapping field)`
`protected ValueHandler`	`namedHandler(ValueMapping val)` Instantiate the given value's named handler, or return null if no named handler.
`protected ClassStrategy`	`namedStrategy(ClassMapping cls)` Instantiate the given class' named strategy, or return null if no named strategy.
`protected DiscriminatorStrategy`	`namedStrategy(Discriminator discrim)` Instantiate the given discriminator's named strategy, or return null if no named strategy.
`protected FieldStrategy`	`namedStrategy(FieldMapping field, boolean installHandlers)` Instantiate the given field's named strategy, or return null if no named strategy.
`protected VersionStrategy`	`namedStrategy(Version version)` Instantiate the given version's named strategy, or return null if no named strategy.
`protected ClassMetaData`	`newClassMetaData(Class<?> type)` Create a new class metadata instance.
`protected ClassMetaData[]`	`newClassMetaDataArray(int length)` Create a new array of the proper class metadata subclass.
`protected Discriminator`	`newDiscriminator(ClassMapping cls)` Create discriminator metadata for the given class.
`protected ClassMetaData`	`newEmbeddedClassMetaData(ValueMetaData owner)` Create a new embedded class metadata instance.
`protected FieldMetaData`	`newFieldMetaData(String name, Class<?> type, ClassMetaData owner)` Create a new field metadata instance.
`protected FieldMetaData[]`	`newFieldMetaDataArray(int length)` Create a new array of the proper field metadata subclass.
`protected ClassMappingInfo`	`newMappingInfo(ClassMapping cls)` Create raw mapping info for the given instance.
`protected DiscriminatorMappingInfo`	`newMappingInfo(Discriminator disc)` Create raw mapping info for the given instance.
`protected FieldMappingInfo`	`newMappingInfo(FieldMapping fm)` Create raw mapping info for the given instance.
`protected ValueMappingInfo`	`newMappingInfo(ValueMapping vm)` Create raw mapping info for the given instance.
`protected VersionMappingInfo`	`newMappingInfo(Version version)` Create raw mapping info for the given instance.
`protected Order[]`	`newOrderArray(int size)` Create an array of orders of the given size.
`protected Order`	`newRelatedFieldOrder(FieldMetaData owner, FieldMetaData rel, boolean asc)` Order by a field of the related type.
`protected SequenceMetaData`	`newSequenceMetaData(String name)` Create a new sequence metadata instance.
`protected ValueMetaData`	`newValueMetaData(FieldMetaData owner)` Create a new value metadata instance.
`protected Order`	`newValueOrder(FieldMetaData owner, boolean asc)` Order by the field value.
`protected Version`	`newVersion(ClassMapping cls)` Create version metadata for the given class.
`protected void`	`prepareMapping(ClassMetaData meta)` Prepare metadata for mapping resolution.
`boolean`	`removeQueryResultMapping(Class cls, String name)` Remove a query result mapping.
`boolean`	`removeQueryResultMapping(QueryResultMapping res)` Remove a query result mapping.
`protected void`	`setDefaultInheritanceStrategy(ClassMapping mapping)` If an inheritance strategy has not been set on this mapping, set it to the default (flat).
`void`	`setMappingDefaults(MappingDefaults defaults)` Mapping default.
`void`	`setSchemaGroup(SchemaGroup schema)` Representation of the database schema.
`void`	`setStrategyInstaller(StrategyInstaller installer)` Installs mapping strategies on components.

Methods inherited from class org.apache.openjpa.meta.MetaDataRepository
addMetaData, addMetaData, addMetaData, addNonMappedInterface, addPersistenceAware, addQueryMetaData, addSequenceMetaData, addSystemListener, addXMLClassMetaData, close, getAliasNames, getCachedMetaData, getCachedMetaData, getCachedQueryMetaData, getCachedQueryMetaData, getCachedSequenceMetaData, getCachedXMLMetaData, getClosestAliasName, getConfiguration, getImplementorMetaDatas, getLog, getMetaData, getMetaData, getMetaData, getMetaDataFactory, getMetaDatas, getMetaModel, getMetaModel, getNonMappedInterface, getNonMappedInterfaces, getOrderByField, getPersistenceAware, getPersistenceAwares, getPersistentTypeNames, getPreload, getQueryKey, getQueryMetaData, getQueryMetaDatas, getResolve, getSequenceMetaData, getSequenceMetaDatas, getSourceMode, getSystemListeners, getValidate, getXMLMetaData, is_systemListenersActivated, loadPersistentTypes, loadPersistentTypes, needsPreload, newOrder, newQueryMetaData, newXMLClassMetaData, newXMLClassMetaDataArray, newXMLFieldMetaData, preload, register, registerAlias, removeMetaData, removeMetaData, removeNonMappedInterface, removePersistenceAware, removeQueryMetaData, removeQueryMetaData, removeSequenceMetaData, removeSequenceMetaData, removeSystemListener, searchQueryMetaDataByName, setConfiguration, setMetaDataFactory, setMetaModel, setMetaModel, setPreload, setResolve, setResolve, setSourceMode, setSourceMode, setValidate, setValidate, startConfiguration

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

Constructor Detail
- MappingRepository
```
public MappingRepository()
```
  Default constructor. Configure via Configurable.

Method Detail

getDBDictionary
```
public DBDictionary getDBDictionary()
```
Convenient access to dictionary for mappings.

getMappingDefaults

public MappingDefaults getMappingDefaults()

Mapping defaults.

setMappingDefaults

public void setMappingDefaults(MappingDefaults defaults)

Mapping default.

getSchemaGroup
```
public SchemaGroup getSchemaGroup()
```
Representation of the database schema.

setSchemaGroup
```
public void setSchemaGroup(SchemaGroup schema)
```
Representation of the database schema.

getStrategyInstaller
```
public StrategyInstaller getStrategyInstaller()
```
Installs mapping strategies on components.

setStrategyInstaller

public void setStrategyInstaller(StrategyInstaller installer)

Installs mapping strategies on components.

getQueryResultMapping

public QueryResultMapping getQueryResultMapping(Class<?> cls,
                                       String name,
                                       ClassLoader loader,
                                       boolean mustExist)

Return the query result mapping for the given name.

getQueryResultMappings
```
public QueryResultMapping[] getQueryResultMappings()
```
Return all cached query result mappings.

getCachedQueryResultMapping

public QueryResultMapping getCachedQueryResultMapping(Class cls,
                                             String name)

Return the cached query result mapping with the given name, or null if none.

addQueryResultMapping

public QueryResultMapping addQueryResultMapping(Class cls,
                                       String name)

Add a query result mapping.

removeQueryResultMapping

public boolean removeQueryResultMapping(QueryResultMapping res)

Remove a query result mapping.

removeQueryResultMapping

public boolean removeQueryResultMapping(Class cls,
                               String name)

Remove a query result mapping.

getMapping

public ClassMapping getMapping(Class<?> cls,
                      ClassLoader envLoader,
                      boolean mustExist)

getMappings
```
public ClassMapping[] getMappings()
```

getMapping

public ClassMapping getMapping(Object oid,
                      ClassLoader envLoader,
                      boolean mustExist)

getImplementorMappings

public ClassMapping[] getImplementorMappings(Class<?> cls,
                                    ClassLoader envLoader,
                                    boolean mustExist)

clear
```
public void clear()
```
Description copied from class: MetaDataRepository

Clear the cache of parsed metadata. This method also clears the internal MetaDataFactory's cache.

Overrides:

clear in class MetaDataRepository

prepareMapping
```
protected void prepareMapping(ClassMetaData meta)
```
Description copied from class: MetaDataRepository

Prepare metadata for mapping resolution. This method might map parts of the metadata that don't rely on other classes being mapped, but that other classes might rely on during their own mapping (for example, primary key fields). By default, this method only calls ClassMetaData.defineSuperclassFields(boolean).

Overrides:

prepareMapping in class MetaDataRepository

newClassMetaData
```
protected ClassMetaData newClassMetaData(Class<?> type)
```
Description copied from class: MetaDataRepository

Create a new class metadata instance.

Overrides:

newClassMetaData in class MetaDataRepository

newClassMetaDataArray
```
protected ClassMetaData[] newClassMetaDataArray(int length)
```
Description copied from class: MetaDataRepository

Create a new array of the proper class metadata subclass.

Overrides:

newClassMetaDataArray in class MetaDataRepository

newFieldMetaData

protected FieldMetaData newFieldMetaData(String name,
                             Class<?> type,
                             ClassMetaData owner)

Description copied from class: MetaDataRepository

Create a new field metadata instance.

Overrides:: newFieldMetaData in class MetaDataRepository

newFieldMetaDataArray
```
protected FieldMetaData[] newFieldMetaDataArray(int length)
```
Description copied from class: MetaDataRepository

Create a new array of the proper field metadata subclass.

Overrides:

newFieldMetaDataArray in class MetaDataRepository

newEmbeddedClassMetaData
```
protected ClassMetaData newEmbeddedClassMetaData(ValueMetaData owner)
```
Description copied from class: MetaDataRepository

Create a new embedded class metadata instance.

Overrides:

newEmbeddedClassMetaData in class MetaDataRepository

newValueMetaData
```
protected ValueMetaData newValueMetaData(FieldMetaData owner)
```
Description copied from class: MetaDataRepository

Create a new value metadata instance.

Overrides:

newValueMetaData in class MetaDataRepository

newSequenceMetaData
```
protected SequenceMetaData newSequenceMetaData(String name)
```
Description copied from class: MetaDataRepository

Create a new sequence metadata instance.

Overrides:

newSequenceMetaData in class MetaDataRepository

newValueOrder
```
protected Order newValueOrder(FieldMetaData owner,
                  boolean asc)
```
Description copied from class: MetaDataRepository

Order by the field value.

Overrides:

newValueOrder in class MetaDataRepository

newRelatedFieldOrder

protected Order newRelatedFieldOrder(FieldMetaData owner,
                         FieldMetaData rel,
                         boolean asc)

Description copied from class: MetaDataRepository

Order by a field of the related type.

Overrides:: newRelatedFieldOrder in class MetaDataRepository

newOrderArray
```
protected Order[] newOrderArray(int size)
```
Description copied from class: MetaDataRepository

Create an array of orders of the given size.

Overrides:

newOrderArray in class MetaDataRepository

newVersion

protected Version newVersion(ClassMapping cls)

Create version metadata for the given class.

newDiscriminator

protected Discriminator newDiscriminator(ClassMapping cls)

Create discriminator metadata for the given class.