Terrier 4.0 API

Terrier 4.0

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.desktop	Provides an Java Swing application, based on Terrier, that can be used for searching the desktop of a user.
org.terrier.applications.desktop.filehandling	Provides the functionality of opening arbitrary files from the Java Swing-based desktop search application.
org.terrier.applications.secondary	Contains additional applications-level programs that provide easy access to additional functionality within Terrier
org.terrier.compression.bit	Provides implementation of a random access and input and output streams where gamma, unary and binary, delta Golomb encoded integers can be read or written.
org.terrier.compression.integer	Provides implementations of a random access and input and output streams with byte-level compression.
org.terrier.compression.integer.codec	Provides implementations of byte-level compression codecs for use when compressing index structures.
org.terrier.compression.integer.codec.util	Contains low-level utility classes for working with byte-level compression.
org.terrier.evaluation	Provides an interface and the classes to process relevance assessments and perform standard evaluation of retrieval results.
org.terrier.indexing	Provides classes and interfaces related to the indexing of documents.
org.terrier.indexing.tokenisation	Provides classes related to the tokenisation of documents.
org.terrier.learning	Provides interfaces for Terrier 'Fat' ResultSets that contain features and decorators that add new features to those result sets.
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.models.aftereffect	Provides the interface and the classes for implementing the term frequency normalisation component in the DFR framework.
org.terrier.matching.models.basicmodel	Provides the interface and the classes for implementing the basic models for randomness in the DFR framework.
org.terrier.matching.models.normalisation	Provides the interface and the classes for implementing the basic models for randomness in the DFR framework.
org.terrier.matching.models.queryexpansion	Provides the classes that implement various query expansion 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.querying.parser	Provides the parser specification and the classes that implement the query language of the Terrier platform.
org.terrier.querying.summarisation	Package for summarisation algorithms.
org.terrier.realtime	Provides index structures that support updating and real-time retrieval.
org.terrier.realtime.compression	Provides in-memory bit and byte-level buffers that support compression.
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.realtime.restructure	Provides methods to alter the structure of a real-time index.
org.terrier.services.websitesearch	Provides UI access services for the website search demo.
org.terrier.services.websitesearch.crawler4j	Provides classes for crawling websites on the fly by linking into Crawler4J.
org.terrier.services.websitesearch.crawlers	Provides crawling functionality for websites.
org.terrier.sorting	Provides the classes that implement the sorting of various arrays for the Terrier platform.
org.terrier.statistics	Provides the implementations of various statistical routines.
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.cache	Provides caching of search results when performing batch querying operations.
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.structures.seralization	Provides classes for things that can be serializaed to disk.
org.terrier.terms	Provides the interface and classes for the term pipeline, a set of objects that process the terms during indexing and processing of queries.
org.terrier.utility	This package includes classes that are used in various part of the Terrier Platform.
org.terrier.utility.io	This package includes classes that are used for various IO duties within Terrier.
org.terrier.utility.restructure	Provides functionality to convert legacy Terrier indices into current indices.