ch.ethz.mxquery.iterators
Class VariableIterator

java.lang.Object
  ch.ethz.mxquery.model.Iterator
      ch.ethz.mxquery.model.CurrentBasedIterator
          ch.ethz.mxquery.iterators.VariableIterator

All Implemented Interfaces:

XDMIterator, Traversable

public class VariableIterator
extends CurrentBasedIterator

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

VariableIterator(Context ctx, QName varname, boolean resolveOnReset, QueryLocation location)

VariableIterator(Context ctx, QueryLocation location)

Method Summary

TypeInfo	getStaticType() Return the return type if it can be statically determined
Window	getUnderlyingIterator()
QName	getVarQName()
boolean	hasSharedAccess()
void	init()
boolean	isResettable() Retrieve if this iterator is resetable
Token	next() Produces the next XDM token This method typically implements the base functionality of an Iterator and computes the value of the next token.
void	setParam(java.lang.String name, java.lang.String value)
void	setResettable(boolean r) Set this Iterator (and its subiterators) resetable.
void	setReturnType(int type)

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, isExprParameter, isOpen, removePredicates, reset, setConstModePreserve, setContext, setLoc, setOrderByExpr, 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

VariableIterator

public VariableIterator(Context ctx,
                        QName varname,
                        boolean resolveOnReset,
                        QueryLocation location)

VariableIterator

public VariableIterator(Context ctx,
                        QueryLocation location)

Method Detail

getVarQName

public QName getVarQName()

setParam

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

Overrides:

setParam in class Iterator

next

public Token next()
           throws MXQueryException

Description copied from interface: XDMIterator

Produces the next XDM token This method typically implements the base functionality of an Iterator and computes the value of the next token.

Returns:

The XDM token representing the next fragment of the XDM instance

Throws:

MXQueryException

init

public void init()
          throws MXQueryException

Throws:

MXQueryException

getUnderlyingIterator

public Window getUnderlyingIterator()
                             throws MXQueryException

Throws:

MXQueryException

setResettable

public void setResettable(boolean r)
                   throws MXQueryException

Description copied from interface: XDMIterator

Set this Iterator (and its subiterators) resetable. Resetable iterators may require more space (trading buffered data against recomputation)

Specified by:

setResettable in interface XDMIterator

Overrides:

setResettable in class Iterator

Parameters:

r - true make this iterator resetable, false make it not resetable

Throws:

MXQueryException

isResettable

public boolean isResettable()
                     throws MXQueryException

Description copied from interface: XDMIterator

Retrieve if this iterator is resetable

Specified by:

isResettable in interface XDMIterator

Overrides:

isResettable in class Iterator

Returns:

true this iterator is resetable, false it is not

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*

setReturnType

public void setReturnType(int type)

hasSharedAccess

public boolean hasSharedAccess()