Uses of Interface
org.terrier.structures.DocumentIndex

Packages that use DocumentIndex

Package	Description
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.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.merging	Provides classes for merging two sets of data structures, created by Terrier, into one set of data structures.
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.

Uses of DocumentIndex in org.terrier.querying

Fields in org.terrier.querying declared as DocumentIndex

Modifier and Type	Field	Description
protected DocumentIndex	DFRBagExpansionTerms.documentIndex
protected DocumentIndex	QueryExpansion.documentIndex	The document index used for retrieval.
protected DocumentIndex	RelevanceFeedbackSelectorDocids.doi

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

Constructor	Description
DFRBagExpansionTerms(CollectionStatistics collStats, Lexicon<java.lang.String> _lexicon, PostingIndex<?> _directIndex, DocumentIndex _documentIndex)	Constructs an instance of ExpansionTerms.

Uses of DocumentIndex in org.terrier.realtime.memory

Classes in org.terrier.realtime.memory that implement DocumentIndex

Modifier and Type	Class	Description
class	MemoryDocumentIndex	An in-memory version of the Document index.
class	MemoryDocumentIndexMap	This class is a special variant of the Memory index class where the Document index is backed by a fast mapping structure in memory.

Fields in org.terrier.realtime.memory declared as DocumentIndex

Modifier and Type	Field	Description
protected DocumentIndex	MemoryDirectIndex.doi
protected DocumentIndex	MemoryInvertedIndex.doi
protected DocumentIndex	MemoryIterablePosting.doi

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

Modifier and Type	Method	Description
DocumentIndex	MemoryIndex.getDocumentIndex()	Return the DocumentIndex associated with this index
DocumentIndex	MemoryInvertedIndex.getDoi()

Methods in org.terrier.realtime.memory with parameters of type DocumentIndex

Modifier and Type	Method	Description
void	MemoryInvertedIndex.setDoi(DocumentIndex doi)

Constructors in org.terrier.realtime.memory with parameters of type DocumentIndex

Constructor	Description
MemoryDirectIndex(DocumentIndex doi)	Constructor.
MemoryInvertedIndex(Lexicon<java.lang.String> lex, DocumentIndex doi)	Constructor.
MemoryIterablePosting(DocumentIndex doi, gnu.trove.TIntArrayList pl_doc, gnu.trove.TIntArrayList pl_freq)	Constructor.

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

Classes in org.terrier.realtime.memory.fields that implement DocumentIndex

Modifier and Type	Class	Description
class	MemoryDocumentIndexFields	Document index (fields).
class	MemoryDocumentIndexFieldsMap	A memory document index structure that supports fields and fast lookups via a map structure.

Constructors in org.terrier.realtime.memory.fields with parameters of type DocumentIndex

Constructor	Description
MemoryFieldsInvertedIndex(Lexicon<java.lang.String> lexicon, DocumentIndex docindex)	Constructor.
MemoryFieldsIterablePosting(DocumentIndex docindex, gnu.trove.TIntArrayList docids, gnu.trove.TIntArrayList freqs, gnu.trove.TIntObjectHashMap<int[]> fields)	Constructor (docid,freq,(fields)).

Uses of DocumentIndex in org.terrier.realtime.multi

Classes in org.terrier.realtime.multi that implement DocumentIndex

Modifier and Type	Class	Description
class	MultiDoc	A Document index class that represents multiple document indices from different shards.

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

Modifier and Type	Method	Description
DocumentIndex	MultiIndex.getDocumentIndex()	Return the DocumentIndex associated with this index

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

Constructor	Description
MultiDoc(DocumentIndex[] docs, int[] offsets)	constructor.

Uses of DocumentIndex in org.terrier.structures

Subinterfaces of DocumentIndex in org.terrier.structures

Modifier and Type	Interface	Description
interface	FieldDocumentIndex	Interface for a fields document index

Classes in org.terrier.structures that implement DocumentIndex

Modifier and Type	Class	Description
class	FSADocumentIndex	Document Index saved as a fixed size array
class	FSADocumentIndexInMem	A DocumentIndex implementation that loads everything in memory.
class	FSADocumentIndexInMemFields	A version of FSADocumentIndexInMem for indices with fields.
class	FSAFieldDocumentIndex	Fields document index stored as a fixed size array

Methods in org.terrier.structures that return DocumentIndex

Modifier and Type	Method	Description
abstract DocumentIndex	Index.getDocumentIndex()	Return the DocumentIndex associated with this index
DocumentIndex	IndexOnDisk.getDocumentIndex()
abstract DocumentIndex	PropertiesIndex.getDocumentIndex()	Return the DocumentIndex associated with this index

Uses of DocumentIndex in org.terrier.structures.bit

Fields in org.terrier.structures.bit declared as DocumentIndex

Modifier and Type	Field	Description
protected DocumentIndex	BitPostingIndex.doi
protected DocumentIndex	BitPostingIndexInputStream.doi

Methods in org.terrier.structures.bit that return DocumentIndex

Modifier and Type	Method	Description
protected DocumentIndex	BitPostingIndexInputStream.getDocumentIndex(BitIndexPointer pointer)

Methods in org.terrier.structures.bit with parameters of type DocumentIndex

Modifier and Type	Method	Description
static void	ConcurrentBitPostingIndexUtilities.makeConcurrent(BitPostingIndex bpi, DocumentIndex newDoi)

Constructors in org.terrier.structures.bit with parameters of type DocumentIndex

Constructor	Description
BitPostingIndex(java.lang.String filename, byte fileCount, DocumentIndex _doi, java.lang.Class<? extends IterablePosting> _postingImplementation, java.lang.String _dataSource, int _fieldCount)
BitPostingIndex(IndexOnDisk _index, java.lang.String _structureName, DocumentIndex _documentIndex, java.lang.Class<? extends IterablePosting> _postingImplementation)	Constructs an instance of the BitPostingIndex.

Uses of DocumentIndex in org.terrier.structures.merging

Classes in org.terrier.structures.merging that implement DocumentIndex

Modifier and Type	Class	Description
static class	StructureMerger.NullDocumentIndex

Uses of DocumentIndex in org.terrier.structures.postings

Classes in org.terrier.structures.postings that implement DocumentIndex

Modifier and Type	Class	Description
static class	PostingUtil.DocidSpecificDocumentIndex

Constructors in org.terrier.structures.postings with parameters of type DocumentIndex

Constructor	Description
DocidSpecificDocumentIndex(DocumentIndex _di, DocumentIndexEntry _die)

Uses of DocumentIndex in org.terrier.structures.postings.bit

Fields in org.terrier.structures.postings.bit declared as DocumentIndex

Modifier and Type	Field	Description
protected DocumentIndex	BasicIterablePosting.doi

Constructors in org.terrier.structures.postings.bit with parameters of type DocumentIndex

Constructor	Description
BasicIterablePosting(BitIn _bitFileReader, int _numEntries, DocumentIndex _doi)	Constructor
BasicIterablePostingDocidOnly(BitIn _bitFileReader, int _numEntries, DocumentIndex _doi)	Create a new posting iterator
BlockFieldIterablePosting(BitIn _bitFileReader, int _numEntries, DocumentIndex doi, int _fieldCount)	Make a new posting iterator that is read from a BitIn stream.
BlockIterablePosting(BitIn _bitFileReader, int _numEntries, DocumentIndex doi)	Constructs an instance of the BlockIterablePosting.
FieldIterablePosting(BitIn fileReader, int entries, DocumentIndex _doi, int _fieldCount)	constructor