Uses of Class
org.terrier.structures.IndexOnDisk

Packages that use IndexOnDisk

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.realtime.memory	Provides MemoryIndex 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.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.utility.io	This package includes classes that are used for various IO duties within Terrier.

Uses of IndexOnDisk in org.terrier.applications

Methods in org.terrier.applications with parameters of type IndexOnDisk

Modifier and Type	Method and Description
static void	InvertedIndexRecompresser.recompressInverted(IndexOnDisk index)

Uses of IndexOnDisk in org.terrier.realtime.memory

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

Constructor and Description
MemoryIndex(IndexOnDisk superIndex)
MemoryIndex(IndexOnDisk superIndex, boolean compressedMeta) Create a memory index from an existing on-disk index.

Uses of IndexOnDisk in org.terrier.structures

Fields in org.terrier.structures declared as IndexOnDisk

Modifier and Type	Field and Description
protected IndexOnDisk	FSOMapFileLexiconOutputStream.index

Methods in org.terrier.structures that return IndexOnDisk

Modifier and Type	Method and Description
static IndexOnDisk	Index.createIndex() Constructs a new Index object.
static IndexOnDisk	Index.createIndex(String path, String prefix) Factory method for load an index.
static IndexOnDisk	Index.createNewIndex(String path, String prefix) Factory method create a new index.

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

Modifier and Type	Method and Description
static void	FSOMapFileLexiconOutputStream.addLexiconToIndex(IndexOnDisk index, String structureName, String leValueClassname) Adds Lexicon to index
protected void	FSAFieldDocumentIndex.initialise(IndexOnDisk index, String structureName)
protected void	FSADocumentIndex.initialise(IndexOnDisk index, String structureName)
protected void	CompressingMetaIndex.loadIndex(IndexOnDisk index, String structureName)
static void	FSOMapFileLexicon.optimise(String structureName, IndexOnDisk index, LexiconBuilder.CollectionStatisticsCounter statsCounter) Does two things to a FSOMapFileLexicon: adds the termid lookup file (if required), and also creates the lexicon has file.
static void	FSOMapFileLexicon.optimise(String structureName, IndexOnDisk index, LexiconBuilder.CollectionStatisticsCounter statsCounter, int numEntries) optimise

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

Constructor and Description
CompressingMetaIndex.InputStream(IndexOnDisk _index, String structureName) Constructs an instance of the class with
CompressingMetaIndex.InputStream(IndexOnDisk _index, String _structureName, int _startingId, int _endId) Constructs an instance of the class with
CompressingMetaIndex(IndexOnDisk index, String structureName) Construct an instance of the class with
FSADocumentIndex.FSADocumentIndexIterator(IndexOnDisk index, String structureName) Construct an instance of the class with
FSADocumentIndex(IndexOnDisk index, String structureName) Construct an instance of the class with
FSADocumentIndex(IndexOnDisk index, String structureName, boolean initialise)
FSAFieldDocumentIndex(IndexOnDisk index, String structureName) Construct an instance of the class with
FSOMapFileLexicon.MapFileLexiconEntryIterator(String structureName, IndexOnDisk index) Construct an instance of the class with
FSOMapFileLexicon.MapFileLexiconIterator(String structureName, IndexOnDisk index) Construct an instance of the class with
FSOMapFileLexicon(String structureName, IndexOnDisk index) Construct a new FSOMapFileLexicon
FSOMapFileLexiconOutputStream(IndexOnDisk _index, String _structureName, Class<? extends FixedSizeWriteableFactory<LexiconEntry>> valueFactoryClass) Construct an instance of the class with
FSOMapFileLexiconOutputStream(IndexOnDisk _index, String _structureName, FixedSizeWriteableFactory<org.apache.hadoop.io.Text> _keyFactory, Class<? extends FixedSizeWriteableFactory<LexiconEntry>> valueFactoryClass) Construct an instance of the class with
FSOMapFileLexiconOutputStream(IndexOnDisk _index, String _structureName, FixedSizeWriteableFactory<org.apache.hadoop.io.Text> _keyFactory, String valueFactoryClassName) Construct an instance of the class with

Uses of IndexOnDisk in org.terrier.structures.bit

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

Modifier and Type	Field and Description
protected IndexOnDisk	BitPostingIndexInputStream.index
protected IndexOnDisk	BitPostingIndex.index

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

Modifier and Type	Method and Description
static String	BitPostingIndexInputStream.getFilename(IndexOnDisk _index, String structureName, byte fileCount, byte fileId) Returns filename

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

