Uses of Package
org.terrier.structures

Packages that use org.terrier.structures

Package	Description
org.terrier.applications	Provides application-level code that use the Terrier platform to perform indexing and retrieval from either standard test collections, interactive querying of a indexed collection, or desktop search.
org.terrier.applications.batchquerying	Contains application-level programs for performing batch-based query operations, such as generating runs for TREC.
org.terrier.applications.secondary	Contains additional applications-level programs that provide easy access to additional functionality within Terrier
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.models	Provides the classes that implement various weighting models.
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.services.websitesearch	Provides UI access services for the website search demo.
org.terrier.structures	Provides the classes that implement the 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.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.indexing.singlepass.hadoop	Provides classes implemeting the Hadoop MapReduce indexing in Terrier.
org.terrier.structures.integer	Provides generic posting index classes that support byte-level compression.
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.postings.integer	Provides byte-level IterablePosting implementations.
org.terrier.utility.io	This package includes classes that are used for various IO duties within Terrier.

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.

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

Class and 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 lexical entry (usually a term)
Index This class encapsulates all the Indexes at retrieval time.
Lexicon Abstract Lexicon implementation.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
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 and 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 lexical entry (usually a term)
Index This class encapsulates all the Indexes at retrieval time.

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

Class and 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 lexical entry (usually a term)
Index This class encapsulates all the Indexes at retrieval time.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.

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

Class and 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 lexical entry (usually a term)
Index This class encapsulates all the Indexes at retrieval time.

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.
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 and 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 This class encapsulates all the Indexes at retrieval time.
Lexicon Abstract Lexicon implementation.
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.realtime

Class and Description
Index This class encapsulates all the Indexes at retrieval time.

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.

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

Class and 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 lexical entry (usually a term)
Index This class encapsulates all the Indexes at retrieval time.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
Lexicon Abstract Lexicon implementation.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
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 and Description
BitIndexPointer A pointer implementation for BitPostingIndex structures.
DocumentIndex Interface for a document index.
DocumentIndexEntry A document index entry.
EntryStatistics An interface for basic statistics about a lexical entry (usually a term)
FieldDocumentIndex Interface for a fields document index
FieldDocumentIndexEntry A document index entry for use with fields
FieldEntryStatistics The statistics for a field entry
Index This class encapsulates all the Indexes at retrieval time.
Lexicon Abstract Lexicon implementation.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
Pointer A base interface for all pointers
PostingIndex An interface for accessing a posting list.

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

Class and Description
BitFilePosition A bit file position
BitIndexPointer A pointer implementation for BitPostingIndex 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 lexical entry (usually a term)
Index This class encapsulates all the Indexes at retrieval time.
Lexicon Abstract Lexicon implementation.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
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.services.websitesearch

Class and 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.

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

Class and Description
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
BitFilePosition A bit file position
BitIndexPointer A pointer implementation for BitPostingIndex structures.
BlockEntryStatistics Interface describing the statistics for a block entry.
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 lexical entry (usually a term)
FieldDocumentIndex Interface for a fields document index
FieldEntryStatistics The statistics for a field entry
FSADocumentIndex Document Index saved as a fixed size array
Index This class encapsulates all the Indexes at retrieval time.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
Lexicon 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 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.
Pointer A base interface for all pointers
PostingIndex An interface for accessing a posting list.
SimpleBitIndexPointer An implementation of a BitIndexPointer.
Skipable Interface denoting implementations which can skip forward in a stream by a number of entries.

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

Class and Description
AbstractPostingOutputStream Abstract class that is extended by other posting output stream implementations
BitFilePosition A bit file position
BitIndexPointer A pointer implementation for BitPostingIndex structures.
DocumentIndex Interface for a document index.
Index This class encapsulates all the Indexes at retrieval time.
IndexConfigurable Interface defining that an index structure wants access to the Index object it is associated with.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
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 Interface denoting implementations which can skip forward in a stream by a number of entries.

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

Class and Description
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
Skipable Interface denoting implementations which can skip forward in a stream by a number of entries.

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

Class and Description
AbstractPostingOutputStream Abstract class that is extended by other posting output stream implementations
DocumentIndexEntry A document index entry.
Index This class encapsulates all the Indexes at retrieval time.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
LexiconOutputStream This class implements an output stream for the lexicon structure.
PostingIndex An interface for accessing a posting list.

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

Class and Description
AbstractPostingOutputStream Abstract class that is extended by other posting output stream implementations
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
LexiconOutputStream This class implements an output stream for the lexicon structure.

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

Class and Description
BitFilePosition A bit file position
DocumentIndexEntry A document index entry.
Index This class encapsulates all the Indexes at retrieval time.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
LexiconEntry Represents the statistics of a term in the Lexicon, and a pointer to the term's location in a PostingIndex.
LexiconOutputStream This class implements an output stream for the lexicon structure.
PostingIndexInputStream Interface for reading postings from an input stream

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.
LexiconOutputStream This class implements an output stream for the lexicon structure.

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

Class and Description
AbstractPostingOutputStream Abstract class that is extended by other posting output stream implementations
BitFilePosition A bit file position
BitIndexPointer A pointer implementation for BitPostingIndex structures.
DocumentIndex Interface for a document index.
Index This class encapsulates all the Indexes at retrieval time.
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 Interface denoting implementations which can skip forward in a stream by a number of entries.

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

Class and Description
IndexOnDisk The replacement for what was Index in earlier Terrier versions.

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.

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

Class and Description
Lexicon Abstract Lexicon implementation.
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 and Description
DocumentIndex Interface for a document index.

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

Class and Description
DocumentIndex Interface for a document index.
FieldDocumentIndex Interface for a fields document index

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

Class and Description
Index This class encapsulates all the Indexes at retrieval time.
IndexOnDisk The replacement for what was Index in earlier Terrier versions.