Package it.unimi.di.big.mg4j.search

Class PayloadPredicateDocumentIterator

java.lang.Object

it.unimi.di.big.mg4j.search.AbstractDocumentIterator

it.unimi.di.big.mg4j.search.PayloadPredicateDocumentIterator

All Implemented Interfaces:

DocumentIterator

public class PayloadPredicateDocumentIterator
extends AbstractDocumentIterator
implements DocumentIterator

A document iterator that filters an IndexIterator, returning just documents whose payload satisfies a given predicate. The interval iterators are computed by delegation to the underlying IndexIterator.

Besides the classic skipTo(long) method, this class provides a skipUnconditionallyTo(long) method that skips to a given document even if the document does not match the predicate. This feature is fundamental to implement an efficient list intersection algorithm, as skipTo(long) is very expensive when the argument does not satisfy the predicate (as the next valid document must be searched for exhaustively).

Since:

0.9

Author:

Sebastiano Vigna

Field Summary

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

curr, weight

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

END_OF_LIST

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PayloadPredicateDocumentIterator(IndexIterator indexIterator, org.apache.commons.collections.Predicate payloadPredicate)	Creates a new payload-predicate document iterator over a given index iterator.

Method Summary

Modifier and Type	Method	Description
<T> T	accept(DocumentIteratorVisitor<T> visitor)	Accepts a visitor.
<T> T	acceptOnTruePaths(DocumentIteratorVisitor<T> visitor)	Accepts a visitor after a call to DocumentIterator.nextDocument(), limiting recursion to true paths.
void	dispose()	Disposes this document iterator, releasing all resources.
static PayloadPredicateDocumentIterator	getInstance(IndexIterator indexIterator, org.apache.commons.collections.Predicate payloadPredicate)	Returns a new payload-predicate document iterator over a given index iterator.
ReferenceSet<Index>	indices()	Returns the set of indices over which this iterator is built.
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.
boolean	mayHaveNext()	Returns whether there may be a next document, possibly with false positives.
long	nextDocument()	Returns the next document provided by this document iterator, or DocumentIterator.END_OF_LIST if no more documents are available.
long	skipTo(long n)	Skips all documents smaller than n.
long	skipUnconditionallyTo(long candidate)	Skips to the given document, even if the document does not satisfy the predicate of this document iterator.
String	toString()

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

document, ensureOnADocument, 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.big.mg4j.search.DocumentIterator

document, weight, weight

Constructor Detail

PayloadPredicateDocumentIterator

protected PayloadPredicateDocumentIterator(IndexIterator indexIterator,
                                           org.apache.commons.collections.Predicate payloadPredicate)

Creates a new payload-predicate document iterator over a given index iterator.

Parameters:

indexIterator - an index iterator.

payloadPredicate - a predicate on payloads that will be used to filter the documents returned by indexIterator.

Method Detail

getInstance

public static PayloadPredicateDocumentIterator getInstance(IndexIterator indexIterator,
                                                           org.apache.commons.collections.Predicate payloadPredicate)

Returns a new payload-predicate document iterator over a given index iterator.

Parameters:

indexIterator - an index iterator.

payloadPredicate - a predicate on payloads that will be used to filter the documents returned by indexIterator.

indices

public ReferenceSet<Index> indices()

Description copied from interface: DocumentIterator

Returns the set of indices over which this iterator is built.

Specified by:

indices in interface DocumentIterator

Returns:

the set of indices over which this iterator is built.

skipTo

public long skipTo(long 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().

Specified by:

skipTo in interface DocumentIterator

Parameters:

n - a document pointer.

Returns:

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

Throws:

IOException

skipUnconditionallyTo

public long skipUnconditionallyTo(long candidate)
                           throws IOException

Skips to the given document, even if the document does not satisfy the predicate of this document iterator.

Parameters:

candidate - a document pointer.

Returns:

assuming that p is the first document pointer larger than or equal to n, p if document p satisfies the predicate, -p-1 otherwise; if there is no document pointer larger than or equal to n, DocumentIterator.END_OF_LIST.

Throws:

IOException

See Also:

skipTo(long)

nextDocument

public long 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.

Specified by:

nextDocument in interface DocumentIterator

Returns:

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

Throws:

IOException

mayHaveNext

public boolean mayHaveNext()

Description copied from interface: DocumentIterator

Returns whether there may be a next document, possibly with false positives.

Specified by:

mayHaveNext in interface DocumentIterator

Overrides:

mayHaveNext in class AbstractDocumentIterator

Returns:

true there may be a next document; false if certainly there is no next document.

dispose

public void dispose()
             throws IOException

Description copied from interface: DocumentIterator

Disposes this document iterator, releasing all resources.

This method should propagate down to the underlying index iterators, where it should release resources such as open files and network connections. If you're doing your own resource tracking and pooling, then you do not need to call this method.

Specified by:

dispose in interface DocumentIterator

Throws:

IOException

accept

public <T> T accept(DocumentIteratorVisitor<T> visitor)
             throws IOException

Description copied from interface: DocumentIterator

Accepts a visitor.

A document iterator is usually structured as composite, with operators as internal nodes and IndexIterators as leaves. This method implements the visitor pattern.

Specified by:

accept in interface DocumentIterator

Parameters:

visitor - the visitor.

Returns:

an object resulting from the visit, or null if the visit was interrupted.

Throws:

IOException

acceptOnTruePaths

public <T> T acceptOnTruePaths(DocumentIteratorVisitor<T> visitor)
                        throws IOException

Description copied from interface: DocumentIterator

Accepts a visitor after a call to DocumentIterator.nextDocument(), limiting recursion to true paths.

After a call to DocumentIterator.nextDocument(), a document iterator is positioned over a document. This call is equivalent to DocumentIterator.accept(DocumentIteratorVisitor), but visits only along true paths.

We define a true path as a path from the root of the composite that passes only through nodes whose associated subtree is positioned on the same document of the root. Note that OrDocumentIterators detach exhausted iterators from the composite tree, so true paths define the subtree that is causing the current document to satisfy the query represented by this document iterator.

For more elaboration, and the main application of this method, see CounterCollectionVisitor.

Specified by:

acceptOnTruePaths in interface DocumentIterator

Parameters:

visitor - the visitor.

Returns:

an object resulting from the visit, or null if the visit was interrupted.

Throws:

IOException

See Also:

DocumentIterator.accept(DocumentIteratorVisitor), CounterCollectionVisitor

toString

public String toString()

Overrides:

toString in class Object

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

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.

Specified by:

intervalIterator in interface DocumentIterator

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.

Specified by:

intervalIterator in interface DocumentIterator

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