com.bigdata.rdf.sparql.ast.explainhints

Class ExplainHints

java.lang.Object

com.bigdata.rdf.sparql.ast.explainhints.ExplainHints

All Implemented Interfaces:

Iterable<IExplainHint>

public class ExplainHints
extends Object
implements Iterable<IExplainHint>

A list of IExplainHints, to be attached as an annotation to an ASTBase node. See IExplainHint interface for description of explain hints. This class is merely a wrapper allowing to add a set of explain hints to a single node.

Version:

$Id$

Author:

Michael Schmidt

Constructor Summary

Constructors

Constructor and Description
ExplainHints(IExplainHint explainHint) Constructor, setting up an explain hints object containing a single IExplainHint.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExplainHint(IExplainHint explainHint) Add an explain hint to the set of hints.
static Iterator<BOp>	explainHintAnnotatedBOpIterator(BOp astBase) Returns all BOps that are annotated with ExplainHints.
Iterator<IExplainHint>	iterator()
static void	removeExplainHintAnnotationsFromBOp(BOp bop) Utility function to remove explain hint annotations from a BOp.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplainHints

public ExplainHints(IExplainHint explainHint)

Constructor, setting up an explain hints object containing a single IExplainHint.

Method Detail

addExplainHint

public void addExplainHint(IExplainHint explainHint)

Add an explain hint to the set of hints.

removeExplainHintAnnotationsFromBOp

public static void removeExplainHintAnnotationsFromBOp(BOp bop)

Utility function to remove explain hint annotations from a BOp. For use in test case to ease comparison. Be careful, since this modifies the argument.

Parameters:

astBase -

explainHintAnnotatedBOpIterator

public static Iterator<BOp> explainHintAnnotatedBOpIterator(BOp astBase)

Returns all BOps that are annotated with ExplainHints.

Parameters:

op - An operator.

Returns:

The respective iterator.

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<IExplainHint> iterator()

Specified by:

iterator in interface Iterable<IExplainHint>