it.unimi.dsi.mg4j.index
Class Index.EmptyIndexIterator

java.lang.Object
  it.unimi.dsi.fastutil.ints.AbstractIntIterator
      it.unimi.dsi.fastutil.ints.AbstractIntBidirectionalIterator
          it.unimi.dsi.fastutil.ints.AbstractIntListIterator
              it.unimi.dsi.fastutil.ints.IntIterators.EmptyIterator
                  it.unimi.dsi.mg4j.index.Index.EmptyIndexIterator

All Implemented Interfaces:

BidirectionalIterator<Integer>, IntBidirectionalIterator, IntIterator, IntListIterator, ObjectBidirectionalIterator<Integer>, ObjectIterator<Integer>, IndexIterator, DocumentIterator, Serializable, Cloneable, Iterable<Interval>, Iterator<Integer>, ListIterator<Integer>

Enclosing class:

Index

public class Index.EmptyIndexIterator
extends IntIterators.EmptyIterator
implements IndexIterator, Serializable

An iterator returning no documents based on this index.

Note that accept(DocumentIteratorVisitor) does nothing and returns true, whereas acceptOnTruePaths(DocumentIteratorVisitor) throws an IllegalStateException, weight() returns 1 and weight(double) is a no-op.

See Also:

Serialized Form

Field Summary

int	id
String	term
int	termNumber
double	weight

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

END_OF_LIST

Constructor Summary

Index.EmptyIndexIterator()

Method Summary

<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.
int	count() Returns the count, that is, the number of occurrences of the term in the current document.
void	dispose() Disposes this document iterator, releasing all resources.
int	document() Returns the last document returned by DocumentIterator.nextDocument().
int	frequency() Returns the frequency, that is, the number of documents that will be returned by this iterator.
int	id() Returns the id of this index iterator.
IndexIterator	id(int id) Sets the id of this index iterator.
Index	index() Returns the index over which this iterator is built.
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.
IntervalIterator	iterator() An alias for DocumentIterator.intervalIterator(), that has the same limitations (i.e., it will work only if there is just one index), and that catches IOExceptions.
int	nextDocument() Returns the next document provided by this document iterator, or -1 if no more documents are available.
Payload	payload() Returns the payload, if any, associated with the current document.
int[]	positionArray() Returns the positions at which the term appears in the current document in an array.
IntIterator	positions() Returns the positions at which the term appears in the current document.
int	positions(int[] positions) Stores the positions at which the term appears in the current document in a given array.
int	skipTo(int n) Skips all documents smaller than n.
String	term() Returns the term whose inverted list is returned by this index iterator.
Index.EmptyIndexIterator	term(CharSequence term) Sets the term whose inverted list is returned by this index iterator.
int	termNumber() Returns the number of the term whose inverted list is returned by this index iterator.
IndexIterator	termNumber(int termNumber)
double	weight() Returns the weight associated with this iterator.
IndexIterator	weight(double weight) Returns the weight of this index iterator.

Methods inherited from class it.unimi.dsi.fastutil.ints.IntIterators.EmptyIterator

back, clone, hasNext, hasPrevious, nextIndex, nextInt, previousIndex, previousInt, skip

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntListIterator

add, add, set, set

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntBidirectionalIterator

previous

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntIterator

next, remove

Methods inherited from class java.lang.Object

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

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

nextInt

Methods inherited from interface it.unimi.dsi.fastutil.ints.IntIterator

skip

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.util.ListIterator

next, previous, remove

Methods inherited from interface it.unimi.dsi.fastutil.BidirectionalIterator

previous

Field Detail

term

public String term

weight

public double weight

id

public int id

termNumber

public int termNumber

Constructor Detail

Index.EmptyIndexIterator

public Index.EmptyIndexIterator()

Method Detail

document

public int document()

Description copied from interface: DocumentIterator

Returns the last document returned by DocumentIterator.nextDocument().

Specified by:

document in interface DocumentIterator

Returns:

the last document returned by DocumentIterator.nextDocument(), -1 if no document has been returned yet, and DocumentIterator.END_OF_LIST if the list of results has been exhausted.

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.

intervalIterator

public IntervalIterator intervalIterator()

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.

See Also:

DocumentIterator.intervalIterator(Index)

intervalIterators

public Reference2ReferenceMap<Index,IntervalIterator> intervalIterators()

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.

See Also:

DocumentIterator.intervalIterator(Index)

intervalIterator

public IntervalIterator intervalIterator(Index index)

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.

nextDocument

public int nextDocument()

Description copied from interface: DocumentIterator

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

Warning: the specification of this method has significantly changed as of MG4J 1.2. The special return value -1 is used to mark the end of iteration (a NoSuchElementException would have been thrown before in that case, so ho harm should be caused by this change). The reason for this change is providing fully lazy iteration over documents. Fully lazy iteration does not provide an hasNext() method—you have to actually ask for the next element and check the return value. Fully lazy iteration is much lighter on method calls (half) and in most (if not all) MG4J classes leads to a much simpler logic. Moreover, DocumentIterator.nextDocument() can be specified as throwing an IOException, which avoids the pernicious proliferation of try/catch blocks in very short, low-level methods (it was having a detectable impact on performance).

Specified by:

nextDocument in interface DocumentIterator

Returns:

the next document, or -1 if no more documents are available.

skipTo

public int skipTo(int n)

Description copied from interface: DocumentIterator

