MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

ch.ethz.mxquery.model
Interface IndexIterator

All Known Implementing Classes:
LLStoreIterator, Window, WindowEarlyBinding, WindowEarlyBindingParallel, WindowEmptySequenceIterator, WindowItemIterator, WindowIterator, WindowSequenceIterator, WindowTokenIterator

public interface IndexIterator

If an iterator implements this class, it should have at least an index on items to allow fast access for each item.


Method Summary
 XDMIterator getItem(int position)
          Returns the item on the given Position.
 boolean hasItem(int position)
          Checks if the given position is availabe
 boolean hasNextItem()
          Checks if a nextItem exists
 XDMIterator nextItem()
          Returns the next item.
 

Method Detail

hasItem

boolean hasItem(int position)
                throws MXQueryException
Checks if the given position is availabe

Parameters:
position - Position in the sequence (starting with 1)
Returns:
True if the next item is not end_sequence otherwise false
Throws:
MXQueryException

getItem

XDMIterator getItem(int position)
                    throws MXQueryException
Returns the item on the given Position. If the item is not evailabe, an empty sequence item is returned

Parameters:
position - Position in the sequence (starting with 1)
Returns:
Item or empty sequence iterator
Throws:
MXQueryException

hasNextItem

boolean hasNextItem()
                    throws MXQueryException
Checks if a nextItem exists

Returns:
True if the next item is not end_sequence otherwise false
Throws:
MXQueryException

nextItem

XDMIterator nextItem()
                     throws MXQueryException
Returns the next item. If the item is not evailabe, an empty sequence item is returned

Returns:
Item or empty sequence iterator
Throws:
MXQueryException

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich

MXQuery 0.6.0 API Documentation - Copyright 2006-2009 ETH Zurich