it.unimi.di.mg4j.index.cluster
Class DocumentalClusterIndexReader

java.lang.Object
  it.unimi.di.mg4j.index.AbstractIndexReader
      it.unimi.di.mg4j.index.cluster.AbstractIndexClusterIndexReader
          it.unimi.di.mg4j.index.cluster.DocumentalClusterIndexReader

All Implemented Interfaces:

IndexReader, SafelyCloseable, Closeable

public class DocumentalClusterIndexReader
extends AbstractIndexClusterIndexReader

An index reader for a DocumentalCluster. It dispatches the correct IndexReader depending on the concrete subclass of DocumentalCluster.

Author:

Sebastiano Vigna

Field Summary

protected DocumentalCluster

index The index this reader refers to.

Fields inherited from class it.unimi.di.mg4j.index.cluster.AbstractIndexClusterIndexReader

indexReader

Fields inherited from class it.unimi.di.mg4j.index.AbstractIndexReader

closed

Constructor Summary

DocumentalClusterIndexReader(DocumentalCluster index, int bufferSize)

Method Summary

IndexIterator	documents(CharSequence term) Returns an index iterator over the documents containing a term; the term is given explicitly.
IndexIterator	documents(int term) Returns a document iterator over the documents containing a term.

Methods inherited from class it.unimi.di.mg4j.index.cluster.AbstractIndexClusterIndexReader

close

Methods inherited from class it.unimi.di.mg4j.index.AbstractIndexReader

finalize, nextIterator

Methods inherited from class java.lang.Object

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

Field Detail

index

protected final DocumentalCluster index

The index this reader refers to.

Constructor Detail

DocumentalClusterIndexReader

public DocumentalClusterIndexReader(DocumentalCluster index,
                                    int bufferSize)
                             throws IOException

Throws:

IOException

Method Detail

documents

public IndexIterator documents(int term)
                        throws IOException

Description copied from interface: IndexReader

Returns a document iterator over the documents containing a term.

Note that the index iterator returned by this method will return null on a call to term().

Note that it is always possible to call this method with argument 0, even if the underlying index does not provide random access.

Parameters:

term - the number of a term.

Throws:

IOException

documents

public IndexIterator documents(CharSequence term)
                        throws IOException

Description copied from interface: IndexReader

Returns an index iterator over the documents containing a term; the term is given explicitly.

Unless the term processor of the associated index is null, words coming from a query will have to be processed before being used with this method.

Note that the index iterator returned by this method will return term on a call to term().

Parameters:

term - a term (the term will be downcased if the index is case insensitive).

Throws:

IOException