Terrier IR Platform
2.2.1
A B C D E F G H I J K L M N O P Q R S T U V W

C

canRead(String) - Static method in class uk.ac.gla.terrier.utility.Files
returns true iff path can be read
canRead(String) - Method in interface uk.ac.gla.terrier.utility.io.FileSystem
returns true if filename can be read
canRead(String) - Method in class uk.ac.gla.terrier.utility.io.HTTPFileSystem
returns true if filename can be read
canRead(String) - Method in class uk.ac.gla.terrier.utility.io.LocalFileSystem
returns true if filename can be read
canWrite(String) - Static method in class uk.ac.gla.terrier.utility.Files
returns true iff path can be read
canWrite(String) - Method in interface uk.ac.gla.terrier.utility.io.FileSystem
returns true if filename can be written to
canWrite(String) - Method in class uk.ac.gla.terrier.utility.io.HTTPFileSystem
returns true if filename can be written to
canWrite(String) - Method in class uk.ac.gla.terrier.utility.io.LocalFileSystem
returns true if filename can be written to
capabilities() - Method in interface uk.ac.gla.terrier.utility.io.FileSystem
capabilities of the filesystem
capabilities() - Method in class uk.ac.gla.terrier.utility.io.HTTPFileSystem
capabilities of the filesystem
capabilities() - Method in class uk.ac.gla.terrier.utility.io.LocalFileSystem
 
checkArrays(int[][], int[][]) - Static method in class uk.ac.gla.terrier.structures.upgrading.ReverseFile
Checks whether two int[][] arrays have the same elements
checkIF(String, String) - Static method in class uk.ac.gla.terrier.structures.upgrading.ReverseFile
Checks if two inverted files contain the same information, without considering the termid or the order of the terms in the files.
checkMemory() - Method in interface uk.ac.gla.terrier.utility.MemoryChecker
Check the amount of available memory.
checkMemory() - Method in class uk.ac.gla.terrier.utility.RuntimeMemoryChecker
Returns true if memory is running low
clear() - Method in class uk.ac.gla.terrier.structures.indexing.BlockLexiconMap
Clear the lexicon map
clear() - Method in class uk.ac.gla.terrier.structures.indexing.DocumentPostingList
Removes all postings from this document
clear() - Method in class uk.ac.gla.terrier.structures.indexing.LexiconMap
Clear the lexicon map
clear() - Method in class uk.ac.gla.terrier.terms.Stopwords
Clear all stopwords from this stopword list object.
clone() - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory.QrelsHashSet
Creates a clone of the current instance of the class.
clone() - Method in class uk.ac.gla.terrier.matching.dsms.BlockScoreModifier
 
clone() - Method in class uk.ac.gla.terrier.matching.dsms.BooleanFallback
 
clone() - Method in class uk.ac.gla.terrier.matching.dsms.BooleanScoreModifier
Clone this DSM.
clone() - Method in interface uk.ac.gla.terrier.matching.dsms.DocumentScoreModifier
 
clone() - Method in class uk.ac.gla.terrier.matching.dsms.PhraseScoreModifier
Clones this DSM.
clone() - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Performs a deep clone of this object, and all objects it contains.
clone() - Method in class uk.ac.gla.terrier.matching.models.Idf
Make a perfect clone of this object
clone() - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Clone this weighting model
clone() - Method in class uk.ac.gla.terrier.matching.tsms.FieldScoreModifier
 
clone() - Method in class uk.ac.gla.terrier.matching.tsms.RequiredTermModifier
 
clone() - Method in class uk.ac.gla.terrier.matching.tsms.TermInFieldModifier
 
clone() - Method in interface uk.ac.gla.terrier.matching.tsms.TermScoreModifier
Return a clone of this object (deep copy).
clone() - Method in class uk.ac.gla.terrier.querying.parser.FieldQuery
Deep Clone this object
clone() - Method in class uk.ac.gla.terrier.querying.parser.MultiTermQuery
 
clone() - Method in class uk.ac.gla.terrier.querying.parser.PhraseQuery
 
