org.xcmis.search.query
Class QueryExecutionContext

java.lang.Object
  org.xcmis.search.query.QueryExecutionContext

public class QueryExecutionContext
extends Object

An immutable context in which queries are to be executed. Each query context defines the information that is available during query execution.

Constructor Summary

QueryExecutionContext(Schema schema, QueryExecutionExceptions executionExceptions, Map<String,Object> variables)

Method Summary

QueryExecutionExceptions	getExecutionExceptions() Get the exceptions container used by this query context.
Schema	getSchema() Get the definition of the tables available within this query context.
Map<String,Object>	getVariables() Get the variables that are to be substituted into the BindVariableName used in the query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryExecutionContext

public QueryExecutionContext(Schema schema,
                             QueryExecutionExceptions executionExceptions,
                             Map<String,Object> variables)

Parameters:

variables - the mapping of variables and values, or null if there are no such variables

Method Detail

getSchema

public Schema getSchema()

Get the definition of the tables available within this query context.

Returns:

the schemata; never null

getExecutionExceptions

public QueryExecutionExceptions getExecutionExceptions()

Get the exceptions container used by this query context. Any problems that have been encountered will be accumlated in this container.

Returns:

the executionExceptions container; never null

getVariables

public Map<String,Object> getVariables()

Get the variables that are to be substituted into the BindVariableName used in the query.

Returns:

immutable map of variable values keyed by their name; never null but possibly empty