org.terrier.structures
Interface DocumentIndex

All Known Subinterfaces:

FieldDocumentIndex

All Known Implementing Classes:

FSADocumentIndex, FSAFieldDocumentIndex

public interface DocumentIndex

Interface for a document index.

Method Summary

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

Method Detail

getDocumentEntry

DocumentIndexEntry getDocumentEntry(int docid)
                                    throws IOException

Get the document index entry based on its docid

Throws:

IOException

getDocumentLength

int getDocumentLength(int docid)
                      throws IOException

Get the length of the document

Throws:

IOException

getNumberOfDocuments

int getNumberOfDocuments()

Get the number of documents