org.treetank.service.xml.xpath

Class PipelineBuilder

java.lang.Object

org.treetank.service.xml.xpath.PipelineBuilder

public final class PipelineBuilder
extends Object

PipeBuilder

Builder of a query execution plan in the pipeline manner.

Constructor Summary

Constructors

Constructor and Description
PipelineBuilder(INodeReadTrx pRtx) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAndExpression(INodeReadTrx mTransaction) Adds a and expression to the pipeline.
void	addCastableExpr(INodeReadTrx mTransaction, SingleType mSingleType) Adds a castable expression to the pipeline.
void	addCompExpression(INodeReadTrx mTransaction, String mComp) Adds a comparison expression to the pipeline.
void	addExpr() Adds a new pipeline stack to the stack holding all expressions.
void	addExpressionSingle() Adds a new single expression to the pipeline.
void	addForExpression(int mForConditionNum) Adds a for expression to the pipeline.
void	addFunction(INodeReadTrx mTransaction, String mFuncName, int mNum) Adds a function to the pipeline.
void	addIfExpression(INodeReadTrx mTransaction) Adds a if expression to the pipeline.
void	addInstanceOfExpr(INodeReadTrx mTransaction, SequenceType mSequenceType) Adds a instance of expression to the pipeline.
void	addIntExcExpression(INodeReadTrx mTransaction, boolean mIsIntersect) Adds a intersect or a exception expression to the pipeline.
void	addLiteral(INodeReadTrx pTrans, AtomicValue pVal) Adds a literal expression to the pipeline.
void	addOperatorExpression(INodeReadTrx mTransaction, String mOperator) Adds an operator expression to the pipeline.
void	addOrExpression(INodeReadTrx mTransaction) Adds a or expression to the pipeline.
void	addPredicate(INodeReadTrx mTransaction) Adds a predicate to the pipeline.
void	addQuantifierExpr(INodeReadTrx mTransaction, boolean mIsSome, int mVarNum) Adds a SomeExpression or an EveryExpression to the pipeline, depending on the parameter isSome.
void	addRangeExpr(INodeReadTrx mTransaction) Adds a range expression to the pipeline.
void	addStep(AbsAxis axis) Adds a step to the pipeline.
void	addStep(AbsAxis axis, AbsFilter mFilter) Adds a step to the pipeline.
void	addTreatExpr(INodeReadTrx mTransaction, SequenceType mSequenceType) Adds a treat as expression to the pipeline.
void	addUnionExpression(INodeReadTrx mTransaction) Adds a union expression to the pipeline.
void	addVariableExpr(INodeReadTrx mTransaction, String mVarName) Adds a variable expression to the pipeline.
void	addVarRefExpr(INodeReadTrx mTransaction, String mVarName) Adds a VarRefExpr to the pipeline.
void	finishExpr(INodeReadTrx mTransaction, int mNum) Ends an expression.
ExpressionSingle	getExpression() Returns the current pipeline.
AbsAxis	getPipeline() Returns a queue of all pipelines build so far and empties the pipeline stack.
Stack<ExpressionSingle>	getPipeStack()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineBuilder

public PipelineBuilder(INodeReadTrx pRtx)

Constructor.

Method Detail

getPipeStack

public Stack<ExpressionSingle> getPipeStack()

Returns:

the current pipeline stack

addExpr

public void addExpr()

Adds a new pipeline stack to the stack holding all expressions.

finishExpr

public void finishExpr(INodeReadTrx mTransaction,
              int mNum)

Ends an expression. This means that the currently used pipeline stack will be emptied and the singleExpressions that were on the stack are combined by a sequence expression, which is lated added to the next pipeline stack.

Parameters:

mTransaction - transaction to operate on

mNum - number of singleExpressions that will be added to the sequence

addExpressionSingle

public void addExpressionSingle()

Adds a new single expression to the pipeline. This is done by adding a complete new chain to the stack because the new single expression has nothing in common with the previous expressions.

getExpression

public ExpressionSingle getExpression()

Returns the current pipeline. If there is no existing pipeline, a new one is generated and returned.

Returns:

a reference to the currently used pipeline.

addForExpression

public void addForExpression(int mForConditionNum)