Skips all documents smaller than n. If Iterator.hasNext() has been called returning true but DocumentIterator.nextDocument() has not been called afterwards, then a call to DocumentIterator.skipTo(int) will be implicitly preceded by a call to DocumentIterator.nextDocument() (the only consequence is that skipping to the current document after a call to Iterator.hasNext() will return the next document).

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 returned DocumentIterator.END_OF_LIST, or DocumentIterator.nextDocument() returned -1;
• 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 && k != -1 );
 return k == -1 ? END_OF_LIST : 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.

frequency

public int frequency()

Description copied from interface: IndexIterator

Returns the frequency, that is, the number of documents that will be returned by this iterator.

Specified by:

frequency in interface IndexIterator

Returns:

the number of documents that will be returned by this iterator.

payload

public Payload payload()

Description copied from interface: IndexIterator

Returns the payload, if any, associated with the current document.

Specified by:

payload in interface IndexIterator

Returns:

the payload associated with the current document.

count

public int count()

Description copied from interface: IndexIterator

Returns the count, that is, the number of occurrences of the term in the current document.

Specified by:

count in interface IndexIterator

Returns:

the count (number of occurrences) of the term in the current document.

positions

public IntIterator positions()

Description copied from interface: IndexIterator

Returns the positions at which the term appears in the current document.

Specified by:

positions in interface IndexIterator

Returns:

the positions of the current document in which the current term appears.

positions

public int positions(int[] positions)

Description copied from interface: IndexIterator

Stores the positions at which the term appears in the current document in a given array.

If the array is not large enough (i.e., it does not contain IndexIterator.count() elements), this method will return a negative number (the opposite of the count).

Specified by:

positions in interface IndexIterator

Parameters:

positions - an array that will be used to store positions.

Returns:

the count; it will have the sign changed if positions cannot hold all positions.

positionArray

public int[] positionArray()

Description copied from interface: IndexIterator

Returns the positions at which the term appears in the current document in an array.

Implementations are allowed to return the same array across different calls to this method.

Specified by:

positionArray in interface IndexIterator

Returns:

an array whose first IndexIterator.count() elements contain the document positions.

dispose

public void dispose()

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

index

public Index index()

Description copied from interface: IndexIterator

Returns the index over which this iterator is built.

Specified by:

index in interface IndexIterator

Returns:

the index over which this iterator is built.

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)

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.

See Also:

DocumentIterator.accept(DocumentIteratorVisitor), CounterCollectionVisitor

term

public String term()

Description copied from interface: IndexIterator

Returns the term whose inverted list is returned by this index iterator.

Usually, the term is automatically set by IndexReader.documents(CharSequence) or IndexReader.documents(int), but you can supply your own term with IndexIterator.term(CharSequence).

Specified by:

term in interface IndexIterator

Returns:

the term over which this iterator is built, as a compact mutable string.

See Also:

IndexIterator.termNumber()

term

public Index.EmptyIndexIterator term(CharSequence term)

Description copied from interface: IndexIterator

Sets the term whose inverted list is returned by this index iterator.

Usually, the term is automatically set by Index.documents(CharSequence) or by IndexReader.documents(CharSequence), but you can use this method to ensure that IndexIterator.term() doesn't throw an exception.

Specified by:

term in interface IndexIterator

Parameters:

term - a character sequence (that will be defensively copied) that will be assumed to be the term whose inverted list is returned by this index iterator.

Returns:

this index iterator.

id

public int id()

Description copied from interface: IndexIterator

Returns the id of this index iterator.

Specified by:

id in interface IndexIterator

Returns:

the id of this index iterator.

See Also:

IndexIterator.id(int)

id

public IndexIterator id(int id)

Description copied from interface: IndexIterator

Sets the id of this index iterator.

The id is an integer associated with each index iterator. It has no specific semantics, and can be used differently in different contexts. A typical usage pattern, for instance, is using it to assign a unique number to the index iterators contained in a composite document iterator (say, numbering consecutively the leaves of the composite).

Specified by:

id in interface IndexIterator

Parameters:

id - the new id for this index iterator.

Returns:

this index iterator.

iterator

public IntervalIterator iterator()

Description copied from interface: DocumentIterator

An alias for DocumentIterator.intervalIterator(), that has the same limitations (i.e., it will work only if there is just one index), and that catches IOExceptions.

Specified by:

iterator in interface DocumentIterator

Specified by:

iterator in interface Iterable<Interval>

Returns:

an interval iterator.

termNumber

public int termNumber()

Description copied from interface: IndexIterator

Returns the number of the term whose inverted list is returned by this index iterator.

Usually, the term number is automatically set by IndexReader.documents(CharSequence) or IndexReader.documents(int).

Specified by:

termNumber in interface IndexIterator

Returns:

the number of the term over which this iterator is built.

See Also:

IndexIterator.term()

termNumber

public IndexIterator termNumber(int termNumber)

weight

public double weight()

Description copied from interface: DocumentIterator

Returns the weight associated with this iterator.

The number returned by this method has no fixed semantics: different scorers might choose different interpretations, or even ignore it.

Specified by:

weight in interface DocumentIterator

Returns:

the weight associated with this iterator.

weight

public IndexIterator weight(double weight)

Description copied from interface: IndexIterator

Returns the weight of this index iterator.

Specified by:

weight in interface IndexIterator

Specified by:

weight in interface DocumentIterator

Parameters:

weight - the weight of this index iterator.

Returns:

this document iterator.

See Also:

DocumentIterator.weight(double)