org.terrier.realtime.multi

Class MultiDoc

java.lang.Object

org.terrier.realtime.multi.MultiDoc

All Implemented Interfaces:

DocumentIndex

public class MultiDoc
extends Object
implements DocumentIndex

A Document index class that represents multiple document indices from different shards. It is used within MultiIndex.

Since:

4.0

Author:

Richard McCreadie, Stuart Mackie

Constructor Summary

Constructors

Constructor and Description
MultiDoc(DocumentIndex[] docs, int[] offsets) constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DocumentIndexEntry	getDocumentEntry(int docid) Get the document index entry based on its docid
int	getDocumentLength(int docid) Get the length of the document
int	getNumberOfDocuments() Get the number of documents

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiDoc

public MultiDoc(DocumentIndex[] docs,
        int[] offsets)

constructor.

Method Detail

getDocumentEntry

public DocumentIndexEntry getDocumentEntry(int docid)
                                    throws IOException

Get the document index entry based on its docid

Specified by:

getDocumentEntry in interface DocumentIndex

Throws:

IOException

getDocumentLength

public int getDocumentLength(int docid)
                      throws IOException

Get the length of the document

Specified by:

getDocumentLength in interface DocumentIndex

Throws:

IOException

getNumberOfDocuments

public int getNumberOfDocuments()

Get the number of documents

Specified by:

getNumberOfDocuments in interface DocumentIndex