Package org.terrier.structures

Provides the classes that implement the data structures used for retrieval with the Terrier platform.

See: Description

Interface Summary

Interface	Description
BitFilePosition	A bit file position
BitIndexPointer	A pointer implementation for BitPostingIndex structures.
BlockEntryStatistics	Interface describing the statistics for a block entry.
Closeable	Deprecated Use java.io.Closeable instead
DocumentIndex	Interface for a document index.
EntryStatistics	An interface for basic statistics about a lexical entry (usually a term)
FieldDocumentIndex	Interface for a fields document index
FieldEntryStatistics	The statistics for a field entry
IndexConfigurable	Interface defining that an index structure wants access to the Index object it is associated with.
MapLexicon.Id2EntryIndexLookup	Interface for getting the lexicon term index for a given term id
MetaIndex	Interface for document metadata.
Pointer	A base interface for all pointers
PostingIndex<POINTERTYPE extends Pointer>	An interface for accessing a posting list.
PostingIndexInputStream	Interface for reading postings from an input stream
Skipable	Interface denoting implementations which can skip forward in a stream by a number of entries.

Class Summary

Class	Description
AbstractPostingOutputStream	Abstract class that is extended by other posting output stream implementations
BasicDocumentIndexEntry	A basic document index entry.
BasicDocumentIndexEntry.Factory	Returna a factory for creating document index entries
BasicLexiconEntry	Contains all the information about one entry in the Lexicon.
BasicLexiconEntry.Factory	Factory for creating LexiconEntry objects
BasicTermStatsLexiconEntry	A LexiconEntry which only contains EntryStatistics
BlockFieldLexiconEntry	A LexiconEntry with field support
BlockFieldLexiconEntry.Factory	Factory for creating LexiconEntries
BlockLexiconEntry	Deprecated
BlockLexiconEntry.Factory	Factory for creating block lexicon entries
CollectionStatistics	This class provides basic statistics for the indexed collection of documents, such as the average length of documents, or the total number of documents in the collection.
CompressingMetaIndex	A MetaIndex implementation that compresses contents.
CompressingMetaIndex.CompressingMetaIndexInputFormat	A Hadoop input format for a compressing meta index (allows the reading of a meta index as input to a MapReduce job.
CompressingMetaIndex.InputStream	An iterator for reading a MetaIndex as a stream
DocumentIndexEntry	A document index entry.
FieldDocumentIndexEntry	A document index entry for use with fields
FieldDocumentIndexEntry.Factory	Factory for creating a field document index entry
FieldLexiconEntry	A LexiconEntry with field support
FieldLexiconEntry.Factory	Factory for a LexiconEntry
FilePosition	Models a position within a file as the offset in bytes and the offset in bits in that byte.
FSADocumentIndex	Document Index saved as a fixed size array
FSADocumentIndex.FSADocumentIndexIterator	Gets an iterator over the documents in this index
FSAFieldDocumentIndex	Fields document index stored as a fixed size array
FSOMapFileLexicon	Instance of a Lexicon where a FSOrderedMapFile is always used as a backing store.
FSOMapFileLexicon.MapFileLexiconEntryIterator	Iterate through the values in order
FSOMapFileLexicon.MapFileLexiconIterator	An iterator over the lexicon
FSOMapFileLexiconOutputStream	A LexiconOutputStream for FSOMapFileLexicon.
Index	This class encapsulates all the Indexes at retrieval time.
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
IndexUtil	Class with handy utilities for use on an Index.
Lexicon<KEY>	Abstract Lexicon implementation.
LexiconEntry	Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
LexiconOutputStream<KEY>	This class implements an output stream for the lexicon structure.
LexiconUtil	Lexicon utilities class.
MapLexicon	Implementation of a lexicon.
MapLexicon.IdIsIndex	Lexicon map where the termid is the term index
NonIncrementalDocumentIndexEntry	This class is created to represent a DocumentIndexEntry that do not assume an incremental docids, but instead maintains the docid.
NonIncrementalDocumentIndexEntry.Factory	Returna a factory for creating document index entries
PostingIndex.DocidSpecificDocumentIndex
SimpleBitIndexPointer	An implementation of a BitIndexPointer.
SimpleBitIndexPointer.Factory	Factory class for SimpleBitIndexPointer.
SimpleDocumentIndexEntry	A document index entry that doesn't write out direct index offset.
SimpleDocumentIndexEntry.Factory	Factory for the creation of DocumentIndexEntry objects
SingleLineTRECQuery	Deprecated
TRECQuery	Deprecated

Package org.terrier.structures Description

Provides the classes that implement the data structures used for retrieval with the Terrier platform.

These include the implementations of the inverted index, the direct index, the lexicon and the document index.