com.bigdata.bop.join

Interface JoinAnnotations

All Superinterfaces:

BOp.Annotations, BufferAnnotations, PipelineOp.Annotations

All Known Subinterfaces:

AccessPathJoinAnnotations, DistinctTermScanOp.Annotations, FastRangeCountOp.Annotations, HashIndexOp.Annotations, HashIndexOpBase.Annotations, HashJoinOp.Annotations, HTreeHashJoinAnnotations, HTreeHashJoinOp.Annotations, HTreeMergeJoin.Annotations, HTreeNamedSubqueryOp.Annotations, JVMHashJoinAnnotations, JVMHashJoinOp.Annotations, JVMMergeJoin.Annotations, JVMNamedSubqueryOp.Annotations, NestedLoopJoinOp.Annotations, PipelinedHashIndexAndSolutionSetJoinOp.Annotations, PipelineJoin.Annotations, SubqueryJoinAnnotations, SubqueryOp.Annotations

public interface JoinAnnotations
extends PipelineOp.Annotations

Common annotations for various join operators.

Version:

$Id$

Author:

Bryan Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSTRAINTS An IConstraint[] which places restrictions on the legal patterns in the variable bindings (optional).
static long	DEFAULT_LIMIT
static String	JOIN_TYPE The JoinTypeEnum for join (required).
static String	LIMIT The maximum #of solutions which will be generated by the join (default 9223372036854775807L).
static String	SELECT An optional IVariable[] identifying the variables to be retained in the IBindingSets written out by the operator.

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

JOIN_TYPE

static final String JOIN_TYPE

The JoinTypeEnum for join (required).

Note: Not all join operators support all join types. For example, PipelineJoin supports JoinTypeEnum.Normal and JoinTypeEnum.Optional. The hash join operators tend to support more join types, but some hash join operators only support JoinTypeEnum.Normal joins because the solutions from the query engine are flowing through the join rather than being at a fixed point in a hash index which is then fed into the join. When the query engine solutions are folowing through the join it is not possible to do any of the non-required joins (Optional, Exists, NotExists).

See Also:

JoinTypeEnum

SELECT

static final String SELECT

An optional IVariable[] identifying the variables to be retained in the IBindingSets written out by the operator. All variables are retained unless this annotation is specified.

CONSTRAINTS

static final String CONSTRAINTS

An IConstraint[] which places restrictions on the legal patterns in the variable bindings (optional).

Note: Constraints are applied to input solutions which join. If an input solution does not join and the IPredicate is IPredicate.Annotations#OPTIONAL then the CONSTRAINTS are NOT tested and the original solution is output.

LIMIT

static final String LIMIT

The maximum #of solutions which will be generated by the join (default 9223372036854775807L).

Note: This annotation is used by the RTO to sample evaluation plans. Not all joins support this annotation and the RTO is responsible for using only those joins which DO support this annotation when sampling cutoff evaluation of operator path segments.

See Also:

JoinGraph

DEFAULT_LIMIT

static final long DEFAULT_LIMIT

See Also:

Constant Field Values