org.terrier.realtime.memory.fields

Class MemoryFields

java.lang.Object

org.terrier.structures.Index

org.terrier.realtime.memory.MemoryIndex

org.terrier.realtime.memory.fields.MemoryFields

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, UpdatableIndex, WritableIndex

Direct Known Subclasses:

MemoryFieldsIndex

public abstract class MemoryFields
extends MemoryIndex

Super-type of fields index implementations.

Since:

4.0

Author:

Stuart Mackie

Nested Class Summary

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

Index.UpdatingCollectionStatistics

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	docFields
protected FieldDocumentPostingList	fdpl
protected TermPipeline	pipeline

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

blocks, compressionConfig, document, fieldIDs, fields, fieldtags, indexingLock, inverted, lexicon, logger, metadata, 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
MemoryFields() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	collectProperties(Index memory, Index index, CompressionFactory.CompressionConfiguration compressionConfig) Collect index properties.
FieldDocumentIndex	getDocumentIndex() Return the DocumentIndex associated with this index

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

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

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

Field Detail

pipeline

protected TermPipeline pipeline

fdpl

protected FieldDocumentPostingList fdpl

docFields

protected Set<String> docFields

Constructor Detail

MemoryFields

public MemoryFields()

Constructor.

Method Detail

getDocumentIndex

public FieldDocumentIndex getDocumentIndex()

Return the DocumentIndex associated with this index

Overrides:

getDocumentIndex in class MemoryIndex

collectProperties

public void collectProperties(Index memory,
                     Index index,
                     CompressionFactory.CompressionConfiguration compressionConfig)

Collect index properties.

Specified by:

collectProperties in interface WritableIndex

Overrides:

collectProperties in class MemoryIndex