org.objectweb.medor.eval.lib
Class BasicEvaluationMetaData

java.lang.Object
  extended byorg.objectweb.medor.eval.lib.BasicEvaluationMetaData
All Implemented Interfaces:
AnnotationsHolder, EvaluationMetaData, java.io.Serializable

public class BasicEvaluationMetaData
extends java.lang.Object
implements EvaluationMetaData

Author:
Sebastien Chassande-Barrioz
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.objectweb.medor.eval.api.EvaluationMetaData
ANNOTATION_IS_CACHE, ANNOTATION_IS_LIMITED_RANGE, ANNOTATION_IS_PARALLEL, ANNOTATION_LIMITED_RANGE_SIZE, ANNOTATION_LIMITED_RANGE_START_AT
 
Constructor Summary
BasicEvaluationMetaData()
           
 
Method Summary
 java.util.Map getAnnotations()
           
 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 isParallel)
          Set a boolean for declaring parallel evaluation of sub-QueryTrees.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicEvaluationMetaData

public BasicEvaluationMetaData()
Method Detail

setCache

public void setCache(boolean isCache)
Description copied from interface: EvaluationMetaData
Set a boolean for declaring the use of a cache for intermediate materialization of results at evaluation time.

Specified by:
setCache in interface EvaluationMetaData

isCache

public boolean isCache()
Description copied from interface: EvaluationMetaData
Get the value of the boolean indicating whether cache is used for materialization of intermediate results at evaluation time.

Specified by:
isCache in interface EvaluationMetaData
Returns:
the boolean indicating whether the cache is used for materialization of intermediate results.

setParallel

public void setParallel(boolean isParallel)
Description copied from interface: EvaluationMetaData
Set a boolean for declaring parallel evaluation of sub-QueryTrees.

Specified by:
setParallel in interface EvaluationMetaData

isParallel

public boolean isParallel()
Description copied from interface: EvaluationMetaData
Get the value of the boolean indicating whether parallel evaluation of sub-QueryTrees is performed.

Specified by:
isParallel in interface EvaluationMetaData
Returns:
the boolean indicating parallel evaluation of sub-QueryTrees is performed.

isLimitedRange

public boolean isLimitedRange()
Description copied from interface: EvaluationMetaData
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.

Specified by:
isLimitedRange in interface EvaluationMetaData
Returns:
true if limited range evaluation is to be performed.

setLimitedRangeStartAt

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

Specified by:
setLimitedRangeStartAt in interface EvaluationMetaData
Parameters:
start - the index of the first tuple to be returned by the evaluation, stating at 0.

getLimitedRangeStartAt

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

Specified by:
getLimitedRangeStartAt in interface EvaluationMetaData
Returns:
the value for the first tuple to be returned by the evaluation, starting at 0.

setLimitedRangeSize

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

Specified by:
setLimitedRangeSize in interface EvaluationMetaData
Parameters:
number - the maximum number of tuples to be returned by the evaluation

getLimitedRangeSize

public int getLimitedRangeSize()
Description copied from interface: EvaluationMetaData
Gets the maximum number of tuples to be returned by the evaluation in the case of a range-limited evaluation.

Specified by:
getLimitedRangeSize in interface EvaluationMetaData
Returns:
the maximum number of tuples to be returned by the evaluation.

getAnnotations

public java.util.Map getAnnotations()
Specified by:
getAnnotations in interface AnnotationsHolder
Returns:
a map containing associations key <-> value defining the annotations.