Adds a for expression to the pipeline. In case the for expression has more then one for condition, the for expression is converted to a nested for expression with only one for condition each, see the following example: for $a in /a, $b in /b, $c in /c return /d is converted to for $a in /a return for $b in /b return for $c in /c return /d

Parameters:

mForConditionNum - Number of all for conditions of the expression

addIfExpression

public void addIfExpression(INodeReadTrx mTransaction)

Adds a if expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

addCompExpression

public void addCompExpression(INodeReadTrx mTransaction,
                     String mComp)

Adds a comparison expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

mComp - Comparator type.

addOperatorExpression

public void addOperatorExpression(INodeReadTrx mTransaction,
                         String mOperator)

Adds an operator expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

mOperator - Operator type.

addUnionExpression

public void addUnionExpression(INodeReadTrx mTransaction)

Adds a union expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

addAndExpression

public void addAndExpression(INodeReadTrx mTransaction)

Adds a and expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

addOrExpression

public void addOrExpression(INodeReadTrx mTransaction)

Adds a or expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

addIntExcExpression

public void addIntExcExpression(INodeReadTrx mTransaction,
                       boolean mIsIntersect)

Adds a intersect or a exception expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

mIsIntersect - true, if expression is an intersection

addLiteral

public void addLiteral(INodeReadTrx pTrans,
              AtomicValue pVal)

Adds a literal expression to the pipeline.

Parameters:

pTrans - Transaction to operate with.

pVal - key of the literal expression.

addStep

public void addStep(AbsAxis axis)

Adds a step to the pipeline.

Parameters:

axis - the axis step to add to the pipeline.

addStep

public void addStep(AbsAxis axis,
           AbsFilter mFilter)

Adds a step to the pipeline.

Parameters:

axis - the axis step to add to the pipeline.

mFilter - the node test to add to the pipeline.

getPipeline

public AbsAxis getPipeline()

Returns a queue of all pipelines build so far and empties the pipeline stack.

Returns:

all build pipelines

addPredicate

public void addPredicate(INodeReadTrx mTransaction)

Adds a predicate to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

addQuantifierExpr

public void addQuantifierExpr(INodeReadTrx mTransaction,
                     boolean mIsSome,
                     int mVarNum)

Adds a SomeExpression or an EveryExpression to the pipeline, depending on the parameter isSome.

Parameters:

mTransaction - Transaction to operate with.

mIsSome - defines whether a some- or an EveryExpression is used.

mVarNum - number of binding variables

addCastableExpr

public void addCastableExpr(INodeReadTrx mTransaction,
                   SingleType mSingleType)

Adds a castable expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

mSingleType - single type the context item will be casted to.

addRangeExpr

public void addRangeExpr(INodeReadTrx mTransaction)

Adds a range expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

addInstanceOfExpr

public void addInstanceOfExpr(INodeReadTrx mTransaction,
                     SequenceType mSequenceType)

Adds a instance of expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

mSequenceType - sequence type the context item should match.

addTreatExpr

public void addTreatExpr(INodeReadTrx mTransaction,
                SequenceType mSequenceType)

Adds a treat as expression to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

mSequenceType - sequence type the context item will be treated as.

addVariableExpr

public void addVariableExpr(INodeReadTrx mTransaction,
                   String mVarName)

Adds a variable expression to the pipeline. Adds the expression that will evaluate the results the variable holds.

Parameters:

mTransaction - Transaction to operate with.

mVarName - name of the variable

addFunction

public void addFunction(INodeReadTrx mTransaction,
               String mFuncName,
               int mNum)
                 throws TTXPathException

Adds a function to the pipeline.

Parameters:

mTransaction - Transaction to operate with.

mFuncName - The name of the function

mNum - The number of arguments that are passed to the function

Throws:

TTXPathException - if function can't be added

addVarRefExpr

public void addVarRefExpr(INodeReadTrx mTransaction,
                 String mVarName)

Adds a VarRefExpr to the pipeline. This Expression holds a reference to the current context item of the specified variable.

Parameters:

mTransaction - the transaction to operate on.

mVarName - the name of the variable

toString

public String toString()

Overrides:

toString in class Object