|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.dna.graph.query.QueryContext
@Immutable public class QueryContext
An immutable context in which queries are to be executed. Each query context defines the information that is available during query execution.
Constructor Summary | |
---|---|
QueryContext(Schemata schemata,
TypeSystem typeSystem)
Create a new context for query execution. |
|
QueryContext(Schemata schemata,
TypeSystem typeSystem,
PlanHints hints)
Create a new context for query execution. |
|
QueryContext(Schemata schemata,
TypeSystem typeSystem,
PlanHints hints,
Problems problems)
Create a new context for query execution. |
|
QueryContext(Schemata schemata,
TypeSystem typeSystem,
PlanHints hints,
Problems problems,
Map<String,Object> variables)
Create a new context for query execution. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
PlanHints |
getHints()
Get the plan hints. |
Problems |
getProblems()
Get the problem container used by this query context. |
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. |
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. |
QueryContext |
with(TypeSystem typeSystem)
Obtain a copy of this context, except that the copy uses the supplied type system. |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public QueryContext(Schemata schemata, TypeSystem typeSystem, PlanHints hints, Problems problems, Map<String,Object> variables)
schemata
- the schematatypeSystem
- the types systemhints
- 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 variables
IllegalArgumentException
- if the values or schmata are nullpublic QueryContext(Schemata schemata, TypeSystem typeSystem, PlanHints hints, Problems problems)
schemata
- the schematatypeSystem
- the types systemhints
- the hints, or null if there are no hintsproblems
- the problems container, or null if a new problems container should be created
IllegalArgumentException
- if the values or schmata are nullpublic QueryContext(Schemata schemata, TypeSystem typeSystem, PlanHints hints)
schemata
- the schematatypeSystem
- the types systemhints
- the hints, or null if there are no hints
IllegalArgumentException
- if the context or schmata are nullpublic QueryContext(Schemata schemata, TypeSystem typeSystem)
schemata
- the schematatypeSystem
- the types system
IllegalArgumentException
- if the values or schmata are nullMethod Detail |
---|
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(TypeSystem typeSystem)
typeSystem
- the type system that should be used in the new query context
IllegalArgumentException
- if the execution context reference is nullpublic QueryContext with(Schemata schemata)
schemata
- the schemata that should be used in the new context
IllegalArgumentException
- if the schemata reference is nullpublic QueryContext with(PlanHints hints)
hints
- the hints that should be used in the new context
IllegalArgumentException
- 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 used
public 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 variables
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |