Skip navigation links

oracle.toplink.sessions
Class Project

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

PersistenceProject

public class Project

extends java.lang.Object

implements java.io.Serializable, java.lang.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

Constructor Summary

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

void	addAlias(java.lang.String alias, Descriptor descriptor) PUBLIC: Add an alias for the descriptor.
void	addDefaultReadOnlyClass(java.lang.Class readOnlyClass) PUBLIC: Add the read-only class which apply to each UnitOfWork created by default.
void	addDescriptor(Descriptor descriptor) PUBLIC: Add the descriptor to the project.
void	addDescriptors(Project project, DatabaseSession session) PUBLIC: Merge the descriptors from another project into this one.
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.
void	conformAllDescriptors() PUBLIC: Set all this project's descriptors to conform all read queries within the context of the unit of work.
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.
ClassDescriptor	getClassDescriptor(java.lang.Class theClass) PUBLIC: Return the descriptor specified for the class.
ClassDescriptor	getClassDescriptorForAlias(java.lang.String alias) PUBLIC: Return the descriptor for the alias
Login	getDatasourceLogin() PUBLIC: Return the login, the login holds any database connection information given.
java.util.Vector	getDefaultReadOnlyClasses() PUBLIC: Returns the default set of read-only classes.
Descriptor	getDescriptor(java.lang.Class theClass) Deprecated. Replaced by getClassDescriptor(Class)
Descriptor	getDescriptorForAlias(java.lang.String alias) Deprecated. Replaced by getClassDescriptorForAlias(String)
java.util.Map	getDescriptors() PUBLIC: Return the descriptors.
DatabaseLogin	getLogin() OBSOLETE: Return the login, the login holds any database connection information given.
java.lang.String	getName() PUBLIC: get the name of the project.
java.lang.String	getSequenceCounterName() OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
java.lang.String	getSequenceFieldName() OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
java.lang.Integer	getSequencePreallocationSize() OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
java.lang.String	getSequenceTableName() OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
boolean	getUseNativeSequencing() OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
void	setDatasourceLogin(Login datasourceLogin) PUBLIC: Set the login to be used to connect to the database for this project.
void	setDefaultReadOnlyClasses(java.util.Vector newValue) PUBLIC: Set the read-only classes which apply to each UnitOfWork create by default.
void	setDeferModificationsUntilCommit(int deferralLevel) ADVANCED: This method is a 'helper' method for updating all of the descriptors within this project to have a particular deferral level.
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	setLoginAndApplySequenceProperties(DatabaseLogin login) OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
void	setName(java.lang.String name) PUBLIC: Set the name of the project.
void	setSequenceCounterName(java.lang.String counterFieldName) OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
void	setSequenceFieldName(java.lang.String fieldName) OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
void	setSequencePreallocationSize(int size) OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
void	setSequencePreallocationSize(java.lang.Integer size) OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
void	setSequenceTableName(java.lang.String tableName) OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
void	setUseNativeSequencing(boolean useNative) OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.
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.
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, getClass, hashCode, notify, notifyAll, wait, wait, wait

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(java.lang.Class readOnlyClass)

PUBLIC: Add the read-only class which apply to each UnitOfWork created by default.

addDescriptor

public void addDescriptor(Descriptor descriptor)

PUBLIC: Add the descriptor to the project.

addDescriptors

public void addDescriptors(Project project,
                           DatabaseSession 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.

conformAllDescriptors

public void conformAllDescriptors()

PUBLIC: Set all this project's descriptors to conform all read queries within the context of the unit of work.

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.

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 java.util.Vector getDefaultReadOnlyClasses()

PUBLIC: Returns the default set of read-only classes.

getClassDescriptor

public ClassDescriptor getClassDescriptor(java.lang.Class theClass)

PUBLIC: Return the descriptor specified for the class.

getDescriptor

public Descriptor getDescriptor(java.lang.Class theClass)

Deprecated. Replaced by getClassDescriptor(Class)

OBSOLETE:

getDescriptors

public java.util.Map getDescriptors()

PUBLIC: Return the descriptors.

getLogin

public DatabaseLogin getLogin()

OBSOLETE: 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 java.lang.String getName()

PUBLIC: get the name of the project.

getSequenceCounterName

public java.lang.String getSequenceCounterName()

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

getSequenceFieldName

public java.lang.String getSequenceFieldName()

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

getSequencePreallocationSize

public java.lang.Integer getSequencePreallocationSize()

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

getSequenceTableName

public java.lang.String getSequenceTableName()

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

getUseNativeSequencing

public boolean getUseNativeSequencing()

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

setDefaultReadOnlyClasses

public void setDefaultReadOnlyClasses(java.util.Vector newValue)

PUBLIC: Set the read-only classes which apply to each UnitOfWork create by default.

setDeferModificationsUntilCommit

public void setDeferModificationsUntilCommit(int deferralLevel)

ADVANCED: This method is a 'helper' method for updating all of the descriptors within this project to have a particular deferral level. The levels are as follows Descriptor.ALL_MODIFICATIONS - this is the default and recommended. The writing of all changes will be deferred until the end of the transaction Descriptor.UPDATE_MODIFICATIONS - this will cause the update changes to be deferred and all other changes to be written immediately. Descriptor.NONE - this will cause all changes to be written on each container call.

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.

setLoginAndApplySequenceProperties

public void setLoginAndApplySequenceProperties(DatabaseLogin login)

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

setName

public void setName(java.lang.String name)

PUBLIC: Set the name of the project.

setSequenceCounterName

public void setSequenceCounterName(java.lang.String counterFieldName)

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

setSequenceFieldName

public void setSequenceFieldName(java.lang.String fieldName)

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

setSequencePreallocationSize

public void setSequencePreallocationSize(int size)

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

setSequencePreallocationSize

public void setSequencePreallocationSize(java.lang.Integer size)

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

setSequenceTableName

public void setSequenceTableName(java.lang.String tableName)

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

setUseNativeSequencing

public void setUseNativeSequencing(boolean useNative)

OBSOLETE: Left over from MW 2.5 project class generation, should no longer be used.

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.

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.

addAlias

public void addAlias(java.lang.String alias,
                     Descriptor descriptor)

PUBLIC: Add an alias for the descriptor.

getClassDescriptorForAlias

public ClassDescriptor getClassDescriptorForAlias(java.lang.String alias)

PUBLIC: Return the descriptor for the alias

getDescriptorForAlias

public Descriptor getDescriptorForAlias(java.lang.String alias)

Deprecated. Replaced by getClassDescriptorForAlias(String)

OBSOLETE:

Skip navigation links