clone() - Method in class uk.ac.gla.terrier.querying.parser.Query
Deep copy this Query object
clone() - Method in class uk.ac.gla.terrier.querying.parser.RequirementQuery
 
clone() - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery
 
close() - Method in class uk.ac.gla.terrier.applications.InteractiveQuerying
Closes the used structures.
close() - Method in class uk.ac.gla.terrier.applications.TRECQuerying
Closes the used structures.
close() - Method in class uk.ac.gla.terrier.compression.BitByteOutputStream
Closes the stream.
close() - Method in class uk.ac.gla.terrier.compression.BitFile
Closes the file.
close() - Method in class uk.ac.gla.terrier.compression.BitFileInMemory
Close this object.
close() - Method in class uk.ac.gla.terrier.compression.BitInputStream
Closes the stream.
close() - Method in class uk.ac.gla.terrier.compression.BitOutputStream
Closes the BitOutputStream.
close() - Method in class uk.ac.gla.terrier.compression.MemoryOutputStream
Empty method
close() - Method in class uk.ac.gla.terrier.compression.OldBitFile
Closes the random access file.
close() - Method in class uk.ac.gla.terrier.compression.OldBitInputStream
Closes the stream.
close() - Method in class uk.ac.gla.terrier.compression.OldBitOutputStream
Deprecated. Flushes and closes the stream.
close() - Method in interface uk.ac.gla.terrier.indexing.Collection
Closes the collection, any files that may be open.
close() - Method in class uk.ac.gla.terrier.indexing.hadoop.Hadoop_BasicSinglePassIndexer
Called when the Map or Reduce task ends, to finish up the indexer.
close() - Method in class uk.ac.gla.terrier.indexing.SimpleFileCollection
 
close() - Method in class uk.ac.gla.terrier.indexing.SimpleXMLCollection
 
close() - Method in class uk.ac.gla.terrier.indexing.TRECCollection
Closes the files and streams used by the collection object.
close() - Method in class uk.ac.gla.terrier.indexing.TRECFullTokenizer
Closes the buffered reader associated with the tokenizer.
close() - Method in interface uk.ac.gla.terrier.structures.Closeable
close this index data structure
close() - Method in class uk.ac.gla.terrier.structures.DirectIndex
Closes the underlying bitfile compressed file.
close() - Method in class uk.ac.gla.terrier.structures.DirectIndexInputStream
Closes the underlying gamma compressed file.
close() - Method in class uk.ac.gla.terrier.structures.DirectInvertedOutputStream
close this object.
close() - Method in class uk.ac.gla.terrier.structures.DocumentIndex
Closes the random access file.
close() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream
Closes the stream.
close() - Method in class uk.ac.gla.terrier.structures.DocumentIndexOutputStream
Closes the random access file.
close() - Method in class uk.ac.gla.terrier.structures.Index
Closes the data structures of the index.
close() - Method in class uk.ac.gla.terrier.structures.indexing.DirectIndexBuilder
Closes the underlying gamma compressed file.
close() - Method in class uk.ac.gla.terrier.structures.indexing.DocumentIndexBuilder
Closes the random access file.
close() - Method in class uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder
Closes the underlying bit file.
close() - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.FileRunIterator
Closes the run files being processed
close() - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.CollectionRecordReader
Closes the document collection if it exists
close() - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.RunIterator
close this RunIterator
close() - Method in class uk.ac.gla.terrier.structures.InvertedIndex
Closes the underlying bit file.
close() - Method in class uk.ac.gla.terrier.structures.InvertedIndexInputStream
 