Constructor and Description
BitPostingIndex(IndexOnDisk _index, String _structureName, Class<? extends IterablePosting> _postingImplementation) Constructs an instance of the BitPostingIndex.
BitPostingIndex(IndexOnDisk _index, String _structureName, DocumentIndex _documentIndex, Class<? extends IterablePosting> _postingImplementation) Constructs an instance of the BitPostingIndex.
BitPostingIndexInputStream(IndexOnDisk _index, String _structureName, Iterator<? extends BitIndexPointer> _pointerList, Class<? extends IterablePosting> _postingIteratorClass) Constructs an instance of BitPostingIndexInputStream.
BlockDirectIndex(IndexOnDisk index, String structureName) Deprecated. Constructs an instance of the class with the given index, using the specified structure name.
BlockDirectIndex(IndexOnDisk index, String structureName, Class<? extends IterablePosting> postingClass) Deprecated. Constructs an instance of the class with
BlockDirectIndexInputStream(IndexOnDisk index, String structureName) Deprecated. Constructs an index of the class with
BlockDirectIndexInputStream(IndexOnDisk index, String structureName, Class<? extends IterablePosting> postingClass) Deprecated. Constructs an index of the class with
BlockInvertedIndex(IndexOnDisk index, String structureName) Deprecated. Constructs an instance of the class with
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
BlockInvertedIndexInputStream(IndexOnDisk _index, String _structureName) Deprecated. Construct an instance of the class with
BlockInvertedIndexInputStream(IndexOnDisk _index, String _structureName, Class<? extends IterablePosting> _postingImplementation) Deprecated. Construct an instance of the class with
BlockInvertedIndexInputStream(IndexOnDisk _index, String structureName, Iterator<? extends LexiconEntry> lexInputStream) Deprecated. Construct an instance of the class with
BlockInvertedIndexInputStream(IndexOnDisk _index, String structureName, Iterator<? extends LexiconEntry> lexInputStream, Class<? extends IterablePosting> _postingIteratorClass) Deprecated. Construct an instance of the class with
DirectIndex(IndexOnDisk index, String structureName) Deprecated. Constructs an instance of the class with the given index, using the specified structure name.
DirectIndex(IndexOnDisk index, String structureName, Class<? extends IterablePosting> postingClass) Deprecated. Constructs an instance of the class with
DirectIndexInputStream(IndexOnDisk index, String structureName) Deprecated. Constructs an instance of the class with
DirectIndexInputStream(IndexOnDisk index, String structureName, Class<? extends IterablePosting> postingIterator) Deprecated. Constructs an instance of the class with
DirectIndexInputStream(IndexOnDisk _index, String structureName, Iterator<? extends BitIndexPointer> _pointerList, Class<? extends IterablePosting> _postingIteratorClass) Deprecated.
InvertedIndex(IndexOnDisk index, String structureName) Deprecated. Construct 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
InvertedIndexInputStream(IndexOnDisk _index, String structureName) Deprecated. Construct an instance of the class with
InvertedIndexInputStream(IndexOnDisk _index, String structureName, Class<? extends IterablePosting> _postingIteratorClass) Deprecated. Construct an instance of the class with
InvertedIndexInputStream(IndexOnDisk _index, String structureName, Iterator<? extends Pointer> lexInputStream) Deprecated. Construct an instance of the class with
InvertedIndexInputStream(IndexOnDisk _index, String structureName, Iterator<? extends Pointer> lexInputStream, Class<? extends IterablePosting> _postingIteratorClass) Deprecated. Construct an instance of the class with

Uses of IndexOnDisk in org.terrier.structures.collections

Constructors in org.terrier.structures.collections with parameters of type IndexOnDisk

Constructor and Description
FSArrayFile.ArrayFileIterator(IndexOnDisk index, String structureName) constructor
FSArrayFile(IndexOnDisk index, String structureName) constructor
FSOrderedMapFile(IndexOnDisk index, String structureName) constructor

Uses of IndexOnDisk in org.terrier.structures.indexing

Fields in org.terrier.structures.indexing declared as IndexOnDisk

Modifier and Type	Field and Description
protected IndexOnDisk	Indexer.currentIndex The index being worked on, denoted by path and prefix
protected IndexOnDisk	LexiconBuilder.index
protected IndexOnDisk	DocumentIndexBuilder.index index object of the index currently being created
protected IndexOnDisk	CompressingMetaIndexBuilder.index

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

Modifier and Type	Method and Description
static void	LexiconBuilder.createLexiconHash(IndexOnDisk index) Deprecated. use optimise instead
static void	LexiconBuilder.createLexiconIndex(IndexOnDisk index) Deprecated. use optimise instead
static void	LexiconBuilder.optimise(IndexOnDisk index, String structureName) Optimises the lexicon, eg lexid file
static void	LexiconBuilder.reAssignTermIds(IndexOnDisk index, String structureName, int numEntries) Re-assigned the termids within the named lexicon structure to be ascending with descending term frequency, i.e.
static void	CompressingMetaIndexBuilder.reverseAsMapReduceJob(IndexOnDisk index, String structureName, String[] keys) reverseAsMapReduceJob
static void	CompressingMetaIndexBuilder.reverseAsMapReduceJob(IndexOnDisk index, String structureName, String[] keys, HadoopPlugin.JobFactory jf) reverseAsMapReduceJob

Constructors in org.terrier.structures.indexing with parameters of type IndexOnDisk

