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 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.integer	Provides generic posting index classes that support byte-level compression.
org.terrier.structures.postings.bit	Provides bit-level IterablePosting implementations.
org.terrier.structures.postings.integer	Provides byte-level IterablePosting implementations.

Uses of DocumentIndex in org.terrier.querying

Fields in org.terrier.querying declared as DocumentIndex

Modifier and Type	Field and 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 and Description
DFRBagExpansionTerms(CollectionStatistics collStats, Lexicon<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 and 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 and Description
protected DocumentIndex	MemoryIterablePosting.doi
protected DocumentIndex	MemoryInvertedIndex.doi

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

Modifier and Type	Method and 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 and Description
void	MemoryInvertedIndex.setDoi(DocumentIndex doi)

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

Constructor and Description
MemoryDirectIndex(DocumentIndex doi) Constructor.
MemoryInvertedIndex(Lexicon<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 and 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 and Description
MemoryFieldsInvertedIndex(Lexicon<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 and 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 and Description
DocumentIndex	MultiIndex.getDocumentIndex() Return the DocumentIndex associated with this index

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

Constructor and 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 and Description
interface	FieldDocumentIndex Interface for a fields document index

Classes in org.terrier.structures that implement DocumentIndex

Modifier and Type	Class and Description
class	FSADocumentIndex Document Index saved as a fixed size array
class	FSAFieldDocumentIndex Fields document index stored as a fixed size array
static class	PostingIndex.DocidSpecificDocumentIndex

Methods in org.terrier.structures that return DocumentIndex

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

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

Constructor and Description
PostingIndex.DocidSpecificDocumentIndex(DocumentIndex _di, DocumentIndexEntry _die)

Uses of DocumentIndex in org.terrier.structures.bit

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

Modifier and Type	Field and Description
protected DocumentIndex	DirectIndex.docIndex Deprecated. The document index employed for retrieving the document offsets.
protected DocumentIndex	BitPostingIndexInputStream.doi
protected DocumentIndex	BitPostingIndex.doi

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

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

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

Constructor and Description
BitPostingIndex(IndexOnDisk _index, String _structureName, DocumentIndex _documentIndex, Class<? extends IterablePosting> _postingImplementation) Constructs an instance of the BitPostingIndex.
BitPostingIndex(String filename, byte fileCount, DocumentIndex _doi, Class<? extends IterablePosting> _postingImplementation, String _dataSource, int _fieldCount)
BlockInvertedIndex(IndexOnDisk index, String structureName, DocumentIndex doi) Deprecated. Constructs an instance of the class with
BlockInvertedIndex(IndexOnDisk index, String structureName, DocumentIndex _doi, Class<? extends IterablePosting> postingClass) Deprecated. Constructs an instance of the class with
InvertedIndex(IndexOnDisk index, String structureName, DocumentIndex _doi) Deprecated. Construct an instance of the class with
InvertedIndex(IndexOnDisk index, String structureName, DocumentIndex _doi, Class<? extends IterablePosting> postingClass) Deprecated. Construct an instance of the class with

Uses of DocumentIndex in org.terrier.structures.integer

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

Modifier and Type	Field and Description
protected DocumentIndex	IntegerCodingPostingIndexInputStream.documentIndex
protected DocumentIndex	IntegerCodingPostingIndex.documentIndex

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

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

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

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

Modifier and Type	Field and Description
protected DocumentIndex	BasicIterablePosting.doi

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

Constructor and Description
BasicIterablePosting(BitIn _bitFileReader, int _numEntries, DocumentIndex _doi) Create a new posting iterator
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

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

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

Modifier and Type	Field and Description
protected DocumentIndex	BasicIntegerCodingIterablePosting.documentIndex
protected DocumentIndex	IntegerCodingIterablePosting.documentIndex Deprecated.

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

Constructor and Description
BasicIntegerCodingIterablePosting(ByteIn input, int numberOfEntries, DocumentIndex documentIndex, int chunkSize, IntegerCodec idsCodec, IntegerCodec tfsCodec)
BlockFieldIntegerCodingIterablePosting(ByteIn input, int numberOfEntries, DocumentIndex documentIndex, int chunkSize, int fieldCount, int hasBlocks, int maxBlocks, IntegerCodec idsCodec, IntegerCodec tfsCodec, IntegerCodec fieldsCodec, IntegerCodec blocksCodec)
BlockIntegerCodingIterablePosting(ByteIn input, int numberOfEntries, DocumentIndex documentIndex, int chunkSize, int hasBlocks, int maxBlocks, IntegerCodec idsCodec, IntegerCodec tfsCodec, IntegerCodec blocksCodec)
FieldIntegerCodingIterablePosting(ByteIn input, int numberOfEntries, DocumentIndex documentIndex, int chunkSize, int fieldCount, IntegerCodec idsCodec, IntegerCodec tfsCodec, IntegerCodec fieldsCodec)
IntegerCodingIterablePosting(ByteIn input, int numberOfEntries, DocumentIndex documentIndex, int chunkSize, int fieldCount, int hasBlocks, IntegerCodec idsCodec, IntegerCodec tfsCodec, IntegerCodec fieldsCodec, IntegerCodec blocksCodec) Deprecated.