org.treetank.service.xml.xpath.operators

Class ModOpAxis

java.lang.Object

org.treetank.axis.AbsAxis

org.treetank.service.xml.xpath.operators.AbsObAxis

org.treetank.service.xml.xpath.operators.ModOpAxis

All Implemented Interfaces:

Iterable<Long>, Iterator<Long>

public class ModOpAxis
extends AbsObAxis

AddOpAxis

Performs a modulo operation using two input operators.

Constructor Summary

Constructors

Constructor and Description
ModOpAxis(INodeReadTrx rtx, AbsAxis mOp1, AbsAxis mOp2) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Type	getReturnType(int mOp1, int mOp2) Checks if the types of the operands are a valid combination for the operation and if so returns the corresponding result type.
AtomicValue	operate(AtomicValue mOperand1, AtomicValue mOperand2) Performs the operation on the two input operands.

Methods inherited from class org.treetank.service.xml.xpath.operators.AbsObAxis

hasNext, reset

Methods inherited from class org.treetank.axis.AbsAxis

addAtomicToItemList, close, getItemList, getNode, getStartKey, isSelfIncluded, iterator, moveTo, next, remove, resetToLastKey, resetToStartKey

Methods inherited from class java.lang.Object

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

Constructor Detail

ModOpAxis

public ModOpAxis(INodeReadTrx rtx,
         AbsAxis mOp1,
         AbsAxis mOp2)

Constructor. Initializes the internal state.

Parameters:

rtx - Exclusive (immutable) trx to iterate with.

mOp1 - First value of the operation

mOp2 - Second value of the operation

Method Detail

operate

public AtomicValue operate(AtomicValue mOperand1,
                  AtomicValue mOperand2)
                    throws TTXPathException

Performs the operation on the two input operands. First checks if the types of the operands are a valid combination for the operation and if so computed the result. Otherwise an XPathError is thrown.

Specified by:

operate in class AbsObAxis

Parameters:

mOperand1 - first input operand

mOperand2 - second input operand

Returns:

result of the operation

Throws:

TTXPathException - if the operations fails

getReturnType

protected Type getReturnType(int mOp1,
                 int mOp2)
                      throws TTXPathException

Checks if the types of the operands are a valid combination for the operation and if so returns the corresponding result type. Otherwise an XPathError is thrown. This typed check is done according to the Operator Mapping.

Specified by:

getReturnType in class AbsObAxis

Parameters:

mOp1 - first operand's type key

mOp2 - second operand's type key

Returns:

return type of the arithmetic function according to the operand type combination.

Throws:

TTXPathException - if type is not specified