org.exolab.castor.jdo

Interface Query

Known Subinterfaces:
OQLQuery
Known Implementing Classes:
OQLQueryImpl

public interface Query

A query object. Obtained from the database and used to construct and execute a query on that database. All query operations are bound to the database transaction. Closing the database or the transaction will effectively close the query.

If the query specified parameters these parameters must be set (bound) before executing the query. Execution of the query will result in an enumeration of all the objects found by the query. The query can be re-executed by binding new parameters and calling the execute method a second time. A query can be re-execute while objects are still retrieved from a previous execution.

Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:08 $
Author:
Assaf Arkin
See Also:
OQLQuery, Database.getQuery()

Method Summary

void
bind(Object value)
Bind a parameter value to the query.
void
bind(boolean value)
Bind a parameter value to the query.
void
bind(double value)
Bind a parameter value to the query.
void
bind(float value)
Bind a parameter value to the query.
void
bind(int value)
Bind a parameter value to the query.
void
bind(long value)
Bind a parameter value to the query.
void
bind(short value)
Bind a parameter value to the query.
void
close()
Close the query and release all resources held by the query.
QueryResults
execute()
Execute the query.
QueryResults
execute(boolean scrollable)
Experimental This is used for cursor support
QueryResults
execute(short accessMode)
Experimental

Execute the query.

QueryResults
execute(short accessMode, boolean scrollable)

Method Details

bind

public void bind(Object value)
            throws IllegalArgumentException
Bind a parameter value to the query. Parameters are set in the order in which they appear in the query and must match in number and type of each parameter.
Parameters:
value - The parameter value

bind

public void bind(boolean value)
            throws IllegalArgumentException
Bind a parameter value to the query. Parameters are set in the order in which they appear in the query and must match in number and type of each parameter.
Parameters:
value - The parameter value

bind

public void bind(double value)
            throws IllegalArgumentException
Bind a parameter value to the query. Parameters are set in the order in which they appear in the query and must match in number and type of each parameter.
Parameters:
value - The parameter value

bind

public void bind(float value)
            throws IllegalArgumentException
Bind a parameter value to the query. Parameters are set in the order in which they appear in the query and must match in number and type of each parameter.
Parameters:
value - The parameter value

bind

public void bind(int value)
            throws IllegalArgumentException
Bind a parameter value to the query. Parameters are set in the order in which they appear in the query and must match in number and type of each parameter.
Parameters:
value - The parameter value

bind

public void bind(long value)
            throws IllegalArgumentException
Bind a parameter value to the query. Parameters are set in the order in which they appear in the query and must match in number and type of each parameter.
Parameters:
value - The parameter value

bind

public void bind(short value)
            throws IllegalArgumentException
Bind a parameter value to the query. Parameters are set in the order in which they appear in the query and must match in number and type of each parameter.
Parameters:
value - The parameter value

close

public void close()
Close the query and release all resources held by the query.

execute

public QueryResults execute()
            throws QueryException,
                   PersistenceException,
                   TransactionNotInProgressException
Execute the query. The query is executed returning an enumeration of all the objects found. If no objects were found, the enumeration will be empty.

After execution the parameter list is reset. New parameters can be bound and the query re-executed.

Returns:
Query results (zero or more objects)
Throws:
QueryException - The query expression cannot be processed, or the query parameters are invalid
TransactionNotInProgressException - Method called while transaction is not in progress
PersistenceException - An error reported by the persistence engine

execute

public QueryResults execute(boolean scrollable)
            throws QueryException,
                   PersistenceException,
                   TransactionNotInProgressException
Experimental This is used for cursor support

execute

public QueryResults execute(short accessMode)
            throws QueryException,
                   PersistenceException,
                   TransactionNotInProgressException
Experimental

Execute the query. The query is executed returning an enumeration of all the objects found. If no objects were found, the enumeration will be empty.

After execution the parameter list is reset. New parameters can be bound and the query re-executed.

Parameters:
accessMode - The access mode
Returns:
Query results (zero or more objects)
Throws:
QueryException - The query expression cannot be processed, or the query parameters are invalid
TransactionNotInProgressException - Method called while transaction is not in progress
PersistenceException - An error reported by the persistence engine

execute

public QueryResults execute(short accessMode,
                            boolean scrollable)
            throws QueryException,
                   PersistenceException,
                   TransactionNotInProgressException

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com