it.unimi.di.mg4j.search
Class AbstractOrderedIntervalDocumentIterator

java.lang.Object
  it.unimi.di.mg4j.search.AbstractDocumentIterator
      it.unimi.di.mg4j.search.AbstractIntervalDocumentIterator
          it.unimi.di.mg4j.search.AbstractCompositeDocumentIterator
              it.unimi.di.mg4j.search.AbstractIntersectionDocumentIterator
                  it.unimi.di.mg4j.search.AbstractOrderedIntervalDocumentIterator

All Implemented Interfaces:

DocumentIterator

Direct Known Subclasses:

ConsecutiveDocumentIterator, OrderedAndDocumentIterator

public abstract class AbstractOrderedIntervalDocumentIterator
extends AbstractIntersectionDocumentIterator

An abstract document iterator helping in the implementation of ConsecutiveDocumentIterator and OrderedAndDocumentIterator.

Nested Class Summary

Nested classes/interfaces inherited from class it.unimi.di.mg4j.search.AbstractCompositeDocumentIterator

AbstractCompositeDocumentIterator.AbstractCompositeIndexIntervalIterator, AbstractCompositeDocumentIterator.AbstractCompositeIntervalIterator

Field Summary

Fields inherited from class it.unimi.di.mg4j.search.AbstractIntersectionDocumentIterator

lastIterator, sortedIterator

Fields inherited from class it.unimi.di.mg4j.search.AbstractCompositeDocumentIterator

documentIterator, indexIterator, indexIteratorsWithoutPositions, n

Fields inherited from class it.unimi.di.mg4j.search.AbstractIntervalDocumentIterator

currentIterators, indices, intervalIterators, soleIndex, soleIntervalIterator, unmodifiableCurrentIterators

Fields inherited from class it.unimi.di.mg4j.search.AbstractDocumentIterator

curr, weight

Fields inherited from interface it.unimi.di.mg4j.search.DocumentIterator

END_OF_LIST

Constructor Summary

protected

AbstractOrderedIntervalDocumentIterator(Object arg, DocumentIterator[] documentIterator) Creates a new abstract document iterator.

Method Summary

IntervalIterator	intervalIterator() Returns the interval iterator of this document iterator for single-index queries.
IntervalIterator	intervalIterator(Index index) Returns the interval iterator of this document iterator for the given index.
Reference2ReferenceMap<Index,IntervalIterator>	intervalIterators() Returns an unmodifiable map from indices to interval iterators.
int	nextDocument() Returns the next document provided by this document iterator, or DocumentIterator.END_OF_LIST if no more documents are available.
int	skipTo(int n) Skips all documents smaller than n.

Methods inherited from class it.unimi.di.mg4j.search.AbstractIntersectionDocumentIterator

align

Methods inherited from class it.unimi.di.mg4j.search.AbstractCompositeDocumentIterator

accept, acceptOnTruePaths, dispose, toString

Methods inherited from class it.unimi.di.mg4j.search.AbstractIntervalDocumentIterator

allIndexIterators, getIntervalIterator, indices, indices

Methods inherited from class it.unimi.di.mg4j.search.AbstractDocumentIterator

document, ensureOnADocument, mayHaveNext, weight, weight

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.di.mg4j.search.DocumentIterator

document, indices, mayHaveNext, weight, weight

Constructor Detail

AbstractOrderedIntervalDocumentIterator

protected AbstractOrderedIntervalDocumentIterator(Object arg,
                                                  DocumentIterator[] documentIterator)

Creates a new abstract document iterator.

Parameters:

arg - an argument that will be passed to AbstractIntervalDocumentIterator.getIntervalIterator(Index, int, boolean, Object).

documentIterator - the underlying document iterators (at least one). The must all return the same singleton set as DocumentIterator.indices().

Method Detail

nextDocument

public int nextDocument()
                 throws IOException

Description copied from interface: DocumentIterator

Returns the next document provided by this document iterator, or DocumentIterator.END_OF_LIST if no more documents are available.

Returns:

the next document, or DocumentIterator.END_OF_LIST if no more documents are available.

Throws:

IOException

skipTo

public int skipTo(int n)
           throws IOException

Description copied from interface: DocumentIterator

Skips all documents smaller than n.

Define the current document k associated with this document iterator as follows:

• -1, if DocumentIterator.nextDocument() and this method have never been called;
• DocumentIterator.END_OF_LIST, if a call to this method or to DocumentIterator.nextDocument() returned DocumentIterator.END_OF_LIST;
• the last value returned by a call to DocumentIterator.nextDocument() or this method, otherwise.

If k is larger than or equal to n, then this method does nothing and returns k. Otherwise, a call to this method is equivalent to

 while( ( k = nextDocument() ) < n );
 return k;
 

Thus, when a result k ≠ DocumentIterator.END_OF_LIST is returned, the state of this iterator will be exactly the same as after a call to DocumentIterator.nextDocument() that returned k. In particular, the first document larger than or equal to n (when returned by this method) will not be returned by the next call to DocumentIterator.nextDocument().

Parameters:

n - a document pointer.

Returns:

a document pointer larger than or equal to n if available, DocumentIterator.END_OF_LIST otherwise.

Throws:

IOException

intervalIterators

public Reference2ReferenceMap<Index,IntervalIterator> intervalIterators()
                                                                 throws IOException

Description copied from interface: DocumentIterator

Returns an unmodifiable map from indices to interval iterators.

After a call to DocumentIterator.nextDocument(), this map can be used to retrieve the intervals in the current document. An invocation of Map.get(java.lang.Object) on this map with argument index yields the same result as intervalIterator(index).

Specified by:

intervalIterators in interface DocumentIterator

Overrides:

intervalIterators in class AbstractIntersectionDocumentIterator

Returns:

a map from indices to interval iterators over the current document.

Throws:

IOException

See Also:

DocumentIterator.intervalIterator(Index)

intervalIterator

public IntervalIterator intervalIterator()
                                  throws IOException

Description copied from interface: DocumentIterator

Returns the interval iterator of this document iterator for single-index queries.

This is a commodity method that can be used only for queries built over a single index.

Returns:

an interval iterator.

Throws:

IOException

See Also:

DocumentIterator.intervalIterator(Index)

intervalIterator

public IntervalIterator intervalIterator(Index index)
                                  throws IOException

Description copied from interface: DocumentIterator

Returns the interval iterator of this document iterator for the given index.

After a call to DocumentIterator.nextDocument(), this iterator can be used to retrieve the intervals in the current document (the one returned by DocumentIterator.nextDocument()) for the index index.

Note that if all indices have positions, it is guaranteed that at least one index will return an interval. However, for disjunctive queries it cannot be guaranteed that all indices will return an interval.

Indices without positions always return IntervalIterators.TRUE. Thus, in presence of indices without positions it is possible that no intervals at all are available.

Parameters:

index - an index (must be one over which the query was built).

Returns:

an interval iterator over the current document in index.

Throws:

IOException