org.apache.cayenne.access
Class DataDomain

java.lang.Object
  extended by org.apache.cayenne.access.DataDomain
All Implemented Interfaces:
QueryEngine, DataChannel

public class DataDomain
extends Object
implements QueryEngine, DataChannel

DataDomain performs query routing functions in Cayenne. DataDomain creates single data source abstraction hiding multiple physical data sources from the user. When a child DataContext sends a query to the DataDomain, it is transparently routed to an appropriate DataNode.


Field Summary
static String DATA_CONTEXT_FACTORY_PROPERTY
          Defines a property name for storing an optional DataContextFactory.
protected  DataContextFactory dataContextFactory
           
protected  EntityResolver entityResolver
           
protected  EventManager eventManager
           
protected  String name
           
protected  Map<String,DataNode> nodes
          Stores mapping of data nodes to DataNode name keys.
protected  Map<String,DataNode> nodesByDataMapName
           
protected  Map<String,String> properties
          Properties configured for DataDomain.
static String QUERY_CACHE_FACTORY_PROPERTY
          Defines a property name for storing optional QueryCacheFactory.
protected  QueryCache queryCache
           
protected  QueryCacheFactory queryCacheFactory
           
static boolean SHARED_CACHE_ENABLED_DEFAULT
           
static String SHARED_CACHE_ENABLED_PROPERTY
           
protected  boolean sharedCacheEnabled
           
protected  DataRowStore sharedSnapshotCache
           
protected  boolean stopped
           
protected  TransactionDelegate transactionDelegate
           
static boolean USING_EXTERNAL_TRANSACTIONS_DEFAULT
           
static String USING_EXTERNAL_TRANSACTIONS_PROPERTY
           
protected  boolean usingExternalTransactions
           
static boolean VALIDATING_OBJECTS_ON_COMMIT_DEFAULT
           
static String VALIDATING_OBJECTS_ON_COMMIT_PROPERTY
           
protected  boolean validatingObjectsOnCommit
           
 
Fields inherited from interface org.apache.cayenne.DataChannel
FLUSH_CASCADE_SYNC, FLUSH_NOCASCADE_SYNC, GRAPH_CHANGED_SUBJECT, GRAPH_FLUSHED_SUBJECT, GRAPH_ROLLEDBACK_SUBJECT, ROLLBACK_CASCADE_SYNC
 
Constructor Summary
DataDomain(String name)
          Creates a DataDomain and assigns it a name.
DataDomain(String name, Map properties)
          Creates new DataDomain.
 
Method Summary
 void addMap(DataMap map)
          Registers new DataMap with this domain.
 void addNode(DataNode node)
          Adds new DataNode.
protected  void checkStopped()
          Checks that Domain is not stopped.
 void clearDataMaps()
          Clears the list of internal DataMaps.
 DataContext createDataContext()
          Creates and returns a new DataContext.
 DataContext createDataContext(boolean useSharedCache)
          Creates a new DataContext.
 Transaction createTransaction()
          Creates and returns a new inactive transaction.
 DataContextFactory getDataContextFactory()
           
 Collection<DataMap> getDataMaps()
          Returns a collection of registered DataMaps.
 Collection<DataNode> getDataNodes()
          Returns an unmodifiable collection of DataNodes associated with this domain.
 EntityResolver getEntityResolver()
          Returns an EntityResolver that stores mapping information for this domain.
 EventManager getEventManager()
          Returns EventManager used by this DataDomain.
 DataMap getMap(String mapName)
          Returns DataMap matching name parameter.
 String getName()
          Returns "name" property value.
 DataNode getNode(String nodeName)
          Returns registered DataNode whose name matches name parameter.
 Map<String,String> getProperties()
           
 BatchQueryBuilderFactory getQueryBuilderFactory()
           
 QueryCache getQueryCache()
          Returns shared QueryCache used by this DataDomain, creating it on the fly if needed.
 QueryCacheFactory getQueryCacheFactory()
          Returns a non-null QueryCacheFactory.
 DataRowStore getSharedSnapshotCache()
          Returns snapshots cache for this DataDomain, lazily initializing it on the first call if 'sharedCacheEnabled' flag is true.
 TransactionDelegate getTransactionDelegate()
           
 void initWithProperties(Map<String,String> properties)
          Reinitializes domain state with a new set of properties.
 boolean isSharedCacheEnabled()
          Returns true if DataContexts produced by this DataDomain are using shared DataRowStore.
 boolean isUsingExternalTransactions()
          Returns whether this DataDomain should internally commit all transactions, or let container do that.
 boolean isValidatingObjectsOnCommit()
          Returns whether child DataContexts default behavior is to perform object validation before commit is executed.
 DataNode lookupDataNode(DataMap map)
          Returns a DataNode that should handle queries for all entities in a DataMap.
 QueryResponse onQuery(ObjectContext context, Query query)
          Runs query returning generic QueryResponse.
 GraphDiff onSync(ObjectContext originatingContext, GraphDiff changes, int syncType)
          Only handles commit-type synchronization, ignoring any other type.
 void performQueries(Collection<Query> queries, OperationObserver callback)
          Routes queries to appropriate DataNodes for execution.
 void reindexNodes()
          Updates internal index of DataNodes stored by the entity name.
 void removeDataNode(String nodeName)
          Removes a DataNode from DataDomain.
 void removeMap(String mapName)
          Removes named DataMap from this DataDomain and any underlying DataNodes that include it.
 void reset()
          Closes all data nodes, removes them from the list of available nodes.
