org.terrier.realtime.memory.fields

Class MemoryFieldsIndex

java.lang.Object

org.terrier.structures.Index

org.terrier.realtime.memory.MemoryIndex

org.terrier.realtime.memory.fields.MemoryFields

org.terrier.realtime.memory.fields.MemoryFieldsIndex

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, UpdatableIndex, WritableIndex

public class MemoryFieldsIndex
extends MemoryFields

An in-memory incremental fields index (non-compressed).

Since:

4.0

Author:

Stuart Mackie

Nested Class Summary

Nested classes/interfaces inherited from class org.terrier.structures.Index

Index.UpdatingCollectionStatistics

Field Summary

Fields inherited from class org.terrier.realtime.memory.fields.MemoryFields

docFields, fdpl, pipeline

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

blocks, compressionConfig, docPostings, document, fieldIDs, fields, fieldtags, indexingLock, inverted, lexicon, logger, metadata, pipeline_first, PIPELINE_NAMESPACE, stats

Fields inherited from class org.terrier.structures.Index

dirtyProperties, EMPTY_CLASS_ARRAY, lastLoadError, MINIMUM_INDEX_TERRIER_VERSION, properties, PROPERTIES_SUFFIX, RETRIEVAL_LOADING_PROFILE

Constructor Summary

Constructors

Constructor and Description
MemoryFieldsIndex() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	indexDocument(Document doc) Index a new document.
void	indexDocument(Map<String,String> docProperties, DocumentPostingList docContents) Index a new document.
Index	merge(String diskpath, String diskprefix, String newpath, String newprefix) Not implemented.
Index	write(String path, String prefix) Write index structures to disk.

Methods inherited from class org.terrier.realtime.memory.fields.MemoryFields

collectProperties, getDocumentIndex, getEndOfPipeline

Methods inherited from class org.terrier.realtime.memory.MemoryIndex

addToDocument, addToDocument, close, flush, getCollectionStatistics, getDirectIndex, getIndexStructure, getIndexStructureInputStream, getInvertedIndex, getLexicon, getMetaIndex, load_pipeline, removeDocument, toString

Methods inherited from class org.terrier.structures.Index

addIndexStructure, addIndexStructure, addIndexStructure, addIndexStructure, addIndexStructureInputStream, addIndexStructureInputStream, addIndexStructureInputStream, addIndexStructureInputStream, allExists, createIndex, createIndex, createNewIndex, existsIndex, getEnd, getIndexLoadingProfileAsRetrieval, getIndexProperty, getIntIndexProperty, getLastIndexLoadError, getProperties, getStart, hasIndexStructure, hasIndexStructureInputStream, join, main, setIndexLoadingProfileAsRetrieval, setIndexProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryFieldsIndex

public MemoryFieldsIndex()

Constructor.

Method Detail

indexDocument

public void indexDocument(Map<String,String> docProperties,
                 DocumentPostingList docContents)
                   throws Exception

Index a new document.

Specified by:

indexDocument in interface UpdatableIndex

Overrides:

indexDocument in class MemoryIndex

Throws:

Exception

indexDocument

public void indexDocument(Document doc)
                   throws Exception

Index a new document.

Specified by:

indexDocument in interface UpdatableIndex

Overrides:

indexDocument in class MemoryIndex

Throws:

Exception

write

public Index write(String path,
          String prefix)
            throws IOException

Write index structures to disk.

Specified by:

write in interface WritableIndex

Overrides:

write in class MemoryIndex

Throws:

IOException

merge

public Index merge(String diskpath,
          String diskprefix,
          String newpath,
          String newprefix)
            throws IOException

Not implemented.

Throws:

IOException