@ThreadSafe public class QueryContext extends Object
The only mutable state on this context is whether the query has been cancelled
.
Modifier | Constructor and Description |
---|---|
|
QueryContext(ExecutionContext context,
RepositoryCache repositoryCache,
Set<String> workspaceNames,
Map<String,NodeCache> overriddenNodeCachesByWorkspaceName,
Schemata schemata,
PlanHints hints,
Problems problems,
Map<String,Object> variables)
Create a new context for query execution.
|
|
QueryContext(ExecutionContext context,
RepositoryCache repositoryCache,
Set<String> workspaceNames,
Schemata schemata)
Create a new context for query execution.
|
|
QueryContext(ExecutionContext context,
RepositoryCache repositoryCache,
Set<String> workspaceNames,
Schemata schemata,
PlanHints hints,
Problems problems)
Create a new context for query execution.
|
protected |
QueryContext(QueryContext original)
Create a new context that is a copy of the supplied context.
|
Modifier and Type | Method and Description |
---|---|
boolean |
cancel()
Cancel the query if it is currently running.
|
boolean |
equals(Object obj) |
ExecutionContext |
getExecutionContext()
Get the execution context in which the query is to be evaluated
|
PlanHints |
getHints()
Get the plan hints.
|
NamespaceRegistry |
getNamespaceRegistry()
Get the namespace registry with durable prefixes as used by the query indexes.
|
NodeCache |
getNodeCache(String workspaceName)
Get the NodeCache for the given workspace name.
|
Problems |
getProblems()
Get the problem container used by this query context.
|
RepositoryCache |
getRepositoryCache()
Get the RepositoryCache instance that should be used to load the result tuple values.
|
Schemata |
getSchemata()
Get the definition of the tables available within this query context.
|
TypeSystem |
getTypeSystem()
Get the interface for working with literal values and types.
|
Map<String,Object> |
getVariables()
Get the variables that are to be substituted into the
BindVariableName used in the query. |
Set<String> |
getWorkspaceNames()
Get the names of each workspace that is to be queried.
|
int |
hashCode() |
boolean |
isCancelled() |
QueryContext |
with(Map<String,Object> variables)
Obtain a copy of this context, except that the copy uses the supplied variables.
|
QueryContext |
with(PlanHints hints)
Obtain a copy of this context, except that the copy uses the supplied hints.
|
QueryContext |
with(Problems problems)
Obtain a copy of this context, except that the copy uses the supplied problem container.
|
QueryContext |
with(Schemata schemata)
Obtain a copy of this context, except that the copy uses the supplied schemata.
|
public QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Map<String,NodeCache> overriddenNodeCachesByWorkspaceName, Schemata schemata, PlanHints hints, Problems problems, Map<String,Object> variables)
context
- the context in which the query is being executed; may not be nullrepositoryCache
- the repository cache that should be used to load results; may be null if no results are to be loadedworkspaceNames
- the name of each workspace to be queried, or an empty set if all the workspaces should be queried;
may not be nulloverriddenNodeCachesByWorkspaceName
- the NodeCache instances that should be used to load results, which will be used
instead of the RepositoryCache's NodeCache for a given workspace name; may be null or emptyschemata
- the schematahints
- the hints, or null if there are no hintsproblems
- the problems container, or null if a new problems container should be createdvariables
- the mapping of variables and values, or null if there are no such variablesIllegalArgumentException
- if the context, workspace name, or schemata are nullpublic QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Schemata schemata, PlanHints hints, Problems problems)
context
- the context in which the query is being executed; may not be nullrepositoryCache
- the repository cache that should be used to load results; may not be nullworkspaceNames
- the name of each workspace to be queried, or an empty set if all the workspaces should be queried;
may not be nullschemata
- the schematahints
- the hints, or null if there are no hintsproblems
- the problems container, or null if a new problems container should be createdIllegalArgumentException
- if the context, workspace name, or schemata are nullpublic QueryContext(ExecutionContext context, RepositoryCache repositoryCache, Set<String> workspaceNames, Schemata schemata)
context
- the context in which the query is being executed; may not be nullrepositoryCache
- the repository cache that should be used to load results; may not be nullworkspaceNames
- the name of each workspace to be queried, or an empty set if all the workspaces should be queried;
may not be nullschemata
- the schemataIllegalArgumentException
- if the context, workspace name, or schemata are nullprotected QueryContext(QueryContext original)
original
- the original contextIllegalArgumentException
- if the original is nullpublic final boolean cancel()
public final boolean isCancelled()
public NodeCache getNodeCache(String workspaceName) throws WorkspaceNotFoundException
workspaceName
- the name of the workspaceWorkspaceNotFoundException
- if there is no workspace with the supplied namepublic NamespaceRegistry getNamespaceRegistry()
public RepositoryCache getRepositoryCache()
public ExecutionContext getExecutionContext()
public Set<String> getWorkspaceNames()
public TypeSystem getTypeSystem()
public final PlanHints getHints()
public final Problems getProblems()
public Schemata getSchemata()
public Map<String,Object> getVariables()
BindVariableName
used in the query.public boolean equals(Object obj)
equals
in class Object
Object.equals(java.lang.Object)
public QueryContext with(Schemata schemata)
schemata
- the schemata that should be used in the new contextIllegalArgumentException
- if the schemata reference is nullpublic QueryContext with(PlanHints hints)
hints
- the hints that should be used in the new contextIllegalArgumentException
- if the hints reference is nullpublic QueryContext with(Problems problems)
problems
- the problems that should be used in the new context; may be null if a new problem container should be usedpublic QueryContext with(Map<String,Object> variables)
variables
- the variables that should be used in the new context; may be null if there are no such variablesCopyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.