protected  void resetProperties()
           
 void setDataContextFactory(DataContextFactory dataContextFactory)
           
 void setEntityResolver(EntityResolver entityResolver)
          Sets EntityResolver.
 void setEventManager(EventManager eventManager)
          Sets EventManager used by this DataDomain.
 void setName(String name)
          Sets "name" property to a new value.
 void setQueryBuilderFactory(BatchQueryBuilderFactory queryBuilderFactory)
          Sets factory for creating QueryBuilders
 void setQueryCacheFactory(QueryCacheFactory queryCacheFactory)
           
 void setSharedCacheEnabled(boolean sharedCacheEnabled)
           
 void setSharedSnapshotCache(DataRowStore snapshotCache)
          Shuts down the previous cache instance, sets cache to the new DataSowStore instance and updates two properties of the new DataSowStore: name and eventManager.
 void setTransactionDelegate(TransactionDelegate transactionDelegate)
          Initializes TransactionDelegate used by all DataContexts associated with this DataDomain.
 void setUsingExternalTransactions(boolean flag)
          Sets a property defining whether this DataDomain should internally commit all transactions, or let container do that.
 void setValidatingObjectsOnCommit(boolean flag)
          Sets the property defining whether child DataContexts should perform object validation before commit is executed.
 void shutdown()
          Shutdowns all owned data nodes and marks this domain as stopped.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SHARED_CACHE_ENABLED_PROPERTY

public static final String SHARED_CACHE_ENABLED_PROPERTY
See Also:
Constant Field Values

SHARED_CACHE_ENABLED_DEFAULT

public static final boolean SHARED_CACHE_ENABLED_DEFAULT
See Also:
Constant Field Values

VALIDATING_OBJECTS_ON_COMMIT_PROPERTY

public static final String VALIDATING_OBJECTS_ON_COMMIT_PROPERTY
See Also:
Constant Field Values

VALIDATING_OBJECTS_ON_COMMIT_DEFAULT

public static final boolean VALIDATING_OBJECTS_ON_COMMIT_DEFAULT
See Also:
Constant Field Values

USING_EXTERNAL_TRANSACTIONS_PROPERTY

public static final String USING_EXTERNAL_TRANSACTIONS_PROPERTY
See Also:
Constant Field Values

USING_EXTERNAL_TRANSACTIONS_DEFAULT

public static final boolean USING_EXTERNAL_TRANSACTIONS_DEFAULT
See Also:
Constant Field Values

DATA_CONTEXT_FACTORY_PROPERTY

public static final String DATA_CONTEXT_FACTORY_PROPERTY
Defines a property name for storing an optional DataContextFactory.

Since:
1.2
See Also:
Constant Field Values

QUERY_CACHE_FACTORY_PROPERTY

public static final String QUERY_CACHE_FACTORY_PROPERTY
Defines a property name for storing optional QueryCacheFactory.

Since:
3.0
See Also:
Constant Field Values

nodes

protected Map<String,DataNode> nodes
Stores mapping of data nodes to DataNode name keys.


nodesByDataMapName

protected Map<String,DataNode> nodesByDataMapName

properties

protected Map<String,String> properties
Properties configured for DataDomain. These include properties of the DataRowStore and remote notifications.


entityResolver

protected EntityResolver entityResolver

sharedSnapshotCache

