oracle.toplink.ejb
Class EJBDataStore

java.lang.Object
  |
  +--oracle.toplink.ejb.EJBDataStore

public class EJBDataStore

extends java.lang.Object

Purpose: Implement the EJB entity bean BMP/CMP APIs.

Description: This class maps the EJB entity bean APIs to TopLink APIs. It can be used from a BMP base class or from a CMP persister in compatible EJB servers.

Responsibilities:

• Create
• Store
• Remove
• Load
• Finders

Since:

TOPLink/Java 3.0

Constructor Summary

EJBDataStore()
Create a new data store.

Method Summary

Type	Method
java.lang.Object	create(oracle.toplink.ejb.EntityBean bean) PUBLIC: Insert the bean into the database.
java.lang.Object	create(java.lang.Object bean) PUBLIC: Insert the bean into the database.
java.util.Enumeration	findAll() PUBLIC: Read all the objects for the class and load them into the cache.
java.util.Enumeration	findAll(Call call) Read all the objects for the class given the call and load them into the cache.
java.util.Enumeration	findAll(Expression expression) PUBLIC: Read all the objects for the class given the expression and load them into the cache.
java.util.Enumeration	findAll(ReadAllQuery query) PUBLIC: Read all the objects for the class given the query and load them into the cache.
java.util.Enumeration	findAllByNamedQuery(java.lang.String queryName, java.util.Vector arguments) Read all the objects for the class given the query and load them into the cache.
java.util.Vector	findAllObjects(ReadAllQuery query) PUBLIC: Read all the objects for the class given the query and load them into the cache.
java.util.Vector	findAllObjectsByNamedQuery(java.lang.String queryName, java.util.Vector arguments) PUBLIC: Read all the objects for the class given the query and load them into the cache.
java.lang.Object	findByPrimaryKey(java.lang.Object primaryKeyObject) PUBLIC: Find the object by primary key object and load it into the cache.
java.lang.Object	findObject(ReadObjectQuery query) PUBLIC: Find the object by the query and load it into the cache.
java.lang.Object	findObjectByNamedQuery(java.lang.String queryName, java.util.Vector arguments) PUBLIC: Find the object by the query and load it into the cache.
java.lang.Object	findOne(Call call) PUBLIC: Find the object by the query and load it into the cache.
java.lang.Object	findOne(Expression expression) PUBLIC: Find the object by the query and load it into the cache.
java.lang.Object	findOne(ReadObjectQuery query) PUBLIC: Find the object by the query and load it into the cache.
java.lang.Object	findOneByNamedQuery(java.lang.String queryName, java.util.Vector arguments) PUBLIC: Find the object by the query and load it into the cache.
Session	getActiveSession() PUBLIC: Return the session or unit of work if in a transaction.
UnitOfWork	getActiveUnitOfWork() PUBLIC: Return the unit of work in the transaction context.
java.lang.Class	getBeanClass() PUBLIC: Return the bean class.
Session	getSession() ADVANCED: Return the session.
java.lang.String	getSessionName() PUBLIC: Return the session name.
XMLLoader	getXMLLoader() PUBLIC: Return the XMLLoader for this datastore.
void	load(java.lang.Object bean) PUBLIC: Load from the database/cache into the object.
void	remove(oracle.toplink.ejb.EntityBean bean) PUBLIC: Delete the bean from the database.
void	remove(java.lang.Object bean) PUBLIC: Delete the bean from the database.
void	setBeanClass(java.lang.Class beanClass) REQUIRED: Set the bean class for the data store.
void	setSession(Session session) PUBLIC: Set the session.
void	setSessionName(java.lang.String sessionName) PUBLIC: Set the session name.
void	setXMLLoader(XMLLoader xmlLoader) PUBLIC: Set the XML Loader that will be used to load the session configuration information.
void	store(oracle.toplink.ejb.EntityBean bean) PUBLIC: Update the bean into the database.
void	store(java.lang.Object bean) PUBLIC: Update the bean into the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

EJBDataStore

public EJBDataStore()

Create a new data store. By default use the default session.

Method Detail

create

public java.lang.Object create(java.lang.Object bean)
                        throws oracle.toplink.ejb.CreateException

PUBLIC: Insert the bean into the database. This registers it with the active unit of work for insertion on commit. If using sequencing (not sybase natvie) the sequence number will be assigned.

create

public java.lang.Object create(oracle.toplink.ejb.EntityBean bean)
                        throws oracle.toplink.ejb.CreateException

PUBLIC: Insert the bean into the database.

findAll

public java.util.Enumeration findAll()
                              throws oracle.toplink.ejb.FinderException

PUBLIC: Read all the objects for the class and load them into the cache. Return an enumeration on the primary key objects as per the BMP spec.

findAll

public java.util.Enumeration findAll(Expression expression)
                              throws oracle.toplink.ejb.FinderException

PUBLIC: Read all the objects for the class given the expression and load them into the cache. Return an enumeration on the primary key objects as per the BMP spec.

findAll

public java.util.Enumeration findAll(Call call)
                              throws oracle.toplink.ejb.FinderException

Read all the objects for the class given the call and load them into the cache. Return an enumeration on the primary key objects as per the BMP spec.