close() - Method in class uk.ac.gla.terrier.structures.Lexicon
Closes the lexicon and lexicon index files.
close() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream
Closes the lexicon stream.
close() - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream
Closes the lexicon stream.
close() - Method in class uk.ac.gla.terrier.utility.io.HadoopPlugin.JobFactory
Finish with this job factory.
close() - Method in class uk.ac.gla.terrier.utility.LookAheadReader
Closes the current stream, by setting the end of file flag equal to true.
close() - Method in class uk.ac.gla.terrier.utility.LookAheadStream
Closes the current stream, by setting the end of file flag equal to true.
Closeable - Interface in uk.ac.gla.terrier.structures
Marks an index structure class that can be closed.
closeBufferedReader() - Method in class uk.ac.gla.terrier.indexing.TRECFullTokenizer
Closes the buffered reader associated with the tokenizer.
Collection - Interface in uk.ac.gla.terrier.indexing
This interface encapsulates the most fundamental concept to indexing with Terrier - a Collection.
COLLECTION_SPEC - Static variable in class uk.ac.gla.terrier.utility.ApplicationSetup
The name of the file that contains the list of resources to be processed during indexing.
CollectionFactory - Class in uk.ac.gla.terrier.indexing
Implements a factory for Collection objects.
CollectionFactory() - Constructor for class uk.ac.gla.terrier.indexing.CollectionFactory
 
CollectionRecordReader<SPLITTYPE extends org.apache.hadoop.mapred.InputSplit> - Class in uk.ac.gla.terrier.structures.indexing.singlepass.hadoop
An abstract class which provides ways to index a collection, based on a predetermined InputSplit type.
CollectionRecordReader(JobConf, SPLITTYPE) - Constructor for class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.CollectionRecordReader
 
CollectionResultSet - Class in uk.ac.gla.terrier.matching
This class implements the interface ResultSet and models the set of all documents in the collection.
CollectionResultSet() - Constructor for class uk.ac.gla.terrier.matching.CollectionResultSet
Deprecated. This constructor must not be used anymore. Use constructors specifying the number of documents in the collection.
CollectionResultSet(int) - Constructor for class uk.ac.gla.terrier.matching.CollectionResultSet
A default constructor for the result set with a given number of documents.
CollectionResultSet(ResultSet) - Constructor for class uk.ac.gla.terrier.matching.CollectionResultSet
A default constructor for the result set with a given instance of the result set.
CollectionStatistics - Class in uk.ac.gla.terrier.structures
This class provides basic statistics for the indexed collection of documents, such as the average length of documents, or the total number of documents in the collection.
CollectionStatistics(int, int, long, long) - Constructor for class uk.ac.gla.terrier.structures.CollectionStatistics
 
