MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

ch.ethz.mxquery.functions.fn
Class DataValuesIterator

java.lang.Object
  extended by ch.ethz.mxquery.model.Iterator
      extended by ch.ethz.mxquery.model.CurrentBasedIterator
          extended by ch.ethz.mxquery.functions.fn.DataValuesIterator
All Implemented Interfaces:
XDMIterator, Traversable

public class DataValuesIterator
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
DataValuesIterator()
           
 
Method Summary
static XDMIterator getDataIterator(XDMIterator iter, Context ctx)
          This method returns a dataValuesIterator if the underlying iterator doesn't promise to give back a typed value! Otherwise the underlying iterator is given back
 TypeInfo getStaticType()
          Return the return type if it can be statically determined
 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 setFnData(boolean fnData)
           
 
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, 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

DataValuesIterator

public DataValuesIterator()
Method Detail

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

getDataIterator

public static XDMIterator getDataIterator(XDMIterator iter,
                                          Context ctx)
This method returns a dataValuesIterator if the underlying iterator doesn't promise to give back a typed value! Otherwise the underlying iterator is given back

Parameters:
iter - underlying iterator
ctx - TODO
Returns:
An iterator which returns a sequence of atomic values
Throws:
MXQueryException

setFnData

public void setFnData(boolean fnData)

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*

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich