|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Query
OpenJPA query interface.
Field Summary |
---|
Fields inherited from interface org.apache.openjpa.kernel.QueryOperations |
---|
OP_DELETE, OP_SELECT, OP_UPDATE |
Fields inherited from interface org.apache.openjpa.kernel.QueryFlushModes |
---|
FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION |
Method Summary | |
---|---|
void |
addAggregateListener(AggregateListener listener)
Register an aggregate listener for the query. |
void |
addFilterListener(FilterListener listener)
Register a filter listener for the query. |
void |
assertNotReadOnly()
Assert that the query is not read-only. |
void |
assertNotSerialized()
Check that the query has not been serialized, which causes it to lose its association with its Broker. |
void |
assertOpen()
Assert that the query's broker is still open. |
void |
closeAll()
Close all open query results. |
void |
closeResources()
Close query results that are consuming resources. |
void |
compile()
Compile the query. |
long |
deleteAll()
Deletes all of the instances that are satisfied by the query. |
long |
deleteAll(java.util.Map parameterMap)
Deletes all of the instances that are satisfied by the query. |
long |
deleteAll(java.lang.Object[] parameters)
Deletes all of the instances that are satisfied by the query. |
java.lang.Object |
execute()
Execute. |
java.lang.Object |
execute(java.util.Map params)
Execute with parameter map. |
java.lang.Object |
execute(java.lang.Object[] params)
Execute with parameter array. |
Broker |
getBroker()
The broker that generated this query. |
Extent |
getCandidateExtent()
Return the candidate extent, or null if a
collection was specified instead of an extent. |
java.lang.String[] |
getDataStoreActions(java.util.Map params)
Returns a description of the commands that will be sent to the datastore in order to execute this query. |
void |
removeAggregateListener(AggregateListener listener)
Remove an aggregate listener from the query. |
void |
removeFilterListener(FilterListener listener)
Remove a filter listener from the query. |
void |
setCandidateCollection(java.util.Collection coll)
Set a collection of candidates. |
void |
setCandidateExtent(Extent extent)
Set the candidate extent. |
void |
setIgnoreChanges(boolean ignore)
Whether to ignore changes in the current transaction. |
boolean |
setQuery(java.lang.Object query)
The query string or template. |
long |
updateAll()
Performs an update of the instances that are satisfied by the query. |
long |
updateAll(java.util.Map parameterMap)
Performs an update of the instances that are satisfied by the query. |
long |
updateAll(java.lang.Object[] parameters)
Performs an update of the instances that are satisfied by the query. |
Method Detail |
---|
Broker getBroker()
boolean setQuery(java.lang.Object query)
void setIgnoreChanges(boolean ignore)
void addFilterListener(FilterListener listener)
void removeFilterListener(FilterListener listener)
void addAggregateListener(AggregateListener listener)
void removeAggregateListener(AggregateListener listener)
Extent getCandidateExtent()
null
if a
collection was specified instead of an extent.
void setCandidateExtent(Extent extent)
void setCandidateCollection(java.util.Collection coll)
void compile()
java.lang.Object execute()
java.lang.Object execute(java.util.Map params)
java.lang.Object execute(java.lang.Object[] params)
long deleteAll()
long deleteAll(java.lang.Object[] parameters)
parameters
- the poitional parameters for the query
long deleteAll(java.util.Map parameterMap)
parameterMap
- the named parameter map
long updateAll()
long updateAll(java.lang.Object[] parameters)
parameters
- the positional parameter array
long updateAll(java.util.Map parameterMap)
parameterMap
- the named parameter map
void closeAll()
void closeResources()
java.lang.String[] getDataStoreActions(java.util.Map params)
params
- the named parameter map for the query invocationvoid assertOpen()
void assertNotReadOnly()
void assertNotSerialized()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |