MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

ch.ethz.mxquery.iterators.ft
Class FTBaseIterator

java.lang.Object
  extended by ch.ethz.mxquery.iterators.ft.FTBaseIterator
All Implemented Interfaces:
FTIteratorInterface
Direct Known Subclasses:
FTAndIterator, FTMildNotIterator, FTOrIterator, FTSelectionIterator, FTUnaryNotIterator, MatchIterator, Words

public abstract class FTBaseIterator
extends java.lang.Object
implements FTIteratorInterface

Base Full-text iterator


Field Summary
 Window ignoreOption
           
 
Constructor Summary
FTBaseIterator(Context ctx, FTIteratorInterface[] subIters)
           
 
Method Summary
 FTIteratorInterface copy(Context parentIterContext, XQStaticContext prevParentIterContext, boolean copyContext, java.util.Vector nestedPredCtxStack)
          Prepares copying the Iterator.
 Context getContext()
           
 AllMatch next()
           
 void reset()
           
 void setContext(Context ctx)
           
 void setIgnoreOption(XDMIterator ignoreOption)
           
 void setResettable(boolean r)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ignoreOption

public Window ignoreOption
Constructor Detail

FTBaseIterator

public FTBaseIterator(Context ctx,
                      FTIteratorInterface[] subIters)
Method Detail

next

public AllMatch next()
              throws MXQueryException
Specified by:
next in interface FTIteratorInterface
Throws:
MXQueryException

reset

public void reset()
           throws MXQueryException
Specified by:
reset in interface FTIteratorInterface
Throws:
MXQueryException

setContext

public void setContext(Context ctx)
                throws MXQueryException
Specified by:
setContext in interface FTIteratorInterface
Throws:
MXQueryException

setIgnoreOption

public void setIgnoreOption(XDMIterator ignoreOption)
                     throws MXQueryException
Specified by:
setIgnoreOption in interface FTIteratorInterface
Throws:
MXQueryException

setResettable

public void setResettable(boolean r)
                   throws MXQueryException
Specified by:
setResettable in interface FTIteratorInterface
Throws:
MXQueryException

copy

public FTIteratorInterface copy(Context parentIterContext,
                                XQStaticContext prevParentIterContext,
                                boolean copyContext,
                                java.util.Vector nestedPredCtxStack)
                         throws MXQueryException
Prepares copying the Iterator. The context is copied (if necessary) here. The subIterators are copied (if existing) here. Calls copy(Context context, Iterator[] subIters)!

Specified by:
copy in interface FTIteratorInterface
Parameters:
parentIterContext - The new parent context
prevParentIterContext - The previous context of the parent iterator
copyContext - Copy the context or use the parent context
Returns:
A copy of this Iterator
Throws:
MXQueryException

getContext

public Context getContext()
Specified by:
getContext in interface FTIteratorInterface

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich