ch.ethz.mxquery.iterators.ft
Class FTContainsIterator

java.lang.Object
  ch.ethz.mxquery.model.Iterator
      ch.ethz.mxquery.iterators.ft.FTContainsIterator

All Implemented Interfaces:

XDMIterator, Traversable

public class FTContainsIterator
extends Iterator

Implementation of the FTContainsExpr

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

FTContainsIterator(Context ctx, XDMIterator[] subIters, FTIteratorInterface iter, QueryLocation location, boolean genScore)

Method Summary

XDMIterator	copy(Context parentIterContext, XQStaticContext prevParentIterContext, boolean copyContext, java.util.Vector nestedPredCtxStack) Copies the Iterator.
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	resetImpl() Resets the Iterator to its original state.
void	setContext(Context context, boolean recursive) Assigns a context for this iterator (and possibly for its subIterators), replacing the existing context
void	setResettable(boolean r) Set this Iterator (and its subiterators) resetable.

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

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

FTContainsIterator

public FTContainsIterator(Context ctx,
                          XDMIterator[] subIters,
                          FTIteratorInterface iter,
                          QueryLocation location,
                          boolean genScore)

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

setContext

public void setContext(Context context,
                       boolean recursive)
                throws MXQueryException

Description copied from interface: XDMIterator

Assigns a context for this iterator (and possibly for its subIterators), replacing the existing context

Specified by:

setContext in interface XDMIterator

Overrides:

setContext in class Iterator

Parameters:

context - the context to assign

recursive - true perform the assignment also subiteratos, false only replace on the current iterator

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

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*

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

copy

public XDMIterator copy(Context parentIterContext,
                        XQStaticContext prevParentIterContext,
                        boolean copyContext,
                        java.util.Vector nestedPredCtxStack)
                 throws MXQueryException

Description copied from interface: XDMIterator

Copies the Iterator. The context is copied (if necessary) here. The subIterators are copied (if existing) here.

Specified by:

copy in interface XDMIterator

Overrides:

copy in class Iterator

Parameters:

parentIterContext - The new parent context

prevParentIterContext - The previous context of the parent iterator

copyContext - Copy the context or use the parent context

nestedPredCtxStack - The Stack of nested predicate context, needed for nested rewritten predicates

Returns:

A copy of this Iterator

Throws:

MXQueryException