Project (toplink-essentials 2.0.46 API)

java.lang.Object
- oracle.toplink.essentials.sessions.Project

All Implemented Interfaces:

Serializable, Cloneable
```
public class Project
extends Object
implements Serializable, Cloneable
```
Purpose: Maintain all of the TopLink configuration information for a system.
Responsibilities:
- Project wide parameters (name, default for use method accessing, and base filepath for other INI files)
- JDBC Login information
- Descriptors
- Validate Descriptors (instance variable & method access)
- Maintain sequencing information & other project wide parameters
- Construct valid DatabaseLogin objects for each platform (with sequence info set)
See Also:

DatabaseLogin, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map`	`aliasDescriptors` Cache the EJBQL descriptor aliases.
`protected Login`	`datasourceLogin`
`protected Vector`	`defaultReadOnlyClasses` Holds the default set of read-only classes that apply to each UnitOfWork.
`protected Map`	`descriptors`
`protected boolean`	`hasGenericHistorySupport` Cache if any descriptor has history.
`protected boolean`	`hasIsolatedClasses` Cache if any descriptor is isolated.
`protected boolean`	`hasProxyIndirection` Cache if any descriptor is using ProxyIndirection.
`protected boolean`	`isPureCMP2Project` Cache if all descriptors are CMP1/2
`protected String`	`name`
`protected Vector`	`orderedDescriptors`
`protected Map`	`sqlResultSetMappings` This a collection of 'maps' that allow users to map custom SQL to query results

Constructor Summary

Constructors
Constructor and Description
`Project()` PUBLIC: Create a new project.
`Project(DatabaseLogin login)` PUBLIC: Create a new project that will connect through JDBC using the login information.
`Project(Login login)` PUBLIC: Create a new project that will connect through the login information.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAlias(String alias, ClassDescriptor descriptor)` PUBLIC: Add an alias for the descriptor.
`void`	`addAliasesFromProject(Project project)` INTERNAL: Get the descriptors from the project, and associate the aliases for each descriptor with the descriptor.
`void`	`addDefaultReadOnlyClass(Class readOnlyClass)` PUBLIC: Add the read-only class which apply to each UnitOfWork created by default.
`void`	`addDescriptor(ClassDescriptor descriptor)` PUBLIC: Add the descriptor to the project.
`void`	`addDescriptor(ClassDescriptor descriptor, DatabaseSessionImpl session)` INTERNAL: Used by the BuilderInterface when reading a Project from INI files.
`void`	`addDescriptors(Project project, DatabaseSessionImpl session)` PUBLIC: Merge the descriptors from another project into this one.
`void`	`addDescriptors(Vector descriptors, DatabaseSessionImpl session)` INTERNAL: Add the descriptors to the session.
`void`	`addSQLResultSetMapping(SQLResultSetMapping sqlResultSetMapping)` PUBLIC: Add a named SQLResultSetMapping to this project.
`void`	`applyLogin()` INTERNAL: Default apply login implementation.
`void`	`assumeExistenceForDoesExist()` PUBLIC: Switch all descriptors to assume existence for non-null primary keys.
`void`	`checkCacheForDoesExist()` PUBLIC: Switch all descriptors to check the cache for existence.
`void`	`checkDatabaseForDoesExist()` PUBLIC: Switch all descriptors to check the database for existence.
`Object`	`clone()` INTERNAL: Clones the descriptor
`void`	`conformAllDescriptors()` PUBLIC: Set all this project's descriptors to conform all read queries within the context of the unit of work.
`void`	`convertClassNamesToClasses(ClassLoader classLoader)` INTERNAL: Convert all the class-name-based settings in this project to actual class-based settings
`DatabaseSession`	`createDatabaseSession()` PUBLIC: Factory method to create session.
`Server`	`createServerSession()` PUBLIC: Factory method to create a server session.
`Server`	`createServerSession(ConnectionPolicy defaultConnectionPolicy)` PUBLIC: Factory method to create a server session.
`Server`	`createServerSession(int min, int max)` PUBLIC: Factory method to create a server session.
`Map`	`getAliasDescriptors()` INTERNAL: Returns the alias descriptors hashtable.
`ClassDescriptor`	`getClassDescriptor(Class theClass)` PUBLIC: Return the descriptor specified for the class.
`ClassDescriptor`	`getClassDescriptorForAlias(String alias)` PUBLIC: Return the descriptor for the alias.
`Login`	`getDatasourceLogin()` PUBLIC: Return the login, the login holds any database connection information given.
`Vector`	`getDefaultReadOnlyClasses()` PUBLIC: Returns the default set of read-only classes.
`ClassDescriptor`	`getDescriptor(Class theClass)` PUBLIC: Return the descriptor specified for the class.
`ClassDescriptor`	`getDescriptorForAlias(String alias)` Deprecated. Replaced by `getClassDescriptorForAlias(String)`
`Map`	`getDescriptors()` PUBLIC: Return the descriptors.
`DatabaseLogin`	`getLogin()` INTERNAL: Return the login, the login holds any database connection information given.
`String`	`getName()` PUBLIC: get the name of the project.
`Vector`	`getOrderedDescriptors()` INTERNAL: Return the descriptors in the order added.
`SQLResultSetMapping`	`getSQLResultSetMapping(String sqlResultSetMapping)` PUBLIC: Get a named SQLResultSetMapping from this project.
`boolean`	`hasGenericHistorySupport()` INTERNAL: Answers if at least one Descriptor or Mapping had a HistoryPolicy at initialize time.
`boolean`	`hasIsolatedClasses()` INTERNAL: Return if any descriptors are isolated.
`boolean`	`hasProxyIndirection()` INTERNAL: Return if any descriptors use ProxyIndirection.
`boolean`	`isPureCMP2Project()` INTERNAL: Return if all descriptors are for CMP1 or CMP2 beans.
`void`	`setAliasDescriptors(Map aHashtable)` INTERNAL: Set the alias descriptors hashtable.
`void`	`setDatasourceLogin(Login datasourceLogin)` PUBLIC: Set the login to be used to connect to the database for this project.
`void`	`setDefaultReadOnlyClasses(Vector newValue)` PUBLIC: Set the read-only classes which apply to each UnitOfWork create by default.
`void`	`setDescriptors(Map descriptors)` INTERNAL: Set the descriptors registered with this session.
`void`	`setHasGenericHistorySupport(boolean hasGenericHistorySupport)` INTERNAL: Set to true during descriptor initialize if any descriptor has hsitory.
`void`	`setHasIsolatedClasses(boolean hasIsolatedClasses)` INTERNAL: Set to true during descriptor initialize if any descriptor is isolated.
`void`	`setHasProxyIndirection(boolean hasProxyIndirection)` INTERNAL: Set to true during descriptor initialize if any descriptor uses ProxyIndirection Determines if ProxyIndirectionPolicy.getValueFromProxy should be called.
`void`	`setIsPureCMP2Project(boolean isPureCMP2Project)` INTERNAL: Set if all descriptors are for CMP1 or CMP2 beans.
`void`	`setLogin(DatabaseLogin datasourceLogin)` PUBLIC: Set the login to be used to connect to the database for this project.
`void`	`setLogin(Login datasourceLogin)` PUBLIC: Set the login to be used to connect to the database for this project.
`void`	`setName(String name)` PUBLIC: Set the name of the project.
`void`	`setOrderedDescriptors(Vector orderedDescriptors)` INTERNAL: Set the descriptors order.
`String`	`toString()` INTERNAL:
`void`	`useCacheIdentityMap()` PUBLIC: Switch all descriptors to use the cache identity map.
`void`	`useCacheIdentityMap(int cacheSize)` PUBLIC: Switch all descriptors to use the cache identity map the size.
`void`	`useFullIdentityMap()` PUBLIC: Switch all descriptors to use the full identity map.
`void`	`useFullIdentityMap(int initialCacheSize)` PUBLIC: Switch all descriptors to use the full identity map with initial cache size.
`void`	`useNoIdentityMap()` PUBLIC: Switch all descriptors to use no identity map.
`void`	`useSoftCacheWeakIdentityMap()` PUBLIC: Switch all descriptors to use the soft cache weak identity map.
`void`	`useSoftCacheWeakIdentityMap(int cacheSize)` PUBLIC: Switch all descriptors to use the soft cache weak identity map with soft cache size.
`boolean`	`usesOptimisticLocking()` INTERNAL: Asks each descriptor if is uses optimistic locking.
`boolean`	`usesSequencing()` INTERNAL: Asks each descriptor if is uses sequencing.
`void`	`useWeakIdentityMap()` PUBLIC: Switch all descriptors to use the weak identity map.
`void`	`useWeakIdentityMap(int initialCacheSize)` PUBLIC: Switch all descriptors to use the weak identity map.

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

- Field Detail
  - name
```
protected String name
```
  - datasourceLogin
```
protected Login datasourceLogin
```
  - descriptors
```
protected Map descriptors
```
  - orderedDescriptors
```
protected Vector orderedDescriptors
```
  - defaultReadOnlyClasses
```
protected Vector defaultReadOnlyClasses
```
    Holds the default set of read-only classes that apply to each UnitOfWork.
  - aliasDescriptors
```
protected Map aliasDescriptors
```
    Cache the EJBQL descriptor aliases.
  - hasIsolatedClasses
```
protected boolean hasIsolatedClasses
```
    Cache if any descriptor is isolated. (set during initialization)
  - hasGenericHistorySupport
```
protected boolean hasGenericHistorySupport
```
    Cache if any descriptor has history. (set during initialization)
  - hasProxyIndirection
```
protected boolean hasProxyIndirection
```
    Cache if any descriptor is using ProxyIndirection. (set during initialization
  - isPureCMP2Project
```
protected boolean isPureCMP2Project
```
    Cache if all descriptors are CMP1/2
  - sqlResultSetMappings
```
protected Map sqlResultSetMappings
```
    This a collection of 'maps' that allow users to map custom SQL to query results
- Constructor Detail
  - Project
```
public Project()
```
    PUBLIC: Create a new project.
  - Project
```
public Project(Login login)
```
    PUBLIC: Create a new project that will connect through the login information. This method can be used if the project is being create in code instead of being read from a file.
  - Project
```
public Project(DatabaseLogin login)
```
    PUBLIC: Create a new project that will connect through JDBC using the login information. This method can be used if the project is being create in code instead of being read from a file.
- Method Detail
  - addDefaultReadOnlyClass
```
public void addDefaultReadOnlyClass(Class readOnlyClass)
```
    PUBLIC: Add the read-only class which apply to each UnitOfWork created by default.
  - addDescriptor
```
public void addDescriptor(ClassDescriptor descriptor)
```
    PUBLIC: Add the descriptor to the project.
  - addDescriptor
```
public void addDescriptor(ClassDescriptor descriptor,
                          DatabaseSessionImpl session)
```
    INTERNAL: Used by the BuilderInterface when reading a Project from INI files.
  - addDescriptors
```
public void addDescriptors(Vector descriptors,
                           DatabaseSessionImpl session)
```
    INTERNAL: Add the descriptors to the session. All persistent classes must have a descriptor registered for them with the session. This method allows for a batch of descriptors to be added at once so that TopLink can resolve the dependancies between the descriptors and perform initialization optimally.
  - addDescriptors
```
public void addDescriptors(Project project,
                           DatabaseSessionImpl session)
```
    PUBLIC: Merge the descriptors from another project into this one. All persistent classes must have a descriptor registered for them with the session. This method allows for a batch of descriptors to be added at once so that TopLink can resolve the dependancies between the descriptors and perform initialization optimially.
  - addSQLResultSetMapping
```
public void addSQLResultSetMapping(SQLResultSetMapping sqlResultSetMapping)
```
    PUBLIC: Add a named SQLResultSetMapping to this project. These SQLResultSetMappings can be later used by ResultSetMappingQueries to map Custom sql results to results as defined by the SQLResultSetMappings.
  - conformAllDescriptors
```
public void conformAllDescriptors()
```
    PUBLIC: Set all this project's descriptors to conform all read queries within the context of the unit of work.
  - convertClassNamesToClasses
```
public void convertClassNamesToClasses(ClassLoader classLoader)
```
    INTERNAL: Convert all the class-name-based settings in this project to actual class-based settings
    
    Parameters:
    
    classLoader -
  - assumeExistenceForDoesExist
```
public void assumeExistenceForDoesExist()
```
    PUBLIC: Switch all descriptors to assume existence for non-null primary keys.
  - checkCacheForDoesExist
```
public void checkCacheForDoesExist()
```
    PUBLIC: Switch all descriptors to check the cache for existence.
  - checkDatabaseForDoesExist
```
public void checkDatabaseForDoesExist()
```
    PUBLIC: Switch all descriptors to check the database for existence.
  - clone
```
public Object clone()
```
    INTERNAL: Clones the descriptor
    
    Overrides:
    
    clone in class Object
  - createDatabaseSession
```
public DatabaseSession createDatabaseSession()
```
    PUBLIC: Factory method to create session. This returns an implementor of the DatabaseSession interface, which can be used to login and add descriptors from other projects. The Session interface however should be used for reading and writing once connected for complete portability.
  - createServerSession
```
public Server createServerSession()
```
    PUBLIC: Factory method to create a server session. This returns an implementor of the Server interface, which can be used to login and add descriptors from other projects, configure connection pooling and acquire client sessions.
  - createServerSession
```
public Server createServerSession(int min,
                                  int max)
```
    PUBLIC: Factory method to create a server session. This returns an implementor of the Server interface, which can be used to login and add descriptors from other projects, configure connection pooling and acquire client sessions. Configure the min and max number of connections for the default pool.
  - createServerSession
```
public Server createServerSession(ConnectionPolicy defaultConnectionPolicy)
```
    PUBLIC: Factory method to create a server session. This returns an implementor of the Server interface, which can be used to login and add descriptors from other projects, configure connection pooling and acquire client sessions. Configure the default connection policy to be used. This policy is used on the "acquireClientSession()" protocol.
  - getDefaultReadOnlyClasses
```
public Vector getDefaultReadOnlyClasses()
```
    PUBLIC: Returns the default set of read-only classes.
  - getClassDescriptor
```
public ClassDescriptor getClassDescriptor(Class theClass)
```
    PUBLIC: Return the descriptor specified for the class.
  - getDescriptor
```
public ClassDescriptor getDescriptor(Class theClass)
```
    PUBLIC: Return the descriptor specified for the class.
  - getDescriptors
```
public Map getDescriptors()
```
    PUBLIC: Return the descriptors.
  - getOrderedDescriptors
```
public Vector getOrderedDescriptors()
```
    INTERNAL: Return the descriptors in the order added. Used to maitain consistent order in XML.
  - setOrderedDescriptors
```
public void setOrderedDescriptors(Vector orderedDescriptors)
```
    INTERNAL: Set the descriptors order. Used to maitain consistent order in XML.
  - getLogin
```
public DatabaseLogin getLogin()
```
    INTERNAL: Return the login, the login holds any database connection information given. This has been replaced by getDatasourceLogin to make use of the Login interface to support non-relational datasources, if DatabaseLogin API is required it will need to be cast.
  - getDatasourceLogin
```
public Login getDatasourceLogin()
```
    PUBLIC: Return the login, the login holds any database connection information given. This return the Login interface and may need to be cast to the datasource specific implementation.
  - getName
```
public String getName()
```
    PUBLIC: get the name of the project.
  - getSQLResultSetMapping
```
public SQLResultSetMapping getSQLResultSetMapping(String sqlResultSetMapping)
```
    PUBLIC: Get a named SQLResultSetMapping from this project. These SQLResultSetMappings can be used by ResultSetMappingQueries to map Custom sql results to results as defined by the SQLResultSetMappings.
  - hasGenericHistorySupport
```
public boolean hasGenericHistorySupport()
```
    INTERNAL: Answers if at least one Descriptor or Mapping had a HistoryPolicy at initialize time.
  - setDefaultReadOnlyClasses
```
public void setDefaultReadOnlyClasses(Vector newValue)
```
    PUBLIC: Set the read-only classes which apply to each UnitOfWork create by default.
  - setDescriptors
```
public void setDescriptors(Map descriptors)
```
    INTERNAL: Set the descriptors registered with this session.
  - setHasGenericHistorySupport
```
public void setHasGenericHistorySupport(boolean hasGenericHistorySupport)
```
    INTERNAL: Set to true during descriptor initialize if any descriptor has hsitory.
  - isPureCMP2Project
```
public boolean isPureCMP2Project()
```
    INTERNAL: Return if all descriptors are for CMP1 or CMP2 beans. Set to true during descriptor initialize. Allows certain optimizations to be made.
  - setIsPureCMP2Project
```
public void setIsPureCMP2Project(boolean isPureCMP2Project)
```
    INTERNAL: Set if all descriptors are for CMP1 or CMP2 beans. Set to true during descriptor initialize. Allows certain optimizations to be made.
  - hasIsolatedClasses
```
public boolean hasIsolatedClasses()
```
    INTERNAL: Return if any descriptors are isolated. Set to true during descriptor initialize if any descriptor is isolated. Determines if an isolated client session is required.
  - setHasIsolatedClasses
```
public void setHasIsolatedClasses(boolean hasIsolatedClasses)
```
    INTERNAL: Set to true during descriptor initialize if any descriptor is isolated. Determines if an isolated client session is required.
  - hasProxyIndirection
```
public boolean hasProxyIndirection()
```
    INTERNAL: Return if any descriptors use ProxyIndirection. Set to true during descriptor initialize if any descriptor uses ProxyIndirection Determines if ProxyIndirectionPolicy.getValueFromProxy should be called.
  - setHasProxyIndirection
```
public void setHasProxyIndirection(boolean hasProxyIndirection)
```
    INTERNAL: Set to true during descriptor initialize if any descriptor uses ProxyIndirection Determines if ProxyIndirectionPolicy.getValueFromProxy should be called.
  - setLogin
```
public void setLogin(DatabaseLogin datasourceLogin)
```
    PUBLIC: Set the login to be used to connect to the database for this project.
  - setLogin
```
public void setLogin(Login datasourceLogin)
```
    PUBLIC: Set the login to be used to connect to the database for this project.
  - setDatasourceLogin
```
public void setDatasourceLogin(Login datasourceLogin)
```
    PUBLIC: Set the login to be used to connect to the database for this project.
  - setName
```
public void setName(String name)
```
    PUBLIC: Set the name of the project.
  - toString
```
public String toString()
```
    INTERNAL:
    
    Overrides:
    
    toString in class Object
  - useCacheIdentityMap
```
public void useCacheIdentityMap()
```
    PUBLIC: Switch all descriptors to use the cache identity map.
  - useCacheIdentityMap
```
public void useCacheIdentityMap(int cacheSize)
```
    PUBLIC: Switch all descriptors to use the cache identity map the size.
  - useFullIdentityMap
```
public void useFullIdentityMap()
```
    PUBLIC: Switch all descriptors to use the full identity map.
  - useFullIdentityMap
```
public void useFullIdentityMap(int initialCacheSize)
```
    PUBLIC: Switch all descriptors to use the full identity map with initial cache size.
  - useNoIdentityMap
```
public void useNoIdentityMap()
```
    PUBLIC: Switch all descriptors to use no identity map.
  - useSoftCacheWeakIdentityMap
```
public void useSoftCacheWeakIdentityMap()
```
    PUBLIC: Switch all descriptors to use the soft cache weak identity map.
  - useSoftCacheWeakIdentityMap
```
public void useSoftCacheWeakIdentityMap(int cacheSize)
```
    PUBLIC: Switch all descriptors to use the soft cache weak identity map with soft cache size.
  - usesOptimisticLocking
```
public boolean usesOptimisticLocking()
```
    INTERNAL: Asks each descriptor if is uses optimistic locking.
  - usesSequencing
```
public boolean usesSequencing()
```
    INTERNAL: Asks each descriptor if is uses sequencing.
  - useWeakIdentityMap
```
public void useWeakIdentityMap()
```
    PUBLIC: Switch all descriptors to use the weak identity map.
  - useWeakIdentityMap
```
public void useWeakIdentityMap(int initialCacheSize)
```
    PUBLIC: Switch all descriptors to use the weak identity map.
  - applyLogin
```
public void applyLogin()
```
    INTERNAL: Default apply login implementation. Defined for generated subclasses that may not have a login. BUG#2669342
  - getAliasDescriptors
```
public Map getAliasDescriptors()
```
    INTERNAL: Returns the alias descriptors hashtable.
  - addAlias
```
public void addAlias(String alias,
                     ClassDescriptor descriptor)
```
    PUBLIC: Add an alias for the descriptor.
  - addAliasesFromProject
```
public void addAliasesFromProject(Project project)
```
    INTERNAL: Get the descriptors from the project, and associate the aliases for each descriptor with the descriptor.
  - getClassDescriptorForAlias
```
public ClassDescriptor getClassDescriptorForAlias(String alias)
```
    PUBLIC: Return the descriptor for the alias.
  - getDescriptorForAlias
```
public ClassDescriptor getDescriptorForAlias(String alias)
```
    Deprecated. Replaced by getClassDescriptorForAlias(String)
    
    PUBLIC: Return the descriptor for the alias.
  - setAliasDescriptors
```
public void setAliasDescriptors(Map aHashtable)
```
    INTERNAL: Set the alias descriptors hashtable.

Class Project

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

datasourceLogin

descriptors

orderedDescriptors

defaultReadOnlyClasses

aliasDescriptors

hasIsolatedClasses

hasGenericHistorySupport

hasProxyIndirection

isPureCMP2Project

sqlResultSetMappings

Constructor Detail

Project

Project

Project

Method Detail

addDefaultReadOnlyClass

addDescriptor

addDescriptor

addDescriptors

addDescriptors

addSQLResultSetMapping

conformAllDescriptors

convertClassNamesToClasses

assumeExistenceForDoesExist

checkCacheForDoesExist

checkDatabaseForDoesExist

clone

createDatabaseSession

createServerSession

createServerSession

createServerSession

getDefaultReadOnlyClasses

getClassDescriptor

getDescriptor

getDescriptors

getOrderedDescriptors

setOrderedDescriptors

getLogin

getDatasourceLogin

getName

getSQLResultSetMapping

hasGenericHistorySupport

setDefaultReadOnlyClasses

setDescriptors

setHasGenericHistorySupport

isPureCMP2Project

setIsPureCMP2Project

hasIsolatedClasses

setHasIsolatedClasses

hasProxyIndirection

setHasProxyIndirection

setLogin

setLogin

setDatasourceLogin

setName

toString

useCacheIdentityMap

useCacheIdentityMap

useFullIdentityMap

useFullIdentityMap

useNoIdentityMap

useSoftCacheWeakIdentityMap

useSoftCacheWeakIdentityMap

usesOptimisticLocking

usesSequencing

useWeakIdentityMap

useWeakIdentityMap

applyLogin

getAliasDescriptors

addAlias

addAliasesFromProject

getClassDescriptorForAlias

getDescriptorForAlias