Package org.terrier.realtime.multi

Class MultiDoc

java.lang.Object

org.terrier.realtime.multi.MultiDoc

All Implemented Interfaces:

DocumentIndex

public class MultiDoc
extends java.lang.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	Description
MultiDoc(DocumentIndex[] docs, int[] offsets)	constructor.

Method Summary

Modifier and Type	Method	Description
DocumentIndexEntry	getDocumentEntry(int docid)	Return the document index entry based on its docid.
int	getDocumentLength(int docid)	Return the length of the document.
int	getNumberOfDocuments()	Return 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 java.io.IOException

Return the document index entry based on its docid.

Specified by:

getDocumentEntry in interface DocumentIndex

Returns:

the document index entry based on its docid.

Throws:

java.io.IOException

getDocumentLength

public int getDocumentLength(int docid)
                      throws java.io.IOException

Return the length of the document.

Specified by:

getDocumentLength in interface DocumentIndex

Returns:

the length of the document.

Throws:

java.io.IOException

getNumberOfDocuments

public int getNumberOfDocuments()

Return the number of documents.

Specified by:

getNumberOfDocuments in interface DocumentIndex

Returns:

the number of documents.