com.bigdata.bop.engine

Interface QueryEngine.Annotations

All Superinterfaces:

BOp.Annotations, BufferAnnotations, PipelineOp.Annotations

All Known Subinterfaces:

FederatedQueryEngine.Annotations

Enclosing class:

QueryEngine

public static interface QueryEngine.Annotations
extends PipelineOp.Annotations

Annotations understood by the QueryEngine.

Author:

Bryan Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHUNK_HANDLER The class used to map binding sets across the federation or transition them from IBindingSet[]s to IChunkMessages stored on the native heap.
static String	DEFAULT_RUNNING_QUERY_CLASS
static String	QUERY_ID Annotation may be used to impose a specific UUID for a query.
static String	RUNNING_QUERY_CLASS The name of the IRunningQuery implementation class which will be used to evaluate a query marked by this annotation (optional).

Fields inherited from interface com.bigdata.bop.PipelineOp.Annotations

ALT_SINK_REF, DEFAULT_LAST_PASS, DEFAULT_MAX_MEMORY, DEFAULT_MAX_MESSAGES_PER_TASK, DEFAULT_MAX_PARALLEL, DEFAULT_PIPELINE_QUEUE_CAPACITY, DEFAULT_PIPELINED, DEFAULT_REORDER_SOLUTIONS, DEFAULT_SHARED_STATE, LAST_PASS, MAX_MEMORY, MAX_MESSAGES_PER_TASK, MAX_PARALLEL, PIPELINE_QUEUE_CAPACITY, PIPELINED, REORDER_SOLUTIONS, SHARED_STATE, SINK_REF

Fields inherited from interface com.bigdata.bop.BOp.Annotations

BOP_ID, CONTROLLER, DEFAULT_CONTROLLER, DEFAULT_EVALUATION_CONTEXT, DEFAULT_TIMEOUT, EVALUATION_CONTEXT, NAMESPACE, TIMEOUT

Fields inherited from interface com.bigdata.bop.BufferAnnotations

CHUNK_CAPACITY, CHUNK_OF_CHUNKS_CAPACITY, CHUNK_TIMEOUT, chunkTimeoutUnit, DEFAULT_CHUNK_CAPACITY, DEFAULT_CHUNK_OF_CHUNKS_CAPACITY, DEFAULT_CHUNK_TIMEOUT

Field Detail

QUERY_ID

static final String QUERY_ID

Annotation may be used to impose a specific UUID for a query. This may be used by an external process such that it can then use QueryEngine.getRunningQuery(UUID) to gain access to the running query instance. It is an error if there is a query already running with the same UUID.

RUNNING_QUERY_CLASS

static final String RUNNING_QUERY_CLASS

The name of the IRunningQuery implementation class which will be used to evaluate a query marked by this annotation (optional). The specified class MUST implement IRunningQuery and MUST have a constructor with the following signature:

 public MyRunningQuery(QueryEngine queryEngine, UUID queryId,
             boolean controller, IQueryClient clientProxy,
             PipelineOp query, IChunkMessage realSource)
 

Note that classes derived from QueryEngine may override QueryEngine#newRunningQuery(QueryEngine, UUID, boolean, IQueryClient, PipelineOp, IChunkMessage, IRunningQuery) in which case they might not support this option.

DEFAULT_RUNNING_QUERY_CLASS

static final String DEFAULT_RUNNING_QUERY_CLASS

CHUNK_HANDLER

static final String CHUNK_HANDLER

The class used to map binding sets across the federation or transition them from IBindingSet[]s to IChunkMessages stored on the native heap.

See Also:

Vector query engine on native heap.