ch.ethz.mxquery.model
Class TokenBasedIterator

java.lang.Object
  ch.ethz.mxquery.model.Iterator
      ch.ethz.mxquery.model.TokenBasedIterator

All Implemented Interfaces:

XDMIterator, Traversable

Direct Known Subclasses:

Abs, AdditiveIterator, Avg, BaseUri, BooleanIterator, CastAsIterator, Ceiling, CodePointEqual, CodepointsToString, Compare, CompareIterator, ComputedCommentConstrIterator, ComputedPIConstrIterator, ComputedTextConstrIterator, Concat, Contains, CountIterator, CurrentDate, CurrentDateTime, CurrentTime, DateTime, DateTimeAdjustTimezone, DateTimeValues, DayTimeDurationValues, Deep_equal, DefaultCollation, DocAvailable, DocumentUri, Empty, EncodeForURI, EndsWith, Eratosthenes, Error, EscapeHTMLURI, Exists, ExternalFunctionExample.SingleValueExtFunction, Floor, FNQName, FNString, ForseqIterator, ImplicitTimezone, Index_of, InstanceOfIterator, IRItoURI, Lang, Last, Local_name, Local_name_from_QName, LogicalIterator, LowerCase, Matches, MaxMin, MultiplicativeIterator, Name, Namespace_uri, Namespace_uri_for_prefix, Namespace_uri_from_QName, Nilled, Node_Name, NormalizeSpace, NormalizeUnicode, Not, Number, Position, Pow, Prefix_from_QName, QuantifiedIterator, Random, RangeIterator, ReadlineIterator, Replace, ResolveQName, ResolveUri, Round, RoundHalfToEven, Score, SerializeXMLToString, Sqrt, StartsWith, StaticBaseUri, String_Length, StringJoin, StringToCodepoints, SubString, SubstringAfter, SubstringBefore, Sum, Tidy, TokenIterator, Translate, TransMath, UpperCase, Uuid, XMLAttrIterator, XSConstructorIterator

public abstract class TokenBasedIterator
extends Iterator

Field Summary

Fields inherited from interface ch.ethz.mxquery.model.XDMIterator

EXPR_CATEGORY_SEQUENTIAL, EXPR_CATEGORY_SIMPLE, EXPR_CATEGORY_UPDATING, EXPR_CATEGORY_VACUOUS, EXPR_PARAM_CHEAPEVAL, EXPR_PARAM_VARIABLE, EXPR_PARAM_WINDOW, EXPR_PARAM_XDMGEN

Constructor Summary

TokenBasedIterator()

TokenBasedIterator(Context ctx, int minExpected, XDMIterator[] subIters, QueryLocation location)

TokenBasedIterator(Context ctx, QueryLocation location)

TokenBasedIterator(Context ctx, XDMIterator[] subIters, int expected, QueryLocation location)

TokenBasedIterator(Context ctx, XDMIterator[] subIters, QueryLocation location)

Method Summary

Token

next() generate next Token, needs to be implemented by the respective iterator

Methods inherited from class ch.ethz.mxquery.model.Iterator

addPredicates, close, copy, copyInts, copyIterators, copyQNames, copyStrings, copyTypeInfos, getAllSubIters, getAllSubItersRecursive, getContext, getExpressionCategoryType, getLoc, getPendingUpdateList, getPredicates, getStaticType, getSubIters, hasPredicates, isConstModePreserve, isExprParameter, isOpen, isResettable, removePredicates, reset, setConstModePreserve, setContext, setLoc, setOrderByExpr, setParam, setResettable, setReturnExpr, setSubIters, setSubIters, setSubIters, setWhereExpr, traverse, traverseIteratorTree

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenBasedIterator

public TokenBasedIterator()

TokenBasedIterator

public TokenBasedIterator(Context ctx,
                          QueryLocation location)

TokenBasedIterator

public TokenBasedIterator(Context ctx,
                          int minExpected,
                          XDMIterator[] subIters,
                          QueryLocation location)
                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

TokenBasedIterator

public TokenBasedIterator(Context ctx,
                          XDMIterator[] subIters,
                          int expected,
                          QueryLocation location)
                   throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

TokenBasedIterator

public TokenBasedIterator(Context ctx,
                          XDMIterator[] subIters,
                          QueryLocation location)

Method Detail

next

public Token next()
           throws MXQueryException

generate next Token, needs to be implemented by the respective iterator

Returns:

The first call will give the type of first Token of the result, the second the second and so on. When the last token has been produced, the type of an END_SEQUENCE token will be returned

Throws:

MXQueryException