findAll

public java.util.Enumeration findAll(ReadAllQuery query)
                              throws oracle.toplink.ejb.FinderException

PUBLIC: Read all the objects for the class given the query and load them into the cache. Return an enumeration on the primary key objects as per the BMP spec.

findAllByNamedQuery

public java.util.Enumeration findAllByNamedQuery(java.lang.String queryName,
                                                 java.util.Vector arguments)
                                          throws oracle.toplink.ejb.FinderException

Read all the objects for the class given the query and load them into the cache. Return an enumeration on the primary key objects as per the BMP spec.

findAllObjects

public java.util.Vector findAllObjects(ReadAllQuery query)
                                throws oracle.toplink.ejb.FinderException

PUBLIC: Read all the objects for the class given the query and load them into the cache. Return a vector of the objects.

findAllObjectsByNamedQuery

public java.util.Vector findAllObjectsByNamedQuery(java.lang.String queryName,
                                                   java.util.Vector arguments)
                                            throws oracle.toplink.ejb.FinderException

PUBLIC: Read all the objects for the class given the query and load them into the cache. Return a vector of the objects.

findByPrimaryKey

public java.lang.Object findByPrimaryKey(java.lang.Object primaryKeyObject)
                                  throws oracle.toplink.ejb.FinderException

PUBLIC: Find the object by primary key object and load it into the cache. Throw object not found if null, otherwise return the primary key.

findObject

public java.lang.Object findObject(ReadObjectQuery query)
                            throws oracle.toplink.ejb.FinderException

PUBLIC: Find the object by the query and load it into the cache. If object not found return null, otherwise return the object.

findObjectByNamedQuery

public java.lang.Object findObjectByNamedQuery(java.lang.String queryName,
                                               java.util.Vector arguments)
                                        throws oracle.toplink.ejb.FinderException

PUBLIC: Find the object by the query and load it into the cache. If object not found return null, otherwise return the object.

findOne

public java.lang.Object findOne(Expression expression)
                         throws oracle.toplink.ejb.FinderException

PUBLIC: Find the object by the query and load it into the cache. Throw object not found if null, otherwise return the primary key.

findOne

public java.lang.Object findOne(Call call)
                         throws oracle.toplink.ejb.FinderException

PUBLIC: Find the object by the query and load it into the cache. Throw object not found if null, otherwise return the primary key.

findOne

public java.lang.Object findOne(ReadObjectQuery query)
                         throws oracle.toplink.ejb.FinderException

PUBLIC: Find the object by the query and load it into the cache. Throw object not found if null, otherwise return the primary key.

findOneByNamedQuery

public java.lang.Object findOneByNamedQuery(java.lang.String queryName,
                                            java.util.Vector arguments)
                                     throws oracle.toplink.ejb.FinderException

PUBLIC: Find the object by the query and load it into the cache. Throw object not found if null, otherwise return the primary key.

getActiveSession

public Session getActiveSession()

PUBLIC: Return the session or unit of work if in a transaction.

getActiveUnitOfWork

public UnitOfWork getActiveUnitOfWork()

PUBLIC: Return the unit of work in the transaction context.

getBeanClass

public java.lang.Class getBeanClass()

PUBLIC: Return the bean class.

getSession

public Session getSession()

ADVANCED: Return the session. The ClassLoader for this session will be extracted from the bean Class.

getSessionName

public java.lang.String getSessionName()

PUBLIC: Return the session name. This session name is used to lookup the session. By default it is default.

getXMLLoader

public XMLLoader getXMLLoader()

PUBLIC: Return the XMLLoader for this datastore.

load

public void load(java.lang.Object bean)

PUBLIC: Load from the database/cache into the object. It is assumed the bean has its' key set. Runtime exceptions are thrown as load does not define any exception.

remove

public void remove(java.lang.Object bean)
            throws oracle.toplink.ejb.RemoveException

PUBLIC: Delete the bean from the database.

remove

public void remove(oracle.toplink.ejb.EntityBean bean)
            throws oracle.toplink.ejb.RemoveException

PUBLIC: Delete the bean from the database.

setBeanClass

public void setBeanClass(java.lang.Class beanClass)

REQUIRED: Set the bean class for the data store.

setSession

public void setSession(Session session)

PUBLIC: Set the session. By default it is looked up through the session name or the default session is used.

setSessionName

public void setSessionName(java.lang.String sessionName)

PUBLIC: Set the session name. This session name is used to lookup the session. By default it is default.

setXMLLoader

public void setXMLLoader(XMLLoader xmlLoader)

PUBLIC: Set the XML Loader that will be used to load the session configuration information. By default it is it is the core loader.

store

public void store(java.lang.Object bean)
           throws DatabaseException,
                  OptimisticLockException

PUBLIC: Update the bean into the database. Note, runtime exceptions are thrown as store defines no exception. This uses the unit of work merge to update the TopLink version of the object.

store

public void store(oracle.toplink.ejb.EntityBean bean)
           throws DatabaseException,
                  OptimisticLockException

PUBLIC: Update the bean into the database. Note, runtime exceptions are thrown as store defines no exception. Store must always be an update, so update is called, not write object.