org.terrier.realtime.memory

Class MemoryDocumentIndex

java.lang.Object

org.terrier.realtime.memory.MemoryDocumentIndex

All Implemented Interfaces:

Serializable, DocumentIndex

Direct Known Subclasses:

MemoryDocumentIndexFields, MemoryDocumentIndexMap

public class MemoryDocumentIndex
extends Object
implements DocumentIndex, Serializable

An in-memory version of the Document index. Stores the length of each document.

Since:

4.0

Author:

Richard McCreadie, Stuart Mackie

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MemoryDocumentIndex.DocumentIterator Document index iterator.
class	MemoryDocumentIndex.DocumentIterator2 Document index iterator, iterates over DocumentIndexEntry only, not Entry.

Field Summary

Fields

Modifier and Type	Field and Description
gnu.trove.TIntArrayList	docLengths

Constructor Summary

Constructors

Constructor and Description
MemoryDocumentIndex() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocument(int length) Add document length to document index.
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
Iterator<DocumentIndexEntry>	iterator() Return an iterator over the document index.
Iterator<Map.Entry<Integer,DocumentIndexEntry>>	iteratorOverEntries() Return an iterator over the document index.

Methods inherited from class java.lang.Object

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

Field Detail

docLengths

public gnu.trove.TIntArrayList docLengths

Constructor Detail

MemoryDocumentIndex

public MemoryDocumentIndex()

Constructor.

Method Detail

addDocument

public void addDocument(int length)

Add document length to document index.

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

iteratorOverEntries

public Iterator<Map.Entry<Integer,DocumentIndexEntry>> iteratorOverEntries()

Return an iterator over the document index. iterates over Map.Entry, where the key is the integer docid - only used my the Memory index, not the index-on-disk.

iterator

public Iterator<DocumentIndexEntry> iterator()

Return an iterator over the document index.