public interface Query extends Serializable, QueryContext, QueryOperations, QueryFlushModes
OP_DELETE, OP_SELECT, OP_UPDATE
FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION
Modifier and Type | Method and Description |
---|---|
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(Map<?,?> parameterMap)
Deletes all of the instances that are satisfied by the query.
|
long |
deleteAll(Object[] parameters)
Deletes all of the instances that are satisfied by the query.
|
Object |
execute()
Execute.
|
Object |
execute(Map<?,?> params)
Execute with parameter map.
|
Object |
execute(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. |
String[] |
getDataStoreActions(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(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(Object query)
The query string or template.
|
long |
updateAll()
Performs an update of the instances that are satisfied by the query.
|
long |
updateAll(Map<?,?> parameterMap)
Performs an update of the instances that are satisfied by the query.
|
long |
updateAll(Object[] parameters)
Performs an update of the instances that are satisfied by the query.
|
classForName, declareParameters, deleteInMemory, getAccessPathMetaDatas, getAggregateListener, getAggregateListeners, getAlias, getCandidateCollection, getCandidateType, getCompilation, getEndRange, getFetchConfiguration, getFilterListener, getFilterListeners, getIgnoreChanges, getLanguage, getOperation, getOrderedParameterTypes, getParameterDeclaration, getParameterTypes, getProjectionAliases, getProjectionTypes, getQuery, getQueryString, getResultMappingName, getResultMappingScope, getResultType, getStartRange, getStoreContext, getUpdates, hasGrouping, hasSubclasses, isAggregate, isDistinct, isReadOnly, isUnique, lock, setCandidateType, setRange, setReadOnly, setResultMapping, setResultType, setUnique, unlock, updateInMemory
Broker getBroker()
boolean setQuery(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(Collection<?> coll)
void compile()
Object execute()
long deleteAll()
long deleteAll(Object[] parameters)
parameters
- the positional parameters for the querylong deleteAll(Map<?,?> parameterMap)
parameterMap
- the named parameter maplong updateAll()
long updateAll(Object[] parameters)
parameters
- the positional parameter arraylong updateAll(Map<?,?> parameterMap)
parameterMap
- the named parameter mapvoid closeAll()
void closeResources()
String[] getDataStoreActions(Map<?,?> params)
params
- the named parameter map for the query invocationvoid assertOpen()
void assertNotReadOnly()
void assertNotSerialized()
Copyright © 2006–2022 Apache Software Foundation. All rights reserved.