compare(MapEmittedTerm, MapEmittedTerm) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm.TermComparator
Compares Hadoop_TextPlus objects by comparison of the Text variables.
compare(byte[], int, int, byte[], int, int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm.TermComparator
Raw comparison on text objects NOT USED
compare(MapEmittedTerm, MapEmittedTerm) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm.TermMapFlushComparator
 
compare(byte[], int, int, byte[], int, int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm.TermMapFlushComparator
Compare by term (bit comparison on Text object) then by map number (int) then by flush number (int).
compare(RunIterator, RunIterator) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.RunsMerger.PostingComparator
 
compare(String, String) - Method in class uk.ac.gla.terrier.utility.StringComparator
Compares two Strings, which have a number of fields that are separated by one or more non-alphanumeric characters.
compareObjects(Object, Object) - Static method in class uk.ac.gla.terrier.utility.StringComparator
A static access method, to prevent having to instantiate a comparator This has the same parameters, return and implementation as compare(Object,Object)
compareStrings(String, String) - Static method in class uk.ac.gla.terrier.utility.StringComparator
A static access method, to prevent having to instantiate a comparator This has the same parameters, return and implementation as compare(Object,Object)
compareTo(MapEmittedTerm) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm
Text Comparator on the Term contained in this object
configure(JobConf) - Method in class uk.ac.gla.terrier.indexing.hadoop.Hadoop_BasicSinglePassIndexer
Configure this indexer.
configure(JobConf) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.ByMapPartitioner
 
configure(InputStream) - Static method in class uk.ac.gla.terrier.utility.ApplicationSetup
 
copyFile(String, String) - Static method in class uk.ac.gla.terrier.utility.Files
Copy a file from srcFile to destFile.
copyFile(File, File) - Static method in class uk.ac.gla.terrier.utility.Files
Copy a file from srcFile to destFile.
copyFile(InputStream, OutputStream) - Static method in class uk.ac.gla.terrier.utility.Files
Copy all bytes from in to out
counter - Variable in class uk.ac.gla.terrier.indexing.FileDocument
The number of bytes read from the input.
counter - Variable in class uk.ac.gla.terrier.indexing.TRECFullTokenizer
The number of bytes read from the input.
CountingInputStream - Class in uk.ac.gla.terrier.utility.io
Sub-Class of Filter Input Stream with the extra method getPos which returns the position in the Stream
CountingInputStream(InputStream) - Constructor for class uk.ac.gla.terrier.utility.io.CountingInputStream
Constructor - Calls Super Class
CountingInputStream(InputStream, long) - Constructor for class uk.ac.gla.terrier.utility.io.CountingInputStream
Constructor - Calls Super Class
create_Hadoop_WritableByteArray(byte[]) - Static method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.WritableByteArray
Factory Method
create_Hadoop_WritableByteArray(byte[], int) - Static method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.WritableByteArray
Factory Method
create_Hadoop_WritableByteArray(byte[], int, int) - Static method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.WritableByteArray
Factory Method
create_Hadoop_WritableRunPostingData(String, int, byte[], int, int) - Static method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedPostingList
Factory Method
create_Hadoop_WritableRunPostingData(byte[], int, int) - Static method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedPostingList
Super Factory Method
create_TextPlus(String, String, int) - Static method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm
Factory Method
createChecksum(File) - Static method in class uk.ac.gla.terrier.utility.Files
Returns the CRC checksum of denoted file
createDirectFile() - Method in class uk.ac.gla.terrier.applications.TRECIndexing
Builds the direct file and lexicon.
createDirectIndex(Collection[]) - Method in class uk.ac.gla.terrier.indexing.BasicIndexer
Creates the direct index, the document index and the lexicon.
createDirectIndex(Collection[]) - Method in class uk.ac.gla.terrier.indexing.BasicSinglePassIndexer
 
createDirectIndex(Collection[]) - Method in class uk.ac.gla.terrier.indexing.BlockIndexer
For the given collection, it iterates through the documents and creates the direct index, document index and lexicon, using information about blocks and possibly fields.
createDirectIndex(Collection[]) - Method in class uk.ac.gla.terrier.indexing.Indexer
An abstract method for creating the direct index, the document index and the lexicon for the given collections.
createDirectIndex() - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.Inverted2DirectIndexBuilder
create the direct index when the collection contains an existing inverted index
CreateDocumentInitialWeightIndex - Class in uk.ac.gla.terrier.indexing
This class creates the initial weight index of all documents in the collection.
CreateDocumentInitialWeightIndex(String) - Constructor for class uk.ac.gla.terrier.indexing.CreateDocumentInitialWeightIndex
The default constructor of CreateDocumentInitialWeightIndex.
CreateDocumentInitialWeightIndex(Index, String) - Constructor for class uk.ac.gla.terrier.indexing.CreateDocumentInitialWeightIndex
 
createDocumentInitialWeightIndex() - Method in class uk.ac.gla.terrier.indexing.CreateDocumentInitialWeightIndex
Create the DocumentInitialWeightIndex.
createIndex(String, String) - Static method in class uk.ac.gla.terrier.structures.Index
Factory method for load an index.
createIndex() - Static method in class uk.ac.gla.terrier.structures.Index
Factory method for creating an index.
createInvertedFile() - Method in class uk.ac.gla.terrier.applications.TRECIndexing
Building the inverted file.
createInvertedIndex() - Method in class uk.ac.gla.terrier.indexing.BasicIndexer
Creates the inverted index after having created the direct index, document index and lexicon.
createInvertedIndex() - Method in class uk.ac.gla.terrier.indexing.BasicSinglePassIndexer
 
createInvertedIndex(Collection[]) - Method in class uk.ac.gla.terrier.indexing.BasicSinglePassIndexer
Builds the inverted file and lexicon file for the given collections Loops through each document in each of the collections, extracting terms and pushing these through the Term Pipeline (eg stemming, stopping, lowercase).
createInvertedIndex() - Method in class uk.ac.gla.terrier.indexing.BlockIndexer
Creates the inverted index from the already created direct index, document index and lexicon.
createInvertedIndex() - Method in class uk.ac.gla.terrier.indexing.Indexer
An abstract method for creating the inverted index, given that the the direct index, the document index and the lexicon have already been created.
createInvertedIndex() - Method in class uk.ac.gla.terrier.structures.indexing.BlockInvertedIndexBuilder
This method creates the block html inverted index.
createInvertedIndex() - Method in class uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder
Creates the inverted index using the already created direct index, document index and lexicon.
createKey() - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.CollectionRecordReader
Create a new Key, each key is a Document Number
createLexiconHash(LexiconInputStream) - Method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
Create a lexicon hash for the current index
createLexiconHash(Index) - Static method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
Creates a lexicon hash for the specified index
createLexiconHash(LexiconInputStream, String, String) - Static method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
Creates a Lexicon hash.
createLexiconHash(LexiconInputStream, OutputStream) - Static method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
 
createLexiconIndex(LexiconInputStream, int, int) - Method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
Creates the lexicon index file that contains a mapping from the given term id to the offset in the lexicon, in order to be able to retrieve the term information according to the term identifier.
createLexiconIndex(LexiconInputStream, int, int, String, String) - Static method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
Creates the lexicon index file that contains a mapping from the given term id to the offset in the lexicon, in order to be able to retrieve the term information according to the term identifier.
createLexiconIndex(LexiconInputStream, int, int, DataOutputStream) - Static method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
 
createLexiconIndex(Index) - Static method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder
Creates a lexicon index for the specified index
createLMIndex() - Method in class uk.ac.gla.terrier.applications.TRECLMIndexing
Creates additional structures for language modeling.
createMemoryPostings() - Method in class uk.ac.gla.terrier.indexing.hadoop.Hadoop_BlockSinglePassIndexer
 
createNewIndex(String, String) - Static method in class uk.ac.gla.terrier.structures.Index
Factory method create a new index.
createRunIterator(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.FileRunIteratorFactory
Return a RunIterator for the specified runNumber
createRunIterator(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.HadoopRunIteratorFactory
 
createRunIterator(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.RunIteratorFactory
Open the RunIterator for the specified run number
createSinglePass() - Method in class uk.ac.gla.terrier.applications.TRECIndexing
Builds the inverted file from scratch, single pass method
CreateTermEstimateIndex - Class in uk.ac.gla.terrier.indexing
This class creates the term estimate index of all terms in vocabulary.
CreateTermEstimateIndex(String) - Constructor for class uk.ac.gla.terrier.indexing.CreateTermEstimateIndex
The default constructor of CreateTermEstimateIndex.
CreateTermEstimateIndex(Index, String) - Constructor for class uk.ac.gla.terrier.indexing.CreateTermEstimateIndex
 
createTermEstimateIndex() - Method in class uk.ac.gla.terrier.indexing.CreateTermEstimateIndex
Create the TermEstimateIndex.
createValue() - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.CollectionRecordReader
Create a new Text value, each value is a document
createWrapper(T) - Method in class uk.ac.gla.terrier.utility.Wrapper
 
CropTerm - Class in uk.ac.gla.terrier.terms
Reduces the size of terms passing through the term pipeline to the maximum allowed size for this indexing run.
CropTerm(TermPipeline) - Constructor for class uk.ac.gla.terrier.terms.CropTerm
Creates a new CropTerm pipeline object, which can be used in the term pipeline
current() - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.RunIterator
returns the current posting
currentTag() - Method in interface uk.ac.gla.terrier.indexing.Tokenizer
Returns the identifier of the tag the tokenizer is into.
currentTag() - Method in class uk.ac.gla.terrier.indexing.TRECFullTokenizer
Returns the name of the tag the tokenizer is currently in.

Terrier IR Platform
2.2.1
A B C D E F G H I J K L M N O P Q R S T U V W
Terrier Information Retrieval Platform 2.2.1. Copyright 2004-2008 University of Glasgow