Package org.apache.cayenne.map
Class EntityResolver
java.lang.Object
org.apache.cayenne.map.EntityResolver
- All Implemented Interfaces:
Serializable
,MappingNamespace
public class EntityResolver extends Object implements MappingNamespace, Serializable
Represents a virtual shared namespace for zero or more DataMaps. Unlike
DataMap, EntityResolver is intended to work as a runtime container of
mapping. DataMaps can be added or removed dynamically at runtime.
EntityResolver is thread-safe.
- Since:
- 1.1
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected LifecycleCallbackRegistry
callbackRegistry
protected ClassDescriptorMap
classDescriptorMap
protected EntityResolver
clientEntityResolver
protected static AtomicLong
incrementer
protected static org.slf4j.Logger
logger
protected MappingNamespace
mappingCache
protected Collection<DataMap>
maps
protected ValueObjectTypeRegistry
valueObjectTypeRegistry
-
Constructor Summary
Constructors Constructor Description EntityResolver()
Creates new empty EntityResolver.EntityResolver(Collection<DataMap> dataMaps)
Creates new EntityResolver that indexes a collection of DataMaps. -
Method Summary
Modifier and Type Method Description void
addDataMap(DataMap map)
void
applyDBLayerDefaults()
Updates missing mapping artifacts that can be guessed from other mapping information.LifecycleCallbackRegistry
getCallbackRegistry()
Returns aLifecycleCallbackRegistry
for handling callbacks.ClassDescriptor
getClassDescriptor(String entityName)
Returns ClassDescriptor for the ObjEntity matching the name.ClassDescriptorMap
getClassDescriptorMap()
Returns an object that compiles and storesClassDescriptor
instances for all entities.EntityResolver
getClientEntityResolver()
Returns ClientEntityResolver with mapping information that only includes entities available on CWS Client Tier.DataMap
getDataMap(String mapName)
Returns a DataMap matching the name.Collection<DataMap>
getDataMaps()
Returns an unmodifiable collection of DataMaps.Collection<DbEntity>
getDbEntities()
Returns all DbEntities.DbEntity
getDbEntity(String name)
Returns DbEntity for a given name, or null if no such DbEntity is found in the MappingNamespace.Embeddable
getEmbeddable(String className)
Returns anEmbeddable
matching class name or null if such Embeddable is not mapped.Collection<Embeddable>
getEmbeddables()
EntityInheritanceTree
getInheritanceTree(String entityName)
Collection<ObjEntity>
getObjEntities()
Returns all ObjEntities in the namespace.ObjEntity
getObjEntity(Class<?> entityClass)
Looks in the DataMap's that this object was created with for the ObjEntity that maps to the services the specified classObjEntity
getObjEntity(Class<?> entityClass, boolean lookupClientResolver)
Looks in the DataMap's that this object was created with for the ObjEntity that maps to the services the specified class, with option to fallback to search by name with client resolver in case entity not found.ObjEntity
getObjEntity(String name)
Returns ObjEntity for a given name, or null if no such ObjEntity is found in the MappingNamespace.ObjEntity
getObjEntity(Persistent object)
Procedure
getProcedure(String procedureName)
Returns Procedure for a given name, or null if no such Procedure is found in the MappingNamespace.Collection<Procedure>
getProcedures()
Returns all Procedures in the namespace.QueryDescriptor
getQueryDescriptor(String name)
Returns a named query or null if no query exists for a given name.Collection<QueryDescriptor>
getQueryDescriptors()
Returns all Queries in the namespace.SQLResult
getResult(String name)
Returns a named result set mapping.Collection<SQLResult>
getResults()
ValueObjectTypeRegistry
getValueObjectTypeRegistry()
void
refreshMappingCache()
Refreshes entity cache to reflect the current state of the DataMaps in the EntityResolver.void
removeDataMap(DataMap map)
void
setCallbackRegistry(LifecycleCallbackRegistry callbackRegistry)
Sets a lifecycle callbacks registry of the EntityResolver.void
setDataMaps(Collection<DataMap> maps)
void
setValueObjectTypeRegistry(ValueObjectTypeRegistry valueObjectTypeRegistry)
-
Field Details
-
logger
protected static final org.slf4j.Logger logger -
incrementer
-
maps
-
mappingCache
-
clientEntityResolver
-
classDescriptorMap
-
callbackRegistry
-
valueObjectTypeRegistry
-
-
Constructor Details
-
EntityResolver
public EntityResolver()Creates new empty EntityResolver. -
EntityResolver
Creates new EntityResolver that indexes a collection of DataMaps.
-
-
Method Details
-
applyDBLayerDefaults
public void applyDBLayerDefaults()Updates missing mapping artifacts that can be guessed from other mapping information. This implementation creates missing reverse relationships, marking newly created relationships as "runtime".- Since:
- 3.0
-
getCallbackRegistry
Returns aLifecycleCallbackRegistry
for handling callbacks. Registry is lazily initialized on first call.- Since:
- 3.0
-
setCallbackRegistry
Sets a lifecycle callbacks registry of the EntityResolver. Users rarely if ever need to call this method as Cayenne would instantiate a registry itself as needed based on mapped configuration.- Since:
- 3.0
-
getClientEntityResolver
Returns ClientEntityResolver with mapping information that only includes entities available on CWS Client Tier.- Since:
- 1.2
-
getDbEntities
Returns all DbEntities.- Specified by:
getDbEntities
in interfaceMappingNamespace
-
getObjEntities
Description copied from interface:MappingNamespace
Returns all ObjEntities in the namespace.- Specified by:
getObjEntities
in interfaceMappingNamespace
-
getEmbeddables
- Specified by:
getEmbeddables
in interfaceMappingNamespace
- Since:
- 3.0
-
getResults
- Specified by:
getResults
in interfaceMappingNamespace
- Since:
- 4.0
-
getProcedures
Description copied from interface:MappingNamespace
Returns all Procedures in the namespace.- Specified by:
getProcedures
in interfaceMappingNamespace
-
getQueryDescriptors
Description copied from interface:MappingNamespace
Returns all Queries in the namespace.- Specified by:
getQueryDescriptors
in interfaceMappingNamespace
-
getDbEntity
Description copied from interface:MappingNamespace
Returns DbEntity for a given name, or null if no such DbEntity is found in the MappingNamespace.- Specified by:
getDbEntity
in interfaceMappingNamespace
-
getObjEntity
Description copied from interface:MappingNamespace
Returns ObjEntity for a given name, or null if no such ObjEntity is found in the MappingNamespace.- Specified by:
getObjEntity
in interfaceMappingNamespace
-
getProcedure
Description copied from interface:MappingNamespace
Returns Procedure for a given name, or null if no such Procedure is found in the MappingNamespace.- Specified by:
getProcedure
in interfaceMappingNamespace
-
getQueryDescriptor
Returns a named query or null if no query exists for a given name.- Specified by:
getQueryDescriptor
in interfaceMappingNamespace
-
getEmbeddable
Description copied from interface:MappingNamespace
Returns anEmbeddable
matching class name or null if such Embeddable is not mapped.- Specified by:
getEmbeddable
in interfaceMappingNamespace
- Since:
- 3.0
-
getResult
Description copied from interface:MappingNamespace
Returns a named result set mapping.- Specified by:
getResult
in interfaceMappingNamespace
- Since:
- 3.0
-
getClassDescriptor
Returns ClassDescriptor for the ObjEntity matching the name. Returns null if no matching entity exists.- Since:
- 1.2
-
addDataMap
-
refreshMappingCache
public void refreshMappingCache()Refreshes entity cache to reflect the current state of the DataMaps in the EntityResolver.- Since:
- 4.0
-
getDataMap
Returns a DataMap matching the name. -
setDataMaps
-
getDataMaps
Returns an unmodifiable collection of DataMaps. -
getInheritanceTree
- Specified by:
getInheritanceTree
in interfaceMappingNamespace
- Since:
- 4.0
-
getObjEntity
Looks in the DataMap's that this object was created with for the ObjEntity that maps to the services the specified class- Specified by:
getObjEntity
in interfaceMappingNamespace
- Returns:
- the required ObjEntity or null if there is none that matches the specifier
- Since:
- 4.0
-
getObjEntity
Looks in the DataMap's that this object was created with for the ObjEntity that maps to the services the specified class, with option to fallback to search by name with client resolver in case entity not found.
This method can be used where entity class can be received from client.
- Parameters:
entityClass
- entity class to searchlookupClientResolver
- flag to fallback to client resolver- Returns:
- the required ObjEntity or null if there is none that matches the specifier
- Since:
- 4.0
-
getObjEntity
- Specified by:
getObjEntity
in interfaceMappingNamespace
-
removeDataMap
-
getClassDescriptorMap
Returns an object that compiles and storesClassDescriptor
instances for all entities.- Since:
- 3.0
-
getValueObjectTypeRegistry
-
setValueObjectTypeRegistry
-