|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ojb.odmg.oql.OQLQueryImpl
Insert the type's description here. Creation date: (08.05.01 13:12:58)
Constructor Summary | |
OQLQueryImpl(PBKey key)
|
Method Summary | |
void |
bind(java.lang.Object parameter)
Bind a parameter to the query. |
void |
configure(Configuration pConfig)
configure an object using the Configuration pConfig |
void |
create(java.lang.String queryString)
Create an OQL query from the string parameter. |
void |
create(java.lang.String queryString,
int startAtIndex,
int endAtIndex)
|
java.lang.Object |
execute()
Execute the query. |
int |
fullSize()
|
protected java.util.ListIterator |
getBindIterator()
Gets the bindIterator. |
protected java.lang.Class |
getCollectionClass()
returns the collection type to be used to contain oql query result sets |
protected OdmgConfiguration |
getConfiguration()
|
Query |
getQuery()
returns the compiled query object |
protected void |
performLockingIfRequired(Transaction tx,
PersistenceBroker broker,
ManageableCollection result)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public OQLQueryImpl(PBKey key)
Method Detail |
public Query getQuery()
protected java.lang.Class getCollectionClass()
public void bind(java.lang.Object parameter) throws QueryParameterCountInvalidException, QueryParameterTypeInvalidException
create
by $i,
where i is the rank of the parameter, beginning with 1.
The parameters are set consecutively by calling this method bind
.
The ith variable is set by the ith call to the bind
method.
If any of the $i are not set by a call to bind
at the point
execute
is called, QueryParameterCountInvalidException
is thrown.
The parameters must be objects, and the result is an Object
.
Objects must be used instead of primitive types (Integer
instead
of int
) for passing the parameters.
If the parameter is of the wrong type,
QueryParameterTypeInvalidException
is thrown.
After executing a query, the parameter list is reset.
bind
in interface OQLQuery
parameter
- A value to be substituted for a query parameter.
QueryParameterCountInvalidException
- The number of calls to
bind
has exceeded the number of parameters in the query.
QueryParameterTypeInvalidException
- The type of the parameter does
not correspond with the type of the parameter in the query.public void create(java.lang.String queryString) throws QueryInvalidException
OQLQuery
object must be created
by calling Implementation.newOQLQuery
, then calling the
create
method with the query string.
The create
method might throw QueryInvalidException
if the query could not be compiled properly. Some implementations may not want
to compile the query before execute
is called. In this case
QueryInvalidException
is thrown when execute
is called.
create
in interface OQLQuery
queryString
- An OQL query.
QueryInvalidException
- The query syntax is invalid.public void create(java.lang.String queryString, int startAtIndex, int endAtIndex) throws QueryInvalidException
create
in interface EnhancedOQLQuery
QueryInvalidException
public java.lang.Object execute() throws QueryException
ODMGException
.
execute
in interface OQLQuery
Integer
object. When OQL returns a collection (literal or object),
the result is always a Java collection object of the same kind
(for instance, a DList
).
QueryException
- An exception has occurred while executing the query.protected void performLockingIfRequired(Transaction tx, PersistenceBroker broker, ManageableCollection result)
protected OdmgConfiguration getConfiguration()
protected java.util.ListIterator getBindIterator()
public void configure(Configuration pConfig) throws ConfigurationException
Configurable
configure
in interface Configurable
pConfig
- the Configuration object used to configure current instance
ConfigurationException
public int fullSize()
fullSize
in interface EnhancedOQLQuery
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |