oracle.dss.datautil.client
Class ManagerFactory

java.lang.Object
  |
  +--oracle.dss.datautil.client.ManagerFactory

public class ManagerFactory

extends java.lang.Object

The ManagerFactory class manages a pool of active QueryManager and MetadataManager instances.

Method Summary

InitialPersistenceManager	getInitialPersistenceManager() Retrieves the InitialPersistenceManager the ManagerFactory should use to lookup the MetadataManager object in the repository.
static ManagerFactory	getInstance() Returns the singleton instance of the ManagerFactory object.
static ManagerFactory	getInstance(InitialPersistenceManager manager) Returns the singleton instance of the ManagerFactory object and register the PersistenceManager the ManagerFactory should use to lookup the MetadataManager object in the repository.
MetadataManager	lookupMetadataManager(java.lang.String name, boolean useSharedPool) Returns a specific MetadataManager that is associated with a name.
QueryManager	lookupQueryManager(java.lang.String name, boolean useSharedPool) Returns a specific QueryManager that is associated with a name.
void	setCreatePersistenceConnection(boolean createConnection) Sets whether a Persistence connection should be created.
void	setInitialPersistenceManager(InitialPersistenceManager manager) Sets the InitialPersistenceManager the ManagerFactory should use to lookup the MetadataManager object in the repository.
void	setManagerFolderPath(java.lang.String path) Sets the default path of where the persisted MetadataManager objects are located.
void	setPersistenceConnection(java.lang.String path) Sets the default path of the PersistenceManager to use when an aggregated persistence connection is created

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setInitialPersistenceManager

public void setInitialPersistenceManager(InitialPersistenceManager manager)

Sets the InitialPersistenceManager the ManagerFactory should use to lookup the MetadataManager object in the repository.

Parameters:

manager - the PersistenceManager instance to use to lookup the object in the repository.

getInitialPersistenceManager

public InitialPersistenceManager getInitialPersistenceManager()

Retrieves the InitialPersistenceManager the ManagerFactory should use to lookup the MetadataManager object in the repository.

Returns:

The PersistenceManager instance to use to lookup the object in the repository.

setManagerFolderPath

public void setManagerFolderPath(java.lang.String path)

Sets the default path of where the persisted MetadataManager objects are located.

Parameters:

path - The path relative to the root folder of where the persisted MetadataManager objects are located. The value cannot be null. If this is not specified, the root path is used.

setCreatePersistenceConnection

public void setCreatePersistenceConnection(boolean createConnection)

Sets whether a Persistence connection should be created.

Parameters:

createConnection - if true then a persistence connection will be created based on the existing connection as specified in setPersistenceConnection. Otherwise the connection is not created.

setPersistenceConnection

public void setPersistenceConnection(java.lang.String path)

Sets the default path of the PersistenceManager to use when an aggregated persistence connection is created

Parameters:

path - The path relative to the root folder of the PersistenceManager to use when an aggregated persistence connection is created. The value cannot be null. If this is not specified, the root path is used.

getInstance

public static ManagerFactory getInstance(InitialPersistenceManager manager)

Returns the singleton instance of the ManagerFactory object and register the PersistenceManager the ManagerFactory should use to lookup the MetadataManager object in the repository.

Parameters:

manager - the PersistenceManager instance to use to lookup the object in the repository.

Returns:

An instance of the ManagerFactory object.

getInstance

public static ManagerFactory getInstance()

Returns the singleton instance of the ManagerFactory object.

Returns:

An instance of the ManagerFactory object.

lookupQueryManager

public QueryManager lookupQueryManager(java.lang.String name,
                                       boolean useSharedPool)
                                throws ManagerFactoryException

Returns a specific QueryManager that is associated with a name.

Parameters:

name - The name of the QueryManager. This is in effect the name bind to the MetadataManager that is going to be associated with the QueryManager.

useSharedPool - if true, then ManagerFactory will attempt to find the QueryManager from the pool first before it attempts to load it from the repository. And it will register the resulting QueryManager to the pool, if it doesn't already exists. otherwise if false, then a new QueryManager will always be created and returned. And the newly created instance is not registered to the pool.

Returns:

An instance of QueryManager that is associated with that name.

Throws:

ManagerFactoryException - if an error occurred while loading the QueryManager.

lookupMetadataManager

public MetadataManager lookupMetadataManager(java.lang.String name,
                                             boolean useSharedPool)
                                      throws ManagerFactoryException

Returns a specific MetadataManager that is associated with a name.

Parameters:

name - The name of the MetadataManager, which is the name of the MetadataManager stored within the repository under a predefined path.

useSharedPool - if true, then ManagerFactory will attempt to find the QueryManager from the pool first and returns the associated MetadataManager before it attempts to load it from the repository. And it will register the resulting QueryManager to the pool, if it doesn't already exists. otherwise if false, then a new QueryManager ( and MetadataManager) will always be created and returned. And the newly created instance is not registered to the pool.

Returns:

An instance of the MetadataManager that is associated with that name.

Throws:

ManagerFactoryException - if an error occurred while loading the MetadataManager.