protected DataRowStore sharedSnapshotCache

transactionDelegate

protected TransactionDelegate transactionDelegate

dataContextFactory

protected DataContextFactory dataContextFactory

queryCacheFactory

protected QueryCacheFactory queryCacheFactory

name

protected String name

sharedCacheEnabled

protected boolean sharedCacheEnabled

validatingObjectsOnCommit

protected boolean validatingObjectsOnCommit

usingExternalTransactions

protected boolean usingExternalTransactions

eventManager

protected EventManager eventManager
Since:
1.2

queryCache

protected QueryCache queryCache
Since:
3.0

stopped

protected boolean stopped
Constructor Detail

DataDomain

public DataDomain(String name)
Creates a DataDomain and assigns it a name.


DataDomain

public DataDomain(String name,
                  Map properties)
Creates new DataDomain.

Parameters:
name - DataDomain name. Domain can be located using its name in the Configuration object.
properties - A Map containing domain configuration properties.
Method Detail

checkStopped

protected void checkStopped()
                     throws DomainStoppedException
Checks that Domain is not stopped. Throws DomainStoppedException otherwise.

Throws:
DomainStoppedException
Since:
3.0

resetProperties

protected void resetProperties()
Since:
1.1

initWithProperties

public void initWithProperties(Map<String,String> properties)
Reinitializes domain state with a new set of properties.

Since:
1.1

getEventManager

public EventManager getEventManager()
Returns EventManager used by this DataDomain.

Specified by:
getEventManager in interface DataChannel
Since:
1.2

setEventManager

public void setEventManager(EventManager eventManager)
Sets EventManager used by this DataDomain.

Since:
1.2

getName

public String getName()
Returns "name" property value.


setName

public void setName(String name)
Sets "name" property to a new value.


isSharedCacheEnabled

public boolean isSharedCacheEnabled()
Returns true if DataContexts produced by this DataDomain are using shared DataRowStore. Returns false if each DataContext would work with its own DataRowStore. Note that this setting can be overwritten per DataContext. See createDataContext(boolean).


setSharedCacheEnabled

public void setSharedCacheEnabled(boolean sharedCacheEnabled)

isValidatingObjectsOnCommit

public boolean isValidatingObjectsOnCommit()
Returns whether child DataContexts default behavior is to perform object validation before commit is executed.

Since:
1.1

setValidatingObjectsOnCommit

public void setValidatingObjectsOnCommit(boolean flag)
Sets the property defining whether child DataContexts should perform object validation before commit is executed.

Since:
1.1

isUsingExternalTransactions

public boolean isUsingExternalTransactions()
Returns whether this DataDomain should internally commit all transactions, or let container do that.

Since:
1.1

setUsingExternalTransactions

public void setUsingExternalTransactions(boolean flag)
Sets a property defining whether this DataDomain should internally commit all transactions, or let container do that.

Since:
1.1

getProperties

public Map<String,String> getProperties()
Returns:
a Map of properties for this DataDomain. There is no guarantees of specific synchronization behavior of this map.
Since:
1.1

getTransactionDelegate

public TransactionDelegate getTransactionDelegate()
Returns:
TransactionDelegate associated with this DataDomain, or null if no delegate exist.
Since:
1.1

setTransactionDelegate

public void setTransactionDelegate(TransactionDelegate transactionDelegate)
Initializes TransactionDelegate used by all DataContexts associated with this DataDomain.

Since:
1.1

getSharedSnapshotCache

public DataRowStore getSharedSnapshotCache()
Returns snapshots cache for this DataDomain, lazily initializing it on the first call if 'sharedCacheEnabled' flag is true.


setSharedSnapshotCache

public void setSharedSnapshotCache(DataRowStore snapshotCache)
Shuts down the previous cache instance, sets cache to the new DataSowStore instance and updates two properties of the new DataSowStore: name and eventManager.


getDataContextFactory

public DataContextFactory getDataContextFactory()

setDataContextFactory

public void setDataContextFactory(DataContextFactory dataContextFactory)

addMap

public void addMap(DataMap map)
Registers new DataMap with this domain.


getMap

public DataMap getMap(String mapName)
Returns DataMap matching name parameter.


removeMap

public void removeMap(String mapName)
Removes named DataMap from this DataDomain and any underlying DataNodes that include it.


removeDataNode

public void removeDataNode(String nodeName)
Removes a DataNode from DataDomain. Any maps previously associated with this node within domain will still be kept around, however they wan't be mapped to any node.


