it.unimi.di.big.mg4j.index

Class IndexIntervalIterator

java.lang.Object

it.unimi.di.big.mg4j.index.IndexIntervalIterator

All Implemented Interfaces:

IntervalIterator

public final class IndexIntervalIterator
extends Object
implements IntervalIterator

An interval iterator returning the positions of the current document as singleton intervals.

Constructor Summary

Constructors

Constructor and Description
IndexIntervalIterator(IndexIterator indexIterator)

Method Summary

Methods

Modifier and Type	Method and Description
int	extent() Returns an approximation of a lower bound for the length of an interval returned by this iterator.
void	intervalTerms(LongSet terms) Provides the set of terms that span the current interval.
Interval	nextInterval() Returns the next interval provided by this interval iterator, or null if no more intervals are available.
IndexIntervalIterator	reset() A no-op.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexIntervalIterator

public IndexIntervalIterator(IndexIterator indexIterator)

Method Detail

reset

public IndexIntervalIterator reset()
                            throws IOException

A no-op.

Specified by:

reset in interface IntervalIterator

Returns:

this iterator.

Throws:

IOException

intervalTerms

public void intervalTerms(LongSet terms)

Description copied from interface: IntervalIterator

Provides the set of terms that span the current interval.

For each interval returned by MG4J, there is a set of terms that caused the interval to be returned. The terms appear inside the interval, and certainly at its extremes.

Note that the results of this method must be taken with a grain of salt: there might be different sets of terms causing the current interval, and only one will be returned.

Specified by:

intervalTerms in interface IntervalIterator

Parameters:

terms - a set of integers that will be filled with the terms spanning the current interval.

nextInterval

public Interval nextInterval()
                      throws IOException

Description copied from interface: IntervalIterator

Returns the next interval provided by this interval iterator, or null if no more intervals are available.

Specified by:

nextInterval in interface IntervalIterator

Returns:

the next interval, or null if no more intervals are available.

Throws:

IOException

extent

public int extent()

Description copied from interface: IntervalIterator

Returns an approximation of a lower bound for the length of an interval returned by this iterator.

Specified by:

extent in interface IntervalIterator

Returns:

an approximation of a lower bound for the length of an interval.