Constructor and Description
CompressingMetaIndexBuilder(IndexOnDisk _index, String[] _keyNames, int[] _valueLens, String[] _forwardKeys) constructor
CompressingMetaIndexBuilder(IndexOnDisk _index, String _structureName, String[] _keyNames, int[] _valueLens, String[] _forwardKeys) constructor
DocumentIndexBuilder(IndexOnDisk i, String _structureName) Construct a DocumentIndex associated with the specified index
LexiconBuilder.FieldLexiconCollectionStaticticsCounter(IndexOnDisk _index, int _numFields)
LexiconBuilder(IndexOnDisk i, String _structureName) constructor
LexiconBuilder(IndexOnDisk i, String _structureName, Class<? extends LexiconMap> _LexiconMapClass, String _lexiconEntryClass) constructor
LexiconBuilder(IndexOnDisk i, String _structureName, LexiconMap lexiconMap, String _lexiconEntryClass) constructor

Uses of IndexOnDisk in org.terrier.structures.indexing.classical

Fields in org.terrier.structures.indexing.classical declared as IndexOnDisk

Modifier and Type	Field and Description
protected IndexOnDisk	InvertedIndexBuilder.index

Constructors in org.terrier.structures.indexing.classical with parameters of type IndexOnDisk

Constructor and Description
BlockInvertedIndexBuilder(IndexOnDisk index, String structureName, CompressionFactory.CompressionConfiguration compressionConfig) constructor
InvertedIndexBuilder(IndexOnDisk i, String _structureName, CompressionFactory.CompressionConfiguration compressionConfig) contructor

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

Fields in org.terrier.structures.indexing.singlepass declared as IndexOnDisk

Modifier and Type	Field and Description
protected IndexOnDisk	Inverted2DirectIndexBuilder.index index currently being used

Constructors in org.terrier.structures.indexing.singlepass with parameters of type IndexOnDisk

Constructor and Description
BlockInverted2DirectIndexBuilder(IndexOnDisk i) constructor
Inverted2DirectIndexBuilder(IndexOnDisk i) Construct a new instance of this builder class

Uses of IndexOnDisk in org.terrier.structures.indexing.singlepass.hadoop

Methods in org.terrier.structures.indexing.singlepass.hadoop with parameters of type IndexOnDisk

Modifier and Type	Method and Description
static void	Inv2DirectMultiReduce.invertStructure(IndexOnDisk index, HadoopPlugin.JobFactory jf, int numberOfReduceTasks) Performs the inversion, from "inverted" structure to "direct" structure.

Constructors in org.terrier.structures.indexing.singlepass.hadoop with parameters of type IndexOnDisk

Constructor and Description
Inv2DirectMultiReduce.Inv2DirectMultiReduceJob(IndexOnDisk _index, HadoopPlugin.JobFactory _jf) constructor

Uses of IndexOnDisk in org.terrier.structures.integer

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

Modifier and Type	Field and Description
protected IndexOnDisk	IntegerCodingPostingIndexInputStream.index
protected IndexOnDisk	IntegerCodingPostingIndex.index

Methods in org.terrier.structures.integer with parameters of type IndexOnDisk

Modifier and Type	Method and Description
static String	IntegerCodingPostingIndexInputStream.getFilename(IndexOnDisk _index, String structureName, byte fileCount, byte fileId) Returns filename

Constructors in org.terrier.structures.integer with parameters of type IndexOnDisk

Constructor and Description
IntegerCodingPostingIndex(IndexOnDisk index, String structureName)
IntegerCodingPostingIndexInputStream(IndexOnDisk _index, String _structureName, Iterator<? extends BitIndexPointer> _pointerList) Constructs an instance

Uses of IndexOnDisk in org.terrier.structures.merging

Fields in org.terrier.structures.merging declared as IndexOnDisk

Modifier and Type	Field and Description
protected IndexOnDisk	StructureMerger.destIndex destination index
protected IndexOnDisk	LexiconMerger.destIndex
protected IndexOnDisk	StructureMerger.srcIndex1 source index 1
protected IndexOnDisk	LexiconMerger.srcIndex1
protected IndexOnDisk	StructureMerger.srcIndex2 source index 2
protected IndexOnDisk	LexiconMerger.srcIndex2

Methods in org.terrier.structures.merging with parameters of type IndexOnDisk

Modifier and Type	Method and Description
void	StructureMerger.setOutputIndex(IndexOnDisk _outputIndex) Sets the output index.

Constructors in org.terrier.structures.merging with parameters of type IndexOnDisk

Constructor and Description
BlockStructureMerger(IndexOnDisk _srcIndex1, IndexOnDisk _srcIndex2, IndexOnDisk _destIndex) constructor
LexiconMerger(IndexOnDisk src1, IndexOnDisk src2, IndexOnDisk dest) A constructor that sets the filenames of the lexicon files to merge
StructureMerger(IndexOnDisk _srcIndex1, IndexOnDisk _srcIndex2, IndexOnDisk _destIndex) constructor

Uses of IndexOnDisk in org.terrier.utility.io

Methods in org.terrier.utility.io that return IndexOnDisk

Modifier and Type	Method and Description
static IndexOnDisk	HadoopUtility.fromHConfiguration(org.apache.hadoop.conf.Configuration c) Get an Index saved to the specifified Hadoop configuration by toHConfiguration()