Uses of Class
org.terrier.structures.Index

Packages that use Index

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.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.concurrent
org.terrier.structures.indexing	Provides the classes used for creating the data structures of the Terrier platform.
org.terrier.structures.indexing.singlepass	Provides implementation of the structures needed for performing a single pass indexing
org.terrier.structures.outputformat	Provides functionality for writing Terrier ResultSets to disk as .res files, e.g.
org.terrier.tests

Uses of Index in org.terrier.indexing

Methods in org.terrier.indexing that return Index

Modifier and Type	Method	Description
static Index	IndexTestUtils.makeIndex(java.lang.String[] docnos, java.lang.String[] documents)
static Index	IndexTestUtils.makeIndex(java.lang.String[] docnos, java.lang.String[] documents, java.lang.Class<? extends Indexer> indexClz)
static Index	IndexTestUtils.makeIndex(java.lang.String[] docnos, java.lang.String[] documents, Indexer indexer, java.lang.String path, java.lang.String prefix)
static Index	IndexTestUtils.makeIndexBlocks(java.lang.String[] docnos, java.lang.String[] documents)
static Index	IndexTestUtils.makeIndexFields(java.lang.String[] docnos, java.lang.String[] documents)
static Index	IndexTestUtils.makeIndexFields(java.lang.String[] docnos, java.lang.String[] documents, Indexer indexer, java.lang.String path, java.lang.String prefix)
static Index	IndexTestUtils.makeIndexFieldsBlocks(java.lang.String[] docnos, java.lang.String[] documents)
static Index	IndexTestUtils.makeIndexSinglePass(java.lang.String[] docnos, java.lang.String[] documents)

Uses of Index in org.terrier.matching

Fields in org.terrier.matching declared as Index

Modifier and Type	Field	Description
Index	AbstractScoringMatching.index
protected Index	BaseMatching.index	The index used for retrieval.
protected Index	FeaturedScoringMatching.index
protected Index	PostingListManager.index	underlying index
protected Index	TRECResultsMatching.index	The underlying index.

Methods in org.terrier.matching that return Index

Modifier and Type	Method	Description
static Index	FatUtils.makeIndex(FatResultSet frs)

Methods in org.terrier.matching with parameters of type Index

Modifier and Type	Method	Description
protected int	FeaturedScoringMatching.applyDSMs(Index localIndex, java.lang.String queryNumber, MatchingQueryTerms mqtLocal, int numResults, int[] inputDocids, short[] inputOccurrences, FeaturedResultSet rtr)
void	PostingListManager.PostingListManagerPlugin.processQuery(MatchingQueryTerms mqt, Index index, PostingListManager plm)	process the query, given matchign query terms, index and posting list manager

Constructors in org.terrier.matching with parameters of type Index

Constructor	Description
AbstractScoringMatching(Index _index, Matching _parent, WeightingModel _wm)
AbstractScoringMatching(Index _index, Matching _parent, WeightingModel _wm, java.util.function.Predicate<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.util.Set<java.lang.String>>> _filter)
BaseMatching(Index _index)	Constructs an instance of the BaseMatching
FatFeaturedScoringMatching(Index _index, Matching _parent)
FatFeaturedScoringMatching(Index _index, Matching _parent, java.lang.String[] _featureNames)
FatResultsMatching(Index i)
FatScoringMatching(Index _index, Matching _parent)
FatScoringMatching(Index _index, Matching _parent, WeightingModel _wm)
FatScoringMatching(Index _index, Matching _parent, WeightingModel _wm, java.util.function.Predicate<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.util.Set<java.lang.String>>> _filter)
FeaturedScoringMatching(Index _index, Matching _parent, java.lang.Class<? extends AbstractScoringMatching> _scoringMatchingImpl)
FeaturedScoringMatching(Index _index, Matching _parent, java.lang.String[] _featureNames, java.lang.Class<? extends AbstractScoringMatching> _scoringMatchingImpl)
JforestsModelMatching(Index _index, Matching _parent)
JforestsModelMatching(Index _index, Matching _parent, java.lang.String modelFilename)
JforestsModelMatching(Index _index, Matching _parent, java.lang.String modelFilename, java.lang.Class<? extends edu.uci.jforests.learning.trees.Tree> treeClass)
LearnedModelMatching(Index _index, Matching _parent)
LinearModelMatching(Index _index, Matching _parent)
LinearModelMatching(Index _index, Matching _parent, double[] _weights)
LinearModelMatching(Index _index, Matching _parent, java.lang.String _modelFilename)
PostingListManager(Index _index, CollectionStatistics cs)	Create a posting list manager for the given index and statistics
PostingListManager(Index _index, CollectionStatistics _cs, MatchingQueryTerms mqt)	Create a posting list manager for the given index and statistics, and populated using the specified MatchingQueryTerms.
PostingListManager(Index _index, CollectionStatistics _cs, MatchingQueryTerms mqt, boolean splitSynonyms, java.lang.String scoringTag, java.lang.String additionalTag)	Create a posting list manager for the given index and statistics, and populated using the specified MatchingQueryTerms.
ScoringMatching(Index _index, Matching _parent)
ScoringMatching(Index _index, Matching _parent, WeightingModel _wm)
ScoringMatching(Index _index, Matching _parent, WeightingModel _wm, java.util.function.Predicate<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.util.Set<java.lang.String>>> _filter)
ScoringMatchingWithFat(Index _index, Matching _parent)
ScoringMatchingWithFat(Index _index, Matching _parent, WeightingModel _wm)
ScoringMatchingWithFat(Index _index, Matching _parent, WeightingModel _wm, java.util.function.Predicate<org.apache.commons.lang3.tuple.Pair<java.lang.String,java.util.Set<java.lang.String>>> _filter)
TRECResultsMatching(Index _index)	Contructs an instance of the TRECResultsMatching given an index.
TRECResultsMatching(Index _index, java.lang.String _filename)	Contructs an instance of the TRECResultsMatching.
TRECResultsMatching(Index _index, java.lang.String _filename, java.lang.String defDSMs)	Contructs an instance of the TRECResultsMatching.

Uses of Index in org.terrier.matching.daat

Constructors in org.terrier.matching.daat with parameters of type Index

Constructor	Description
FatFull(Index index)
Full(Index index)	Create a new Matching instance based on the specified index

Uses of Index in org.terrier.matching.dsms

Methods in org.terrier.matching.dsms with parameters of type Index

Modifier and Type	Method	Description
protected void	DependenceScoreModifier.doDependency(Index index, EntryStatistics[] es, IterablePosting[] ips, ResultSet rs, double[] phraseTermWeights, boolean SD)	Calculates dependence scores for all documents, putting the scores into the ResultSet rs
void	SimpleStaticScoreModifier.init(Index index)	init
protected void	SimpleStaticScoreModifier.loadDocno2score(Index index)
protected void	SimpleStaticScoreModifier.loadDocno2score_seq(Index index)
protected void	SimpleStaticScoreModifier.loadScorefile(Index index)
boolean	BooleanFallback.modifyScores(Index index, MatchingQueryTerms queryTerms, ResultSet resultSet)	Applies boolean fallback to the given result set.
boolean	BooleanScoreModifier.modifyScores(Index index, MatchingQueryTerms query, ResultSet resultSet)	Zeros the scores of documents in which only some of the query terms appear.
boolean	DependenceScoreModifier.modifyScores(Index index, MatchingQueryTerms terms, ResultSet set)	Modifies the scores of documents, in which there exist, or there does not exist a given phrase.
boolean	DFRDependenceScoreModifier.modifyScores(Index index, MatchingQueryTerms terms, ResultSet set)
boolean	DocumentScoreModifier.modifyScores(Index index, MatchingQueryTerms queryTerms, ResultSet resultSet)	Modifies the scores of the documents for a given query.
boolean	MRFDependenceScoreModifier.modifyScores(Index index, MatchingQueryTerms terms, ResultSet set)	Modifies the scores of documents, in which there exist, or there does not exist a given phrase.
boolean	PhraseScoreModifier.modifyScores(Index index, MatchingQueryTerms terms, ResultSet resultSet)
boolean	ResetScores.modifyScores(Index index, MatchingQueryTerms queryTerms, ResultSet resultSet)
boolean	SimpleStaticScoreModifier.modifyScores(Index index, MatchingQueryTerms queryTerms, ResultSet set)	Modifies the scores of the documents for a given query.
protected void	DependenceScoreModifier.openPostingLists(Index index, LexiconEntry[] les, IterablePosting[] ips)	Opens the posting list for an index and lexicon entry
void	DependenceScoreModifier.setCollectionStatistics(CollectionStatistics cs, Index _index)	Sets the collection statistics used to score the documents (number of documents in the collection, etc)
void	MRFDependenceScoreModifier.setCollectionStatistics(CollectionStatistics cs, Index _index)	Sets the collection statistics used to score the documents (number of documents in the collection, etc)

Uses of Index in org.terrier.matching.matchops

Methods in org.terrier.matching.matchops with parameters of type Index

Modifier and Type	Method	Description
MatchingEntry	DateRangeOp.getMatcher(MatchingQueryTerms.QueryTermProperties qtp, Index index, Lexicon<java.lang.String> lexTerm, PostingIndex<Pointer> invTerm, CollectionStatistics collectionStats)
MatchingEntry	MultiTermOp.getMatcher(MatchingQueryTerms.QueryTermProperties qtp, Index index, Lexicon<java.lang.String> lexicon, PostingIndex<Pointer> invertedIndex, CollectionStatistics collectionStatistics)
abstract MatchingEntry	Operator.getMatcher(MatchingQueryTerms.QueryTermProperties qtp, Index index, Lexicon<java.lang.String> lex, PostingIndex<Pointer> inv, CollectionStatistics collStats)	get an entry for matching for this query op.
MatchingEntry	SingleTermOp.getMatcher(MatchingQueryTerms.QueryTermProperties qtp, Index index, Lexicon<java.lang.String> lexicon, PostingIndex<Pointer> invertedIndex, CollectionStatistics collectionStatistics)
org.apache.commons.lang3.tuple.Pair<EntryStatistics,IterablePosting>	DateRangeOp.getPostingIterator(Index index)
org.apache.commons.lang3.tuple.Pair<EntryStatistics,IterablePosting>	MultiTermOp.getPostingIterator(Index index)
abstract org.apache.commons.lang3.tuple.Pair<EntryStatistics,IterablePosting>	Operator.getPostingIterator(Index index)	get posting iterator for this query op.
org.apache.commons.lang3.tuple.Pair<EntryStatistics,IterablePosting>	PrefixTermOp.getPostingIterator(Index index)
org.apache.commons.lang3.tuple.Pair<EntryStatistics,IterablePosting>	SingleTermOp.getPostingIterator(Index index)

Uses of Index in org.terrier.matching.models

Methods in org.terrier.matching.models with parameters of type Index

Modifier and Type	Method	Description
static WeightingModel	WeightingModelFactory.newInstance(java.lang.String name, Index index)	Returns the requested weighting model for the specified index.

Uses of Index in org.terrier.matching.taat

Constructors in org.terrier.matching.taat with parameters of type Index

Constructor	Description
Full(Index index)	Create a new Matching instance based on the specified index

Uses of Index in org.terrier.matching.tsms

Fields in org.terrier.matching.tsms declared as Index

Modifier and Type	Field	Description
protected Index	TermInFieldModifier.index

Methods in org.terrier.matching.tsms with parameters of type Index

Modifier and Type	Method	Description
void	TermInFieldModifier.setIndex(Index i)	Tell the implementer which Index object it is associated with.

Uses of Index in org.terrier.querying

Fields in org.terrier.querying declared as Index

Modifier and Type	Field	Description
protected Index	FeedbackSelector.index
protected Index	LocalManager.index	The index this querying comes from
protected Index	Request.index	index will not be passed across RMI
protected Index	QueryExpansion.lastIndex

Methods in org.terrier.querying that return Index

Modifier and Type	Method	Description
Index	LocalManager.getIndex()	Returns the index used by the manager.
protected Index	QueryExpansion.getIndex(Manager m)	For easier sub-classing of which index the query expansion comes from
Index	Request.getIndex()	Returns the index to be used for this query

Methods in org.terrier.querying with parameters of type Index

Modifier and Type	Method	Description
default void	MQTRewritingProcess.configureIndex(Index index)
void	QueryExpansion.configureIndex(Index index)
void	FeedbackSelector.setIndex(Index _index)	Set the index to be used
void	RelevanceFeedbackSelector.setIndex(Index index)	Set the index to be used
void	RelevanceFeedbackSelectorDocids.setIndex(Index index)	Set the index to be used
void	RelevantOnlyFeedbackDocuments.setIndex(Index index)	Set the index to be used
void	Request.setIndex(Index _index)	Set the index to be used for this query
protected void	LocalManager.useThisIndex(Index i)	use the index specified for the Manager

Constructors in org.terrier.querying with parameters of type Index

Constructor	Description
LocalManager(Index _index)	Construct a Manager using the specified Index Throws IllegalArgumentException if the specified index is null
ThreadSafeManager(Index _index)

Uses of Index in org.terrier.realtime

Methods in org.terrier.realtime that return Index

Modifier and Type	Method	Description
Index	WritableIndex.write(java.lang.String path, java.lang.String prefix)	Write all of the index structures to disk at the specified location

Uses of Index in org.terrier.realtime.incremental

Subclasses of Index in org.terrier.realtime.incremental

Modifier and Type	Class	Description
class	IncrementalIndex	This is the main Index class for an incremental index.

Fields in org.terrier.realtime.incremental with type parameters of type Index

Modifier and Type	Field	Description
protected static java.util.List<Index>	IncrementalMergePolicy.indices

Methods in org.terrier.realtime.incremental that return Index

Modifier and Type	Method	Description
Index	IncrementalIndex.Loader.load(IndexRef ref)

Methods in org.terrier.realtime.incremental that return types with arguments of type Index

Modifier and Type	Method	Description
java.lang.Class<? extends Index>	IncrementalIndex.Loader.indexImplementor(IndexRef ref)

Method parameters in org.terrier.realtime.incremental with type arguments of type Index

Modifier and Type	Method	Description
static IncrementalFlushPolicy	IncrementalFlushPolicy.get(java.lang.String policy, java.util.List<Index> indices, IncrementalIndex index)	Create a new flush thread.
static IncrementalMergePolicy	IncrementalMergePolicy.get(java.lang.String policy, java.util.List<Index> indices, IncrementalIndex index)	Create a new merge thread.
protected java.util.List<java.lang.Integer>	IncrementalDeleteFixedNumber.getIndicesToDelete(java.util.List<Index> indices)	Get a list of indices to delete (if any)
protected java.util.List<java.lang.Integer>	IncrementalDeletePolicy.getIndicesToDelete(java.util.List<Index> indices)	Get a list of indices to delete (if any)
void	IncrementalDeletePolicy.runPolicy(java.util.List<Index> indices)

Constructors in org.terrier.realtime.incremental with parameters of type Index

Constructor	Description
IncrementalIndex(Index[] indices)

Uses of Index in org.terrier.realtime.matching

Methods in org.terrier.realtime.matching that return types with arguments of type Index

Modifier and Type	Method	Description
java.util.List<Index>	IncrementalSelectiveMatching.getSelectedIndices(java.util.List<Index> indices)	Return all indices (default)
java.util.List<Index>	IncrementalSelectiveMostRecent.getSelectedIndices(java.util.List<Index> indices)	Returns only the incremental.selectivematch.mostrecent indices.

Method parameters in org.terrier.realtime.matching with type arguments of type Index

