org.terrier.realtime.memory

Class MemoryDocumentIndexMap

java.lang.Object

org.terrier.realtime.memory.MemoryDocumentIndex

org.terrier.realtime.memory.MemoryDocumentIndexMap

All Implemented Interfaces:

Serializable, DocumentIndex

Direct Known Subclasses:

MemoryDocumentIndexFieldsMap

public class MemoryDocumentIndexMap
extends MemoryDocumentIndex

This class is a special variant of the Memory index class where the Document index is backed by a fast mapping structure in memory.

Since:

4.0

Author:

Richard McCreadie, Dyaa Albakour

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MemoryDocumentIndexMap.DocumentMapIterator2 Document index iterator, iterates over DocumentIndexEntry only.

Nested classes/interfaces inherited from class org.terrier.realtime.memory.MemoryDocumentIndex

MemoryDocumentIndex.DocumentIterator, MemoryDocumentIndex.DocumentIterator2

Field Summary

Fields inherited from class org.terrier.realtime.memory.MemoryDocumentIndex

docLengths

Constructor Summary

Constructors

Constructor and Description
MemoryDocumentIndexMap() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addDocument(int length) Add document length to document index.
void	addDocument(int docid, int length) Add document length to document index.
void	close()
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 org.terrier.realtime.memory.MemoryDocumentIndex

setLength

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryDocumentIndexMap

public MemoryDocumentIndexMap()

Constructor.

Method Detail

addDocument

public void addDocument(int docid,
                        int length)

Add document length to document index.

addDocument

public void addDocument(int length)

Description copied from class: MemoryDocumentIndex

Add document length to document index.

Overrides:

addDocument in class MemoryDocumentIndex

getDocumentEntry

public DocumentIndexEntry getDocumentEntry(int docid)

Get the document index entry based on its docid

Specified by:

getDocumentEntry in interface DocumentIndex

Overrides:

getDocumentEntry in class MemoryDocumentIndex

getDocumentLength

public int getDocumentLength(int docid)

Get the length of the document

Specified by:

getDocumentLength in interface DocumentIndex

Overrides:

getDocumentLength in class MemoryDocumentIndex

getNumberOfDocuments

public int getNumberOfDocuments()

Description copied from class: MemoryDocumentIndex

Get the number of documents

Specified by:

getNumberOfDocuments in interface DocumentIndex

Overrides:

getNumberOfDocuments in class MemoryDocumentIndex

iteratorOverEntries

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

Description copied from class: MemoryDocumentIndex

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.

Overrides:

iteratorOverEntries in class MemoryDocumentIndex

iterator

public Iterator<DocumentIndexEntry> iterator()

Description copied from class: MemoryDocumentIndex

Return an iterator over the document index.

Overrides:

iterator in class MemoryDocumentIndex

close

public void close()