getDataMaps

public Collection<DataMap> getDataMaps()
Returns a collection of registered DataMaps.


getDataNodes

public Collection<DataNode> getDataNodes()
Returns an unmodifiable collection of DataNodes associated with this domain.


reset

public void reset()
Closes all data nodes, removes them from the list of available nodes.


clearDataMaps

public void clearDataMaps()
Clears the list of internal DataMaps. In most cases it is wise to call "reset" before doing that.


addNode

public void addNode(DataNode node)
Adds new DataNode.


createDataContext

public DataContext createDataContext()
Creates and returns a new DataContext. If this DataDomain is configured to use shared cache, returned DataContext will use shared cache as well. Otherwise a new instance of DataRowStore will be used as its local cache.


createDataContext

public DataContext createDataContext(boolean useSharedCache)
Creates a new DataContext.

Parameters:
useSharedCache - determines whether resulting DataContext should use shared vs. local cache. This setting overrides default behavior configured for this DataDomain via SHARED_CACHE_ENABLED_PROPERTY.
Since:
1.1

createTransaction

public Transaction createTransaction()
Creates and returns a new inactive transaction. Returned transaction is bound to the current execution thread.

If there is a TransactionDelegate, adds the delegate to the newly created Transaction. Behavior of the returned Transaction depends on "usingInternalTransactions" property setting.

Since:
1.1

getNode

public DataNode getNode(String nodeName)
Returns registered DataNode whose name matches name parameter.


reindexNodes

public void reindexNodes()
Updates internal index of DataNodes stored by the entity name.


lookupDataNode

public DataNode lookupDataNode(DataMap map)
Returns a DataNode that should handle queries for all entities in a DataMap.

Since:
1.1

setEntityResolver

public void setEntityResolver(EntityResolver entityResolver)
Sets EntityResolver. If not set explicitly, DataDomain creates a default EntityResolver internally on demand.

Since:
1.1

shutdown

public void shutdown()
Shutdowns all owned data nodes and marks this domain as stopped.


performQueries

public void performQueries(Collection<Query> queries,
                           OperationObserver callback)
Routes queries to appropriate DataNodes for execution.

Specified by:
performQueries in interface QueryEngine

onQuery

public QueryResponse onQuery(ObjectContext context,
                             Query query)
Runs query returning generic QueryResponse.

Specified by:
onQuery in interface DataChannel
Parameters:
context - an ObjectContext that originated the query, used to register result objects.
Returns:
a generic response object that encapsulates result of the execution.
Since:
1.2

getEntityResolver

public EntityResolver getEntityResolver()
Returns an EntityResolver that stores mapping information for this domain.

Specified by:
getEntityResolver in interface QueryEngine
Specified by:
getEntityResolver in interface DataChannel

onSync

public GraphDiff onSync(ObjectContext originatingContext,
                        GraphDiff changes,
                        int syncType)
Only handles commit-type synchronization, ignoring any other type.

Specified by:
onSync in interface DataChannel
Parameters:
originatingContext - an ObjectContext that initiated the sync. Can be null.
changes - diff from the context that initiated the sync.
syncType - One of DataChannel.FLUSH_NOCASCADE_SYNC, DataChannel.FLUSH_CASCADE_SYNC, DataChannel.ROLLBACK_CASCADE_SYNC.
Since:
1.2

toString

public String toString()
Overrides:
toString in class Object

getQueryCacheFactory

public QueryCacheFactory getQueryCacheFactory()
Returns a non-null QueryCacheFactory.

Since:
3.0

setQueryCacheFactory

public void setQueryCacheFactory(QueryCacheFactory queryCacheFactory)
Since:
3.0

getQueryCache

public QueryCache getQueryCache()
Returns shared QueryCache used by this DataDomain, creating it on the fly if needed. Uses factory obtained via getQueryCacheFactory() to initialize the cache for the first time. This domain properties are passed to the QueryCacheFactory.getQueryCache(Map) method.

Since:
3.0

setQueryBuilderFactory

public void setQueryBuilderFactory(BatchQueryBuilderFactory queryBuilderFactory)
Sets factory for creating QueryBuilders


getQueryBuilderFactory

public BatchQueryBuilderFactory getQueryBuilderFactory()
Returns:
factory for creating QueryBuilders. Might be null


Copyright © 2001-2011 Apache Cayenne. All Rights Reserved.