org.exolab.castor.persist.spi
Class AbstractCallQuery

java.lang.Object
  org.exolab.castor.persist.spi.AbstractCallQuery

All Implemented Interfaces:

PersistenceQuery

public abstract class AbstractCallQuery
extends Object
implements PersistenceQuery

Field Summary

protected String	_call
protected Identity	_lastIdentity
protected ResultSet	_rs
protected PreparedStatement	_stmt
protected Object[]	_values

Constructor Summary

protected

AbstractCallQuery(String call, Class<?>[] types, Class<?> javaClass, int[] sqlTypes)

Method Summary

boolean	absolute(int row) Moves the result of the query to the absolute position in the resultset.
void	close() Close the query and release all resources held by the query.
protected abstract void	execute(Object conn, AccessMode accessMode)
void	execute(Object conn, AccessMode accessMode, boolean scrollable) Execute the query with the give connection and lock type.
void	fetch(ProposedEntity proposedObject) Loades the object.
int	getParameterCount()
Class<?>	getParameterType(int index)
Class<?>	getResultType() Returns the type of object returned by this query.
Identity	nextIdentity(Identity identity) Returns the identity of the next object to be returned.
protected abstract boolean	nextRow()
void	setParameter(int index, Object value) Sets the value of a paramter.
int	size() Finds the size of the resulting resultset from the query.

Methods inherited from class java.lang.Object

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

Field Detail

_stmt

protected PreparedStatement _stmt

_rs

protected ResultSet _rs

_lastIdentity

protected Identity _lastIdentity

_values

protected final Object[] _values

_call

protected final String _call

Constructor Detail

AbstractCallQuery

protected AbstractCallQuery(String call,
                            Class<?>[] types,
                            Class<?> javaClass,
                            int[] sqlTypes)

Method Detail

nextRow

protected abstract boolean nextRow()
                            throws SQLException

Throws:

SQLException

fetch

public void fetch(ProposedEntity proposedObject)
           throws PersistenceException

Description copied from interface: PersistenceQuery

Loades the object. This method must be called immediately after PersistenceQuery.nextIdentity(org.exolab.castor.persist.spi.Identity) with the same identity.

If the object is locked by another transaction this method will block until the lock is released, or a timeout occured. If a timeout occurs or the object has been deleted by the other transaction, this method will report an ObjectNotFoundException. The query may proceed to the next identity.

This method is equivalent to Persistence.load(java.lang.Object, org.castor.persist.ProposedEntity, org.exolab.castor.persist.spi.Identity, org.exolab.castor.mapping.AccessMode) with a known cache engine and access mode and acts on the query results rather than issuing a new query to load the object.

Specified by:

fetch in interface PersistenceQuery

Parameters:

proposedObject - The fields to load into

Throws:

PersistenceException - The object was not found in persistent storage or any other persistence error occured.

See Also:

Persistence.load(java.lang.Object, org.castor.persist.ProposedEntity, org.exolab.castor.persist.spi.Identity, org.exolab.castor.mapping.AccessMode)

close

public void close()

Description copied from interface: PersistenceQuery

Close the query and release all resources held by the query.

Specified by:

close in interface PersistenceQuery

getParameterCount

public int getParameterCount()

getParameterType

public Class<?> getParameterType(int index)
                          throws ArrayIndexOutOfBoundsException

Throws:

ArrayIndexOutOfBoundsException

setParameter

public void setParameter(int index,
                         Object value)
                  throws ArrayIndexOutOfBoundsException,
                         IllegalArgumentException

Description copied from interface: PersistenceQuery

Sets the value of a paramter. Will complain if the parameter is not of the specified type.

Specified by:

setParameter in interface PersistenceQuery

Parameters:

index - The parameter index

value - The parameter value

Throws:

ArrayIndexOutOfBoundsException

IllegalArgumentException

absolute

public boolean absolute(int row)
                 throws PersistenceException

Description copied from interface: PersistenceQuery

Moves the result of the query to the absolute position in the resultset.

Specified by:

absolute in interface PersistenceQuery

Parameters:

row - The row to move to

Throws:

PersistenceException - A persistence error occured

size

public int size()
         throws PersistenceException

Description copied from interface: PersistenceQuery

Finds the size of the resulting resultset from the query.

Specified by:

size in interface PersistenceQuery

Throws:

PersistenceException

getResultType

public Class<?> getResultType()

Description copied from interface: PersistenceQuery

Returns the type of object returned by this query.

Specified by:

getResultType in interface PersistenceQuery

Returns:

The type of object returned by this query

execute

public void execute(Object conn,
                    AccessMode accessMode,
                    boolean scrollable)
             throws PersistenceException

Description copied from interface: PersistenceQuery

Execute the query with the give connection and lock type. After a successful return the query results will be returned by calling PersistenceQuery.nextIdentity(org.exolab.castor.persist.spi.Identity) and PersistenceQuery.fetch(org.castor.persist.ProposedEntity). The query parameters will be reset. A new query may be issued by providing new query parameters and calling PersistenceQuery.execute(Object, AccessMode, boolean).

Specified by:

execute in interface PersistenceQuery

Parameters:

conn - An open connection

accessMode - The access mode (null equals shared)

scrollable - The db cursor mode.

Throws:

PersistenceException - An invalid query or an error reported by the persistence engine.

execute

protected abstract void execute(Object conn,
                                AccessMode accessMode)
                         throws PersistenceException

Throws:

PersistenceException

nextIdentity

public Identity nextIdentity(Identity identity)
                      throws PersistenceException

Description copied from interface: PersistenceQuery

Returns the identity of the next object to be returned. Calling this method multiple time will skip objects. When the result set has been exhuasted, this method will return null.

Specified by:

nextIdentity in interface PersistenceQuery

Parameters:

identity - The identity of the previous object, null if this method is called for the first time

Returns:

The identity of the next object, null if the result set has been exhausted

Throws:

PersistenceException - An error reported by the persistence engine