Uses of Class
org.terrier.structures.IndexOnDisk

Packages that use IndexOnDisk

Package	Description
org.terrier.realtime.incremental	Provides incremental indexing functionality.
org.terrier.realtime.memory	Provides MemoryIndex 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.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.merging	Provides classes for merging two sets of data structures, created by Terrier, into one set of data structures.
org.terrier.tests

Uses of IndexOnDisk in org.terrier.realtime.incremental

Methods in org.terrier.realtime.incremental with parameters of type IndexOnDisk

Modifier and Type	Method	Description
void	IncrementalDeletePolicy.deleteIndex(IndexOnDisk index)

Uses of IndexOnDisk in org.terrier.realtime.memory

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

Constructor	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	Description
protected IndexOnDisk	FSOMapFileLexiconOutputStreamGeneric.index

Methods in org.terrier.structures that return IndexOnDisk

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

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

Modifier and Type	Method	Description
static void	FSOMapFileLexiconOutputStream.addLexiconToIndex(IndexOnDisk index, java.lang.String structureName, java.lang.String leValueClassname)	Adds Lexicon to index
static void	FSOMapFileLexiconOutputStreamGeneric.addLexiconToIndex(IndexOnDisk index, java.lang.String structureName, java.lang.Class<? extends Lexicon<?>> lexClass, java.lang.Class<? extends java.util.Iterator<?>> lexInputStreamClass, java.lang.Class<? extends java.util.Iterator<LexiconEntry>> lexEntryInputStreamClass, java.lang.String leValueClassname)	Adds Lexicon to index
static boolean	IndexUtil.copyStructure(IndexOnDisk sourceIndex, IndexOnDisk destIndex, java.lang.String sourceStructureName, java.lang.String destinationStructureName)	Copies an index structure from one index to another.
static boolean	IndexUtil.deleteStructure(IndexOnDisk index, java.lang.String structureName)	Delete the named structure from the specified index.
protected void	FSADocumentIndex.initialise(IndexOnDisk index, java.lang.String structureName)
protected void	FSAFieldDocumentIndex.initialise(IndexOnDisk index, java.lang.String structureName)
static boolean	IndexUtil.isStructureOpen(IndexOnDisk index, java.lang.String structureName)	Checks the underlying structurecache of the specificed index to see if the named index structure is there.
protected void	BaseCompressingMetaIndex.loadIndex(IndexOnDisk index, java.lang.String structureName)
static IndexOnDisk	IndexUtil.reOpenIndex(IndexOnDisk index)	Reopen an existing index

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

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

Uses of IndexOnDisk in org.terrier.structures.bit

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

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

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

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

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

Constructor	Description
BitPostingIndex(IndexOnDisk _index, java.lang.String _structureName, java.lang.Class<? extends IterablePosting> _postingImplementation)	Constructs an instance of the BitPostingIndex.
BitPostingIndex(IndexOnDisk _index, java.lang.String _structureName, DocumentIndex _documentIndex, java.lang.Class<? extends IterablePosting> _postingImplementation)	Constructs an instance of the BitPostingIndex.
BitPostingIndexInputStream(IndexOnDisk _index, java.lang.String _structureName, java.util.Iterator<? extends BitIndexPointer> _pointerList, java.lang.Class<? extends IterablePosting> _postingIteratorClass)	Constructs an instance of BitPostingIndexInputStream.

Uses of IndexOnDisk in org.terrier.structures.collections

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

Constructor	Description
ArrayFileIterator(IndexOnDisk index, java.lang.String structureName)	constructor
FSArrayFile(IndexOnDisk index, java.lang.String structureName)	constructor
FSArrayFileInMem(IndexOnDisk index, java.lang.String structureName)
FSOrderedMapFile(IndexOnDisk index, java.lang.String structureName)	constructor

Uses of IndexOnDisk in org.terrier.structures.indexing

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

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

Methods in org.terrier.structures.indexing that return IndexOnDisk

Modifier and Type	Method	Description
IndexOnDisk	DiskIndexWriter.write(Index source)

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

Modifier and Type	Method	Description
protected void	DiskIndexWriter.collectProperties(Index source, IndexOnDisk index, CompressionFactory.CompressionConfiguration compressionConfigInverted, CompressionFactory.CompressionConfiguration compressionConfigDirect)
static MetaIndexBuilder	MetaIndexBuilder.create(java.lang.String metaBuilderName, IndexOnDisk index, java.lang.String[] forwardMetaKeys, int[] metaKeyLengths, java.lang.String[] reverseMetaKeys)	Factory method - create a MetaIndexBuilder from a given name
static void	LexiconBuilder.createLexiconHash(IndexOnDisk index)	Deprecated. use optimise instead
static void	LexiconBuilder.createLexiconIndex(IndexOnDisk index)	Deprecated. use optimise instead
static void	FSOMapFileLexiconUtilities.optimise(java.lang.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	FSOMapFileLexiconUtilities.optimise(java.lang.String structureName, IndexOnDisk index, LexiconBuilder.CollectionStatisticsCounter statsCounter, int numEntries)	optimise
static void	LexiconBuilder.optimise(IndexOnDisk index, java.lang.String structureName)	Optimises the lexicon, eg lexid file
static void	LexiconBuilder.reAssignTermIds(IndexOnDisk index, java.lang.String structureName, int numEntries)	Re-assigned the termids within the named lexicon structure to be ascending with descending term frequency, i.e.

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

Constructor	Description
BaseMetaIndexBuilder(IndexOnDisk _index, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)	constructor
BaseMetaIndexBuilder(IndexOnDisk _index, java.lang.String _structureName, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)	constructor
CompressingMetaIndexBuilder(IndexOnDisk _index, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)
CompressingMetaIndexBuilder(IndexOnDisk _index, java.lang.String _structureName, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)
DocumentIndexBuilder(IndexOnDisk i, java.lang.String _structureName)	Deprecated.
DocumentIndexBuilder(IndexOnDisk i, java.lang.String _structureName, boolean fields)	Construct a DocumentIndex associated with the specified index
FieldLexiconCollectionStaticticsCounter(IndexOnDisk _index, int _numFields)
LexiconBuilder(IndexOnDisk i, java.lang.String _structureName, java.lang.Class<? extends LexiconMap> _LexiconMapClass, java.lang.String _lexiconEntryClass, TermCodes termCodes)	constructor
LexiconBuilder(IndexOnDisk i, java.lang.String _structureName, LexiconMap lexiconMap, java.lang.String _lexiconEntryClass, java.lang.String valueFactoryParamTypes, java.lang.String valueFactoryParamValues, TermCodes _termCodes)	constructor
LexiconBuilder(IndexOnDisk i, java.lang.String _structureName, LexiconMap lexiconMap, java.lang.String _lexiconEntryClass, TermCodes termCodes)	constructor
LexiconBuilder(IndexOnDisk i, java.lang.String _structureName, TermCodes tc)	constructor
LZ4MetaIndexBuilder(IndexOnDisk _index, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)
LZ4MetaIndexBuilder(IndexOnDisk _index, java.lang.String _structureName, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)
UncompressedMetaIndexBuilder(IndexOnDisk _index, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)
UncompressedMetaIndexBuilder(IndexOnDisk _index, java.lang.String _structureName, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)
ZstdMetaIndexBuilder(IndexOnDisk _index, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)
ZstdMetaIndexBuilder(IndexOnDisk _index, java.lang.String _structureName, java.lang.String[] _keyNames, int[] _valueLens, java.lang.String[] _reverseKeys)

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

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

Modifier and Type	Field	Description
protected IndexOnDisk	InvertedIndexBuilder.index

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

Constructor	Description
BlockInvertedIndexBuilder(IndexOnDisk index, java.lang.String structureName, CompressionFactory.CompressionConfiguration compressionConfig)	constructor
InvertedIndexBuilder(IndexOnDisk i, java.lang.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	Description
protected IndexOnDisk	Inverted2DirectIndexBuilder.index	index currently being used

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

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

Uses of IndexOnDisk in org.terrier.structures.merging

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

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

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

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

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

Constructor	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.tests

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

Modifier and Type	Method	Description
protected abstract void	BatchEndToEndTest.addDirectStructure(IndexOnDisk index)