MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

ch.ethz.mxquery.iterators.scripting
Class CatchIterator

java.lang.Object
  extended by ch.ethz.mxquery.model.Iterator
      extended by ch.ethz.mxquery.model.CurrentBasedIterator
          extended by ch.ethz.mxquery.iterators.scripting.CatchIterator
All Implemented Interfaces:
XDMIterator, Traversable

public class CatchIterator
extends CurrentBasedIterator

Represents a catch expression of a try.


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
CatchIterator(Context ctx, XDMIterator catchExpr, java.lang.Object nametest, QName errorCode, QName errorDescr, QName errorVal, QueryLocation location)
           
 
Method Summary
 boolean compareErrCodes(QName otherCode)
           
 void freeResources(boolean restartable)
          Frees the resources of the current iterator.
 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 resetImpl()
          Resets the Iterator to its original state.
 
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

CatchIterator

public CatchIterator(Context ctx,
                     XDMIterator catchExpr,
                     java.lang.Object nametest,
                     QName errorCode,
                     QName errorDescr,
                     QName errorVal,
                     QueryLocation location)
Method Detail

freeResources

public void freeResources(boolean restartable)
                   throws MXQueryException
Description copied from class: Iterator
Frees the resources of the current iterator.

Parameters:
restartable - make the iterator restartable (otherwise the iterator will stay closed with additional next calls)
Throws:
MXQueryException

resetImpl

public void resetImpl()
               throws MXQueryException
Description copied from class: Iterator
Resets the Iterator to its original state. Iterator-specific implementation is done here.

Throws:
MXQueryException

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

compareErrCodes

public boolean compareErrCodes(QName otherCode)
                        throws MXQueryException
Throws:
MXQueryException

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich