ch.ethz.mxquery.iterators
Class TokenIterator

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

All Implemented Interfaces:

Source, XDMIterator, Traversable

Direct Known Subclasses:

False, True

public class TokenIterator
extends TokenBasedIterator
implements Source

represents a single Token. Replaces the old AtomicIterator!

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

TokenIterator(Context ctx, boolean value, QueryLocation location)

TokenIterator(Context ctx, long value, int type, QueryLocation location)

TokenIterator(Context ctx, MXQueryBinary value, QueryLocation location)

TokenIterator(Context ctx, MXQueryDate value, QueryLocation location)

TokenIterator(Context ctx, MXQueryDateTime value, QueryLocation location)

TokenIterator(Context ctx, MXQueryDayTimeDuration value, QueryLocation location)

TokenIterator(Context ctx, MXQueryDouble value, QueryLocation location)

TokenIterator(Context ctx, MXQueryDuration value, QueryLocation location)

TokenIterator(Context ctx, MXQueryGregorian value, QueryLocation location)

TokenIterator(Context ctx, MXQueryNumber value, int type, QueryLocation location)

TokenIterator(Context ctx, MXQueryTime value, QueryLocation location)

TokenIterator(Context ctx, MXQueryYearMonthDuration value, QueryLocation location)

TokenIterator(Context ctx, QName value, QueryLocation location)

TokenIterator(Context ctx, java.lang.String value, int type, QueryLocation location)

TokenIterator(Context ctx, java.lang.String value, QueryLocation location)

TokenIterator(Context ctx, Token tok, Namespace xmlns, QueryLocation location)

TokenIterator(Context ctx, Token tok, QueryLocation location)

Method Summary

boolean	cheapEval()
int	compare(Source store)
Source	copySource(Context ctx, java.util.Vector nestedPredCtxStack)
Window	getIterator(Context ctx) Returns Iterator that points on the first token in the store.
TypeInfo	getStaticType() Return the return type if it can be statically determined
Token	getToken()
java.lang.String	getURI() Returns the URI of the source.
boolean	isExprParameter(int valueToCheck, boolean recursive) Optimization check
void	setParam(java.lang.String name, java.lang.String value)
void	setToken(Token tok)

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

next

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

addPredicates, close, copy, copyInts, copyIterators, copyQNames, copyStrings, copyTypeInfos, getAllSubIters, getAllSubItersRecursive, getContext, getExpressionCategoryType, getLoc, getPendingUpdateList, getPredicates, getSubIters, hasPredicates, isConstModePreserve, isOpen, isResettable, removePredicates, reset, setConstModePreserve, setContext, setLoc, setOrderByExpr, 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

TokenIterator

public TokenIterator(Context ctx,
                     Token tok,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     Token tok,
                     Namespace xmlns,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     QName value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryGregorian value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryBinary value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     long value,
                     int type,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryDouble value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryNumber value,
                     int type,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryDuration value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryDayTimeDuration value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryYearMonthDuration value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryDate value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryTime value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     MXQueryDateTime value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     boolean value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     java.lang.String value,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

TokenIterator

public TokenIterator(Context ctx,
                     java.lang.String value,
                     int type,
                     QueryLocation location)
              throws MXQueryException

Throws:

MXQueryException

Method Detail

setParam

public void setParam(java.lang.String name,
                     java.lang.String value)
              throws MXQueryException

Overrides:

setParam in class Iterator

Throws:

MXQueryException

getStaticType

public TypeInfo getStaticType()

Description copied from interface: XDMIterator

Return the return type if it can be statically determined

Specified by:

getStaticType in interface XDMIterator

Overrides:

getStaticType in class Iterator

Returns:

a Type info carrying the most precise static type that could be determined. If no specific type could be determined, the type is ITEM*

setToken

public void setToken(Token tok)

cheapEval

public boolean cheapEval()

isExprParameter

public boolean isExprParameter(int valueToCheck,
                               boolean recursive)

Description copied from interface: XDMIterator

Optimization check

Specified by:

isExprParameter in interface XDMIterator

Overrides:

isExprParameter in class Iterator

Returns:

if iterator fulfills the requested criteria

getToken

public final Token getToken()

compare

public int compare(Source store)

Specified by:

compare in interface Source

getURI

public java.lang.String getURI()

Description copied from interface: Source

Returns the URI of the source.

Specified by:

getURI in interface Source

Returns:

a String representing the URI/Identifier of this source

copySource

public Source copySource(Context ctx,
                         java.util.Vector nestedPredCtxStack)
                  throws MXQueryException

Specified by:

copySource in interface Source

Throws:

MXQueryException

getIterator

public Window getIterator(Context ctx)
                   throws MXQueryException

Description copied from interface: Source

Returns Iterator that points on the first token in the store.

Specified by:

getIterator in interface Source

Returns:

Iterator a (Window) Iterator to access the contents of this source

Throws:

MXQueryException