Modifier and Type	Method	Description
java.util.List<Index>	IncrementalSelectiveMatching.getSelectedIndices(java.util.List<Index> indices)	Return all indices (default)
java.util.List<Index>	IncrementalSelectiveMostRecent.getSelectedIndices(java.util.List<Index> indices)	Returns only the incremental.selectivematch.mostrecent indices.

Uses of Index in org.terrier.realtime.memory

Subclasses of Index in org.terrier.realtime.memory

Modifier and Type	Class	Description
class	MemoryIndex	An index held in fully memory.

Methods in org.terrier.realtime.memory that return Index

Modifier and Type	Method	Description
Index	MemoryIndex.Loader.load(IndexRef ref)
Index	MemoryIndex.write(java.lang.String path, java.lang.String prefix)	Write index structures to disk.

Methods in org.terrier.realtime.memory that return types with arguments of type Index

Modifier and Type	Method	Description
java.lang.Class<? extends Index>	MemoryIndex.Loader.indexImplementor(IndexRef ref)

Uses of Index in org.terrier.realtime.memory.fields

Subclasses of Index in org.terrier.realtime.memory.fields

Modifier and Type	Class	Description
class	MemoryFields	Super-type of fields index implementations.
class	MemoryFieldsIndex	An in-memory incremental fields index (non-compressed).

Methods in org.terrier.realtime.memory.fields that return Index

Modifier and Type	Method	Description
Index	MemoryFieldsIndex.Loader.load(IndexRef ref)
Index	MemoryFieldsIndex.merge(java.lang.String diskpath, java.lang.String diskprefix, java.lang.String newpath, java.lang.String newprefix)	Not implemented.

Methods in org.terrier.realtime.memory.fields that return types with arguments of type Index

Modifier and Type	Method	Description
java.lang.Class<? extends Index>	MemoryFieldsIndex.Loader.indexImplementor(IndexRef ref)

Uses of Index in org.terrier.realtime.multi

Subclasses of Index in org.terrier.realtime.multi

Modifier and Type	Class	Description
class	MultiIndex	The central MultiIndex structure.

Fields in org.terrier.realtime.multi with type parameters of type Index

Modifier and Type	Field	Description
protected java.util.List<Index>	MultiIndex.indices

Methods in org.terrier.realtime.multi that return Index

Modifier and Type	Method	Description
Index	MultiIndex.getIthShard(int i)

Constructors in org.terrier.realtime.multi with parameters of type Index

Constructor	Description
MultiIndex(Index[] indices, boolean blocks, boolean fields)	Constructor.

Uses of Index in org.terrier.structures

Subclasses of Index in org.terrier.structures

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

Methods in org.terrier.structures that return Index

Modifier and Type	Method	Description
static Index	Index.createIndex()	Deprecated.
static Index	Index.createIndex(java.lang.String path, java.lang.String prefix)	Deprecated.
Index	Index.DirectIndexRef.getIndex()
Index	ConcurrentIndexLoader.load(IndexRef ref)
Index	IndexFactory.DirectIndexLoader.load(IndexRef ref)
Index	IndexFactory.IndexLoader.load(IndexRef ref)	Returns the Index for this IndexRef
Index	IndexOnDisk.DiskIndexLoader.load(IndexRef ref)
static Index	IndexFactory.of(java.lang.String indexRefString)	Shortcut method to avoid instantiating an IndexRef
static Index	IndexFactory.of(IndexRef ref)	Load the index for the specified reference.

Methods in org.terrier.structures that return types with arguments of type Index

Modifier and Type	Method	Description
java.lang.Class<? extends Index>	ConcurrentIndexLoader.indexImplementor(IndexRef ref)
java.lang.Class<? extends Index>	IndexFactory.DirectIndexLoader.indexImplementor(IndexRef ref)
java.lang.Class<? extends Index>	IndexFactory.IndexLoader.indexImplementor(IndexRef ref)	Returns the class that will implement the Index for the passed reference
java.lang.Class<? extends Index>	IndexOnDisk.DiskIndexLoader.indexImplementor(IndexRef ref)
static java.lang.Class<? extends Index>	IndexFactory.whoSupports(IndexRef ref)

Methods in org.terrier.structures with parameters of type Index

Modifier and Type	Method	Description
static void	IndexUtil.configure(Index index, java.lang.Object o)	Configures an object with the index, if the object implements IndexConfigurable
static void	IndexUtil.forceReloadStructure(Index index, java.lang.String structureName)	Forces a structure to be reloaded, by removing it from the index's structure cache
static void	IndexUtil.forceStructure(Index index, java.lang.String structureName, java.lang.Object structure)	Force the specified object into the structure cache of the specified object, as the given structure name
static int	IndexUtil.getFieldId(Index index, java.lang.String structureName, java.lang.String fieldName)
static boolean	ConcurrentIndexLoader.isIndexConcurrent(Index index)
protected static IndexRef	Index.makeDirectIndexRef(Index index)
static void	IndexUtil.printDocumentIndex(Index index, java.lang.String structureName)	Print the contents of the document index
static void	LexiconUtil.printLexicon(Index index, java.lang.String structureName)	Prints Lexicon
static void	IndexUtil.printMetaIndex(Index index, java.lang.String structureName)	Print the contents of the meta index
static void	IndexUtil.printMetaIndexJson(Index index, java.lang.String structureName)
static boolean	IndexUtil.renameIndexStructure(Index _index, java.lang.String sourceStructureName, java.lang.String destinationStructureName)	Rename a structure within a given index.
static IndexOnDisk	IndexUtil.reOpenIndex(Index index)
void	IndexConfigurable.setIndex(Index i)	Tell the implementer which Index object it is associated with.

Constructors in org.terrier.structures with parameters of type Index

Constructor	Description
UpdatingCollectionStatistics(Index index)

Uses of Index in org.terrier.structures.concurrent

Methods in org.terrier.structures.concurrent that return Index

Modifier and Type	Method	Description
static Index	ConcurrentIndexUtils.makeConcurrentForRetrieval(Index index)

Methods in org.terrier.structures.concurrent with parameters of type Index

Modifier and Type	Method	Description
static boolean	ConcurrentIndexUtils.isConcurrent(Index index)
static Index	ConcurrentIndexUtils.makeConcurrentForRetrieval(Index index)

Uses of Index in org.terrier.structures.indexing

Methods in org.terrier.structures.indexing with parameters of type Index

Modifier and Type	Method	Description
protected void	DiskIndexWriter.collectProperties(Index source, IndexOnDisk index, CompressionFactory.CompressionConfiguration compressionConfigInverted, CompressionFactory.CompressionConfiguration compressionConfigDirect)
IndexOnDisk	DiskIndexWriter.write(Index source)

Uses of Index in org.terrier.structures.indexing.singlepass

Methods in org.terrier.structures.indexing.singlepass that return Index

Modifier and Type	Method	Description
Index	ExtensibleSinglePassIndexer.getCurrentIndex()	Get the index currently being constructed by this indexer.

Uses of Index in org.terrier.structures.outputformat

Constructors in org.terrier.structures.outputformat with parameters of type Index

Constructor	Description
LETOROutputFormat(Index index)
Normalised2LETOROutputFormat(Index index)
NormalisedLETOROutputFormat(Index index)
NullOutputFormat(Index i)	Created a new NullOuputFormat
TRECDocidOutputFormat(Index index)	Creates a new TRECDocidOutputFormat.
TRECDocnoOutputFormat(Index _index)	Create a TRECDocnoOutputFormat using the specified index for looking up the docnos
WritableOutputFormat(Index i)	Created a new NullOuputFormat

Uses of Index in org.terrier.tests

Methods in org.terrier.tests with parameters of type Index

Modifier and Type	Method	Description
void	BatchEndToEndTest.BatchEndToEndTestEventHooks.checkIndex(BatchEndToEndTest test, Index index)