Uses of Package
org.terrier.structures

Packages that use org.terrier.structures

Package	Description
org.terrier.indexing	Provides classes and interfaces related to the indexing of documents.
org.terrier.matching	Provides the classes and interfaces used for matching documents to queries.
org.terrier.matching.daat	Provides classes that implement a document-at-a-time (DAAT) matching strategy.
org.terrier.matching.dsms	Provides the interface and the classes for modifying the scores of documents after an score has been assigned to documents, or implementing the combination of evidence.
org.terrier.matching.matchops	This package contains matching Operators.
org.terrier.matching.models	Provides the classes that implement various weighting models.
org.terrier.matching.models.dependence	Weighting models for term dependence models
org.terrier.matching.taat	Provides classes that implement a term-at-a-time (TAAT) matching strategy.
org.terrier.matching.tsms	Provides the interface and classes that implement the term score modifiers, which modify the scores assigned to documents for a particular term.
org.terrier.querying	Provides the interfaces and classes for the querying API of the Terrier platform, the controls, post processors and filters.
org.terrier.realtime	Provides index structures that support updating and real-time retrieval.
org.terrier.realtime.incremental	Provides incremental indexing functionality.
org.terrier.realtime.matching	Provides additional matching implementations specifically for real-time index structures.
org.terrier.realtime.memory	Provides MemoryIndex structures.
org.terrier.realtime.memory.fields	Provides MemoryIndex structures that support field search.
org.terrier.realtime.multi	Provides MultiIndex structures.
org.terrier.structures	Provides the interfaces for the index data structures used for retrieval with the Terrier platform.
org.terrier.structures.bit	Provides on-disk index structures that support the older bit-level compression scheme.
org.terrier.structures.collections	Provides data structures various data structures.
org.terrier.structures.concurrent
org.terrier.structures.indexing	Provides the classes used for creating the data structures of the Terrier platform.
org.terrier.structures.indexing.classical	Provides functionality for creating on-disk indices via indexer classes.
org.terrier.structures.indexing.singlepass	Provides implementation of the structures needed for performing a single pass indexing
org.terrier.structures.merging	Provides classes for merging two sets of data structures, created by Terrier, into one set of data structures.
org.terrier.structures.outputformat	Provides functionality for writing Terrier ResultSets to disk as .res files, e.g.
org.terrier.structures.postings	Provides classes representing single postings and atreams of postings in a posting list (e.g.
org.terrier.structures.postings.bit	Provides bit-level IterablePosting implementations.
org.terrier.structures.restructure	Contains legacy index data structure classes
org.terrier.tests

Classes in org.terrier.structures used by org.terrier.indexing

Class	Description
Index	Base class for all Index implementations

Classes in org.terrier.structures used by org.terrier.matching

Class	Description
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.
EntryStatistics	An interface for basic statistics about a lexicon entry.
Index	Base class for all Index implementations
Lexicon	A lexicon (a.k.a.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.

Classes in org.terrier.structures used by org.terrier.matching.daat

Class	Description
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.
EntryStatistics	An interface for basic statistics about a lexicon entry.
Index	Base class for all Index implementations

Classes in org.terrier.structures used by org.terrier.matching.dsms

Class	Description
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.
EntryStatistics	An interface for basic statistics about a lexicon entry.
Index	Base class for all Index implementations
LexiconEntry	Base class for all LexiconEntry implementations.

Classes in org.terrier.structures used by org.terrier.matching.matchops

Class	Description
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.
EntryStatistics	An interface for basic statistics about a lexicon entry.
Index	Base class for all Index implementations
Lexicon	A lexicon (a.k.a.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.

Classes in org.terrier.structures used by org.terrier.matching.models

Class	Description
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.
EntryStatistics	An interface for basic statistics about a lexicon entry.
Index	Base class for all Index implementations

Classes in org.terrier.structures used by org.terrier.matching.models.dependence

Class	Description
EntryStatistics	An interface for basic statistics about a lexicon entry.

Classes in org.terrier.structures used by org.terrier.matching.taat

Class	Description
Index	Base class for all Index implementations

Classes in org.terrier.structures used by org.terrier.matching.tsms

Class	Description
Index	Base class for all Index implementations
IndexConfigurable	Interface defining that an index structure wants access to the Index object it is associated with.

Classes in org.terrier.structures used by org.terrier.querying

Class	Description
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.
DocumentIndex	Interface for a document index.
Index	Base class for all Index implementations
Lexicon	A lexicon (a.k.a.
MetaIndex	Interface for document metadata.
PostingIndex	An interface for accessing a posting list.

Classes in org.terrier.structures used by org.terrier.realtime

Class	Description
Index	Base class for all Index implementations

Classes in org.terrier.structures used by org.terrier.realtime.incremental

Class	Description
Index	Base class for all Index implementations
IndexFactory.IndexLoader
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.

Classes in org.terrier.structures used by org.terrier.realtime.matching

Class	Description
Index	Base class for all Index implementations

Classes in org.terrier.structures used by org.terrier.realtime.memory

Class	Description
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.
DocumentIndex	Interface for a document index.
DocumentIndexEntry	A document index entry.
EntryStatistics	An interface for basic statistics about a lexicon entry.
Index	Base class for all Index implementations
IndexFactory.IndexLoader
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
Lexicon	A lexicon (a.k.a.
LexiconEntry	Base class for all LexiconEntry implementations.
MapLexicon	Implementation of a lexicon.
MetaIndex	Interface for document metadata.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.
PostingIndexInputStream	Interface for reading postings from an input stream

Classes in org.terrier.structures used by org.terrier.realtime.memory.fields

Class	Description
BitIndexPointer	A Pointer specialisation for some PostingIndex structures.
DocumentIndex	Interface for a document index.
DocumentIndexEntry	A document index entry.
EntryStatistics	An interface for basic statistics about a lexicon entry.
FieldDocumentIndex	Interface for a fields document index
FieldDocumentIndexEntry	A document index entry for use with fields
FieldEntryStatistics	The statistics for a field entry.
Index	Base class for all Index implementations
IndexFactory.IndexLoader
Lexicon	A lexicon (a.k.a.
LexiconEntry	Base class for all LexiconEntry implementations.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.
PostingIndexInputStream	Interface for reading postings from an input stream

Classes in org.terrier.structures used by org.terrier.realtime.multi

Class	Description
BitFilePosition	A (number of bytes, number of bits) position in a bit file.
BitIndexPointer	A Pointer specialisation for some PostingIndex structures.
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.
DocumentIndex	Interface for a document index.
DocumentIndexEntry	A document index entry.
EntryStatistics	An interface for basic statistics about a lexicon entry.
Index	Base class for all Index implementations
Lexicon	A lexicon (a.k.a.
LexiconEntry	Base class for all LexiconEntry implementations.
MetaIndex	Interface for document metadata.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.

Classes in org.terrier.structures used by org.terrier.structures

Class	Description
BaseCompressingMetaIndex	A MetaIndex implementation that compresses contents.
BaseCompressingMetaIndex.InputStream	An iterator for reading a MetaIndex as a stream
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.
BitFilePosition	A (number of bytes, number of bits) position in a bit file.
BitIndexPointer	A Pointer specialisation for some PostingIndex structures.
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	Implementation of BaseCompressingMetaIndex that uses Zlib deflate algorithm to compress entries
CompressingMetaIndex.InputStream
ConcurrentReadable	This annotation makes that an index data structure can be read by more than one thread concurrently.
DocumentIndex	Interface for a document index.
DocumentIndexEntry	A document index entry.
EntryStatistics	An interface for basic statistics about a lexicon entry.
FieldDocumentIndex	Interface for a fields document index
FieldEntryStatistics	The statistics for a field entry.
FSADocumentIndex	Document Index saved as a fixed size array
FSADocumentIndexInMem	A DocumentIndex implementation that loads everything in memory.
FSOMapFileLexiconGeneric
FSOMapFileLexiconGeneric.MapFileLexiconEntryIterator	Iterate through the values in order
FSOMapFileLexiconGeneric.MapFileLexiconIterator	An iterator over the lexicon
FSOMapFileLexiconOutputStreamGeneric
Index	Base class for all Index implementations
IndexFactory.IndexLoader
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
Lexicon	A lexicon (a.k.a.
LexiconEntry	Base class for all LexiconEntry implementations.
LexiconOutputStream	This class implements an output stream for the lexicon structure.
MapLexicon	Implementation of a lexicon.
MapLexicon.Id2EntryIndexLookup	Interface for getting the lexicon term index for a given term id
MetaIndex	Interface for document metadata.
NgramEntryStatistics	Represent statistics of n-grams, such as those used in sequence dependence models.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.
PropertiesIndex	This class encapsulates all the Indexes at retrieval time.
SimpleBitIndexPointer	An implementation of a BitIndexPointer.
Skipable	Deprecated.

Classes in org.terrier.structures used by org.terrier.structures.bit

Class	Description
AbstractPostingOutputStream	Abstract class that is extended by other posting output stream implementations
BitFilePosition	A (number of bytes, number of bits) position in a bit file.
BitIndexPointer	A Pointer specialisation for some PostingIndex structures.
DocumentIndex	Interface for a document index.
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.
PostingIndexInputStream	Interface for reading postings from an input stream
Skipable	Deprecated.

Classes in org.terrier.structures used by org.terrier.structures.collections

Class	Description
ConcurrentReadable	This annotation makes that an index data structure can be read by more than one thread concurrently.
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
Skipable	Deprecated.

Classes in org.terrier.structures used by org.terrier.structures.concurrent

Class	Description
ConcurrentReadable	This annotation makes that an index data structure can be read by more than one thread concurrently.
Index	Base class for all Index implementations
MetaIndex	Interface for document metadata.

Classes in org.terrier.structures used by org.terrier.structures.indexing

Class	Description
AbstractPostingOutputStream	Abstract class that is extended by other posting output stream implementations
DocumentIndexEntry	A document index entry.
Index	Base class for all Index implementations
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
LexiconEntry	Base class for all LexiconEntry implementations.
LexiconOutputStream	This class implements an output stream for the lexicon structure.
MetaIndex	Interface for document metadata.
PostingIndex	An interface for accessing a posting list.
PropertiesIndex	This class encapsulates all the Indexes at retrieval time.

Classes in org.terrier.structures used by org.terrier.structures.indexing.classical

Class	Description
AbstractPostingOutputStream	Abstract class that is extended by other posting output stream implementations
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.
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
LexiconEntry	Base class for all LexiconEntry implementations.
LexiconOutputStream	This class implements an output stream for the lexicon structure.

Classes in org.terrier.structures used by org.terrier.structures.indexing.singlepass

Class	Description
DocumentIndexEntry	A document index entry.
Index	Base class for all Index implementations
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.
PostingIndexInputStream	Interface for reading postings from an input stream

Classes in org.terrier.structures used by org.terrier.structures.merging

Class	Description
DocumentIndex	Interface for a document index.
DocumentIndexEntry	A document index entry.
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.

Classes in org.terrier.structures used by org.terrier.structures.outputformat

Class	Description
Index	Base class for all Index implementations

Classes in org.terrier.structures used by org.terrier.structures.postings

Class	Description
BitFilePosition	A (number of bytes, number of bits) position in a bit file.
BitIndexPointer	A Pointer specialisation for some PostingIndex structures.
DocumentIndex	Interface for a document index.
DocumentIndexEntry	A document index entry.
EntryStatistics	An interface for basic statistics about a lexicon entry.
FieldDocumentIndex	Interface for a fields document index
Lexicon	A lexicon (a.k.a.
Pointer	A base interface for all pointers.
PostingIndex	An interface for accessing a posting list.

Classes in org.terrier.structures used by org.terrier.structures.postings.bit

Class	Description
DocumentIndex	Interface for a document index.

Classes in org.terrier.structures used by org.terrier.structures.restructure

Class	Description
BitFilePosition	A (number of bytes, number of bits) position in a bit file.
BitIndexPointer	A Pointer specialisation for some PostingIndex structures.
BlockEntryStatistics	Deprecated.
EntryStatistics	An interface for basic statistics about a lexicon entry.
FieldEntryStatistics	The statistics for a field entry.
LexiconEntry	Base class for all LexiconEntry implementations.
Pointer	A base interface for all pointers.

Classes in org.terrier.structures used by org.terrier.tests

Class	Description
Index	Base class for all Index implementations
IndexOnDisk	The replacement for what was Index in earlier Terrier versions.