org.objectweb.medor.eval.api
Interface EvaluationMetaData

All Superinterfaces:
AnnotationsHolder, java.io.Serializable
All Known Implementing Classes:
BasicEvaluationMetaData

public interface EvaluationMetaData
extends AnnotationsHolder

This interface is used for QueryTrees at evaluation time.


Field Summary
static java.lang.Integer ANNOTATION_IS_CACHE
           
static java.lang.Integer ANNOTATION_IS_LIMITED_RANGE
           
static java.lang.Integer ANNOTATION_IS_PARALLEL
           
static java.lang.Integer ANNOTATION_LIMITED_RANGE_SIZE
           
static java.lang.Integer ANNOTATION_LIMITED_RANGE_START_AT
           
 
Method Summary
 int getLimitedRangeSize()
          Gets the maximum number of tuples to be returned by the evaluation in the case of a range-limited evaluation.
 int getLimitedRangeStartAt()
          Gets the value for the rank of the first tuple to be returned by the evaluation in the case of a range-limited evaluation.
 boolean isCache()
          Get the value of the boolean indicating whether cache is used for materialization of intermediate results at evaluation time.
 boolean isLimitedRange()
          Gets the value of the boolean indicating whether a limited range of evaluation is performed.
 boolean isParallel()
          Get the value of the boolean indicating whether parallel evaluation of sub-QueryTrees is performed.
 void setCache(boolean isCache)
          Set a boolean for declaring the use of a cache for intermediate materialization of results at evaluation time.
 void setLimitedRangeSize(int number)
          Sets the maximum number of tuples to be returned by the evaluation in the case of a range-limited evaluation.
 void setLimitedRangeStartAt(int start)
          Sets the value for the rank of the first tuple to be returned by the evaluation in the case of a range-limited evaluation.
 void setParallel(boolean isTupleLoader)
          Set a boolean for declaring parallel evaluation of sub-QueryTrees.
 
Methods inherited from interface org.objectweb.medor.query.api.AnnotationsHolder
getAnnotations
 

Field Detail

ANNOTATION_IS_CACHE

public static final java.lang.Integer ANNOTATION_IS_CACHE

ANNOTATION_IS_PARALLEL

public static final java.lang.Integer ANNOTATION_IS_PARALLEL

ANNOTATION_IS_LIMITED_RANGE

public static final java.lang.Integer ANNOTATION_IS_LIMITED_RANGE

ANNOTATION_LIMITED_RANGE_START_AT

public static final java.lang.Integer ANNOTATION_LIMITED_RANGE_START_AT

ANNOTATION_LIMITED_RANGE_SIZE

public static final java.lang.Integer ANNOTATION_LIMITED_RANGE_SIZE
Method Detail

setCache

public void setCache(boolean isCache)
Set a boolean for declaring the use of a cache for intermediate materialization of results at evaluation time.


isCache

public boolean isCache()
Get the value of the boolean indicating whether cache is used for materialization of intermediate results at evaluation time.

Returns:
the boolean indicating whether the cache is used for materialization of intermediate results.

setParallel

public void setParallel(boolean isTupleLoader)
Set a boolean for declaring parallel evaluation of sub-QueryTrees.


isParallel

public boolean isParallel()
Get the value of the boolean indicating whether parallel evaluation of sub-QueryTrees is performed.

Returns:
the boolean indicating parallel evaluation of sub-QueryTrees is performed.

isLimitedRange

public boolean isLimitedRange()
Gets the value of the boolean indicating whether a limited range of evaluation is performed.

If true, there should be a value for the first tuple index and a value for the maximum number of tuples to be returned by the evaluation.

Returns:
true if limited range evaluation is to be performed.

setLimitedRangeStartAt

public void setLimitedRangeStartAt(int start)
Sets the value for the rank of the first tuple to be returned by the evaluation in the case of a range-limited evaluation.

Parameters:
start - the index of the first tuple to be returned by the evaluation, stating at 0.

getLimitedRangeStartAt

public int getLimitedRangeStartAt()
Gets the value for the rank of the first tuple to be returned by the evaluation in the case of a range-limited evaluation.

Returns:
the value for the first tuple to be returned by the evaluation, starting at 0.

setLimitedRangeSize

public void setLimitedRangeSize(int number)
Sets the maximum number of tuples to be returned by the evaluation in the case of a range-limited evaluation.

Parameters:
number - the maximum number of tuples to be returned by the evaluation

getLimitedRangeSize

public int getLimitedRangeSize()
Gets the maximum number of tuples to be returned by the evaluation in the case of a range-limited evaluation.

Returns:
the maximum number of tuples to be returned by the evaluation.