| 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.
|
| 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.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.tests |
| Modifier and Type | Method and Description |
|---|---|
static void |
InvertedIndexRecompresser.recompressInverted(IndexOnDisk index) |
| Constructor and Description |
|---|
MemoryIndex(IndexOnDisk superIndex) |
MemoryIndex(IndexOnDisk superIndex,
boolean compressedMeta)
Create a memory index from an existing on-disk index.
|
| Modifier and Type | Field and Description |
|---|---|
protected IndexOnDisk |
FSOMapFileLexiconOutputStreamGeneric.index |
| 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.
|
static IndexOnDisk |
IndexUtil.reOpenIndex(Index index) |
static IndexOnDisk |
IndexUtil.reOpenIndex(IndexOnDisk index)
Reopen an existing index
|
| Modifier and Type | Method and Description |
|---|---|
static void |
FSOMapFileLexiconOutputStreamGeneric.addLexiconToIndex(IndexOnDisk index,
String structureName,
Class<? extends Lexicon<?>> lexClass,
Class<? extends Iterator<?>> lexInputStreamClass,
Class<? extends Iterator<LexiconEntry>> lexEntryInputStreamClass,
String leValueClassname)
Adds Lexicon to index
|
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) |
static boolean |
IndexUtil.isStructureOpen(IndexOnDisk index,
String structureName)
Checks the underlying structurecache of the specificed index to see if the
named index structure is there.
|
protected void |
CompressingMetaIndex.loadIndex(IndexOnDisk index,
String structureName) |
static IndexOnDisk |
IndexUtil.reOpenIndex(IndexOnDisk index)
Reopen an existing index
|
| Constructor and Description |
|---|
CompressingMetaIndex(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) |
FSADocumentIndexIterator(IndexOnDisk index,
String structureName)
Construct an instance of the class with
|
FSAFieldDocumentIndex(IndexOnDisk index,
String structureName)
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) |
FSOMapFileLexiconOutputStream(IndexOnDisk _index,
String _structureName,
FixedSizeWriteableFactory<org.apache.hadoop.io.Text> _keyFactory,
Class<? extends FixedSizeWriteableFactory<LexiconEntry>> valueFactoryClass) |
FSOMapFileLexiconOutputStream(IndexOnDisk _index,
String _structureName,
FixedSizeWriteableFactory<org.apache.hadoop.io.Text> _keyFactory,
String valueFactoryClassName) |
FSOMapFileLexiconOutputStreamGeneric(IndexOnDisk _index,
String _structureName,
Class<? extends FixedSizeWriteableFactory<LexiconEntry>> valueFactoryClass) |
FSOMapFileLexiconOutputStreamGeneric(IndexOnDisk _index,
String _structureName,
FixedSizeWriteableFactory<T2> _keyFactory,
Class<? extends FixedSizeWriteableFactory<LexiconEntry>> valueFactoryClass) |
FSOMapFileLexiconOutputStreamGeneric(IndexOnDisk _index,
String _structureName,
FixedSizeWriteableFactory<T2> _keyFactory,
String valueFactoryClassName) |
InputStream(IndexOnDisk _index,
String structureName)
Constructs an instance of the class with
|
InputStream(IndexOnDisk _index,
String _structureName,
int _startingId,
int _endId)
Constructs an instance of the class with
|
MapFileLexiconEntryIterator(String structureName,
IndexOnDisk index)
Construct an instance of the class with
|
MapFileLexiconEntryIterator(String structureName,
IndexOnDisk index) |
MapFileLexiconIterator(String structureName,
IndexOnDisk index)
Construct an instance of the class with
|
MapFileLexiconIterator(String structureName,
IndexOnDisk index) |
| Modifier and Type | Field and Description |
|---|---|
protected IndexOnDisk |
BitPostingIndexInputStream.index |
protected IndexOnDisk |
BitPostingIndex.index |
| Modifier and Type | Method and Description |
|---|---|
static String |
BitPostingIndexInputStream.getFilename(IndexOnDisk _index,
String structureName,
byte fileCount,
byte fileId)
Returns filename
|
| 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
|
| Constructor and Description |
|---|
ArrayFileIterator(IndexOnDisk index,
String structureName)
constructor
|
FSArrayFile(IndexOnDisk index,
String structureName)
constructor
|
FSArrayFileInMem(IndexOnDisk index,
String structureName) |
FSOrderedMapFile(IndexOnDisk index,
String structureName)
constructor
|
| 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 |
| 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 |
FSOMapFileLexiconUtilities.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 |
FSOMapFileLexiconUtilities.optimise(String structureName,
IndexOnDisk index,
LexiconBuilder.CollectionStatisticsCounter statsCounter,
int numEntries)
optimise
|
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.
|
| 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
|
FieldLexiconCollectionStaticticsCounter(IndexOnDisk _index,
int _numFields) |
LexiconBuilder(IndexOnDisk i,
String _structureName,
Class<? extends LexiconMap> _LexiconMapClass,
String _lexiconEntryClass,
TermCodes termCodes)
constructor
|
LexiconBuilder(IndexOnDisk i,
String _structureName,
LexiconMap lexiconMap,
String _lexiconEntryClass,
String valueFactoryParamTypes,
String valueFactoryParamValues,
TermCodes _termCodes)
constructor
|
LexiconBuilder(IndexOnDisk i,
String _structureName,
LexiconMap lexiconMap,
String _lexiconEntryClass,
TermCodes termCodes)
constructor
|
LexiconBuilder(IndexOnDisk i,
String _structureName,
TermCodes tc)
constructor
|
| Modifier and Type | Field and Description |
|---|---|
protected IndexOnDisk |
InvertedIndexBuilder.index |
| Constructor and Description |
|---|
BlockInvertedIndexBuilder(IndexOnDisk index,
String structureName,
CompressionFactory.CompressionConfiguration compressionConfig)
constructor
|
InvertedIndexBuilder(IndexOnDisk i,
String _structureName,
CompressionFactory.CompressionConfiguration compressionConfig)
contructor
|
| Modifier and Type | Field and Description |
|---|---|
protected IndexOnDisk |
Inverted2DirectIndexBuilder.index
index currently being used
|
| Constructor and Description |
|---|
BlockInverted2DirectIndexBuilder(IndexOnDisk i)
constructor
|
Inverted2DirectIndexBuilder(IndexOnDisk i)
Construct a new instance of this builder class
|
| Modifier and Type | Field and Description |
|---|---|
protected IndexOnDisk |
IntegerCodingPostingIndexInputStream.index |
protected IndexOnDisk |
IntegerCodingPostingIndex.index |
| Modifier and Type | Method and Description |
|---|---|
static String |
IntegerCodingPostingIndexInputStream.getFilename(IndexOnDisk _index,
String structureName,
byte fileCount,
byte fileId)
Returns filename
|
| Constructor and Description |
|---|
IntegerCodingPostingIndex(IndexOnDisk index,
String structureName) |
IntegerCodingPostingIndexInputStream(IndexOnDisk _index,
String _structureName,
Iterator<? extends BitIndexPointer> _pointerList)
Constructs an instance
|
| 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 |
| Modifier and Type | Method and Description |
|---|---|
void |
StructureMerger.setOutputIndex(IndexOnDisk _outputIndex)
Sets the output index.
|
| 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
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract void |
BatchEndToEndTest.addDirectStructure(IndexOnDisk index) |
Terrier Information Retrieval Platform 5.1. Copyright © 2004-2019, University of Glasgow