A B C D E F G H I K L M N O P Q R S T U W

G

gain(double, double, double) - Method in class uk.ac.gla.terrier.matching.models.aftereffect.AfterEffect

This method provides the contract for implementing first normalisation by after effect.

gain(double, double, double) - Method in class uk.ac.gla.terrier.matching.models.aftereffect.B

This method computes the gain of encountering an extra token of the query term.

gain(double, double, double) - Method in class uk.ac.gla.terrier.matching.models.aftereffect.L

This method computes the gain of encountering an extra token of the query term.

gain(double, double, double) - Method in class uk.ac.gla.terrier.matching.models.aftereffect.LL

This method computes the gain of encountering an extra token of the query term.

generateDocumentFromFile(String) - Static method in class uk.ac.gla.terrier.indexing.TRECDocument

instantiates a TREC document from a file

GermanSnowballStemmer - Class in uk.ac.gla.terrier.terms

German stemmer implmented by Snowball.

GermanSnowballStemmer(TermPipeline) - Constructor for class uk.ac.gla.terrier.terms.GermanSnowballStemmer

getAllProperties() - Method in interface uk.ac.gla.terrier.indexing.Document

Returns the underlying map of all the properties defined by this Document.

getAllProperties() - Method in class uk.ac.gla.terrier.indexing.FileDocument

getAllProperties() - Method in class uk.ac.gla.terrier.indexing.TRECDocument

Returns the underlying map of all the properties defined by this Document.

getAllRelevantDocuments() - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory.QrelsHashSet

Get all relevant documents regardless of their relevance grades.

getAllRelevantDocumentsToArray() - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory.QrelsHashSet

Get all relevant documents regardless of their relevance grades.

getApplicationPath() - Method in class uk.ac.gla.terrier.applications.desktop.filehandling.ApplicationSelector

getAverageDocumentLength() - Method in class uk.ac.gla.terrier.structures.CollectionStatistics

Returns the documents' average length.

getBitFile() - Method in class uk.ac.gla.terrier.structures.InvertedIndex

Returns the underlying bit file, in order to make more efficient use of the bit file during assigning scores to the retrieved documents.

getBitOffset() - Method in class uk.ac.gla.terrier.compression.BitFile

Returns the bit offset of the last current byte in the buffer.

getBitOffset() - Method in class uk.ac.gla.terrier.compression.BitInputStream

Returns the bit offset in the last byte.

getBitOffset() - Method in class uk.ac.gla.terrier.compression.BitOutputStream

Returns the bit offset in the last byte.

getBlockCount() - Method in class uk.ac.gla.terrier.structures.trees.BlockFieldDocumentTreeNode

Deprecated. Returns how many separate blocks does this term occur in.

getBlockFrequency() - Method in class uk.ac.gla.terrier.structures.BlockLexicon

Returns the block frequency for the given term

getBlockFrequency() - Method in class uk.ac.gla.terrier.structures.BlockLexiconInputStream

Returns the block frequency for the currently processed term.

getBlockFrequency() - Method in class uk.ac.gla.terrier.structures.UTFBlockLexicon

Returns the block frequency for the given term

getBlockIds() - Method in class uk.ac.gla.terrier.structures.trees.BlockFieldDocumentTreeNode

Deprecated. Returns an array of the blocksids stored in this object.

getByteOffset() - Method in class uk.ac.gla.terrier.compression.BitFile

Returns the byte offset in the buffer.

getByteOffset() - Method in class uk.ac.gla.terrier.compression.BitInputStream

Returns the byte offset of the stream.

getByteOffset() - Method in class uk.ac.gla.terrier.compression.BitOutputStream

Returns the byte offset of the stream.

getByteOffset() - Method in interface uk.ac.gla.terrier.indexing.Tokenizer

Returns the byte offset in the current indexed file.

getByteOffset() - Method in class uk.ac.gla.terrier.indexing.TRECFullTokenizer

Returns the number of bytes read from the current file.

getClasses() - Method in class uk.ac.gla.terrier.structures.CollectionStatistics

Returns the classes line given in the log file.

getCode(String) - Static method in class uk.ac.gla.terrier.utility.TermCodes

Returns the code for a given term.

getCollectionStatistics() - Method in class uk.ac.gla.terrier.structures.Index

getControl(String) - Method in class uk.ac.gla.terrier.querying.Request

Returns the value of the control.

getControl(String) - Method in interface uk.ac.gla.terrier.querying.SearchRequest

Returns the value of the control.

getControlHashtable() - Method in class uk.ac.gla.terrier.querying.Request

Get the entire hashtable used for storing controls for this query

getDirectIndex() - Method in class uk.ac.gla.terrier.structures.Index

Return the direct index to use for retrieval.

getDirectIndexEndOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndex

Returns the ending offset of the document's entry in the direct index.

getDirectIndexEndOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded

Returns the ending offset of the current document's entry in the direct index.

getDirectIndexEndOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory

Returns the ending offset of the current document's entry in the direct index.

getDirectIndexStartOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndex

Returns the starting offset of the document's entry in the direct index.

getDirectIndexStartOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded

Returns the starting offset of the current document's entry in the direct index.

getDirectIndexStartOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory

Returns the starting offset of the current document's entry in the direct index.

getDocid() - Method in interface uk.ac.gla.terrier.indexing.Collection

Get the String document identifier of the current document.

getDocid() - Method in class uk.ac.gla.terrier.indexing.SimpleFileCollection

Returns the current document's identifier string.

getDocid() - Method in class uk.ac.gla.terrier.indexing.SimpleXMLCollection

getDocid() - Method in class uk.ac.gla.terrier.indexing.TRECCollection

Returns the document number of the current document.

getDocids() - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Returns the documents ids after retrieval

getDocids() - Method in interface uk.ac.gla.terrier.matching.ResultSet

Returns the documents ids after retrieval

getDocTag() - Method in class uk.ac.gla.terrier.utility.TagSet

Return the document delimiter tag.

getDocument() - Method in interface uk.ac.gla.terrier.indexing.Collection

Get the document object representing the current document.

getDocument() - Method in class uk.ac.gla.terrier.indexing.SimpleFileCollection

Return the current document in the collection.

getDocument() - Method in class uk.ac.gla.terrier.indexing.SimpleXMLCollection

getDocument() - Method in class uk.ac.gla.terrier.indexing.TRECCollection

Returns the current document to process.

getDocument(TagSet, TagSet, TagSet) - Method in class uk.ac.gla.terrier.indexing.TRECCollection

A TREC-specific getDocument method, that allows the tags to be specified for each document.

getDocument() - Method in class uk.ac.gla.terrier.indexing.TRECUTFCollection

Overrides the getDocument() method in TRECCollection, so a UTF compatible Document object is returned.

getDocument(TagSet, TagSet, TagSet) - Method in class uk.ac.gla.terrier.indexing.TRECUTFCollection

A TREC-specific getDocument method, that allows the tags to be specified for each document.

getDocumentFrequency() - Method in class uk.ac.gla.terrier.structures.ExpansionTerms.ExpansionTerm

The method returns the document frequency of term in the top-retrieved documents.

getDocumentFrequency(int) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the number of the top-ranked documents a given term occurs in.

getDocumentId(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndex

Returns the document's id for the given docno.

getDocumentId(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded

Returns the id of a document with a given document number.

getDocumentId(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory

Returns the id of a document with a given document number.

getDocumentId() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream

Returns the document's id for the given docno.

getDocumentIndex() - Method in class uk.ac.gla.terrier.structures.Index

Return the document index to use for retrieval.

getDocumentInitialWeight(int) - Method in class uk.ac.gla.terrier.structures.indexing.DocumentInitialWeightIndex

getDocumentLength(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndex

Reading the length for the i-th document.

getDocumentLength(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndex

Return the length of the document with the given docno.

getDocumentLength(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded

Returns the length of a document with a given id.

getDocumentLength(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded

Returns the document length of the document with a given document number .

getDocumentLength(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory

Returns the length of a document with a given id.

getDocumentLength(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory

Returns the document length of the document with a given document number .

getDocumentLength() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream

Return the length of the document with the given docno.

getDocumentLength() - Method in class uk.ac.gla.terrier.structures.indexing.DocumentPostingList

Returns the total number of tokens in this document

getDocumentNumber(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndex

Reading the docno for the i-th document.

getDocumentNumber(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded

Returns the number of a document with a given id.

getDocumentNumber(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory

Returns the number of a document with a given id.

getDocumentNumber() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream

Reading the docno for the i-th document.

getDocuments(long, byte, long, byte) - Method in class uk.ac.gla.terrier.structures.BlockInvertedIndex

Returns a 2D array containing the document ids, the term frequencies, the field scores the block frequencies and the block ids for the given documents.

getDocuments(LexiconEntry) - Method in class uk.ac.gla.terrier.structures.InvertedIndex

getDocuments(int) - Method in class uk.ac.gla.terrier.structures.InvertedIndex

Returns a two dimensional array containing the document ids, term frequencies and field scores for the given documents.

getDocuments(long, byte, long, byte) - Method in class uk.ac.gla.terrier.structures.InvertedIndex

Returns a two dimensional array containing the document ids, term frequencies and field scores for the given documents.

getDocuments(int, int, int) - Method in class uk.ac.gla.terrier.structures.InvertedIndex

Returns a five dimensional array containing the document ids, the term frequencies, the field scores the block frequencies and the block ids for the given documents.

getDocumentScoreModifier(int) - Method in class uk.ac.gla.terrier.matching.Matching

Returns the i-th registered document score modifier.

getDocumentScoreModifiers() - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Returns the document score modifiers used for the query.

getDocumentsSkipped() - Method in class uk.ac.gla.terrier.structures.DirectIndexInputStream

Returns the value of the documents that were skipped during a call to the method getNextTerms()

getDocumentString(int) - Method in interface uk.ac.gla.terrier.indexing.DocumentExtractor

Returns the text of a document with the given identifier.

getDocumentString(int) - Method in class uk.ac.gla.terrier.indexing.TRECCollection

Returns the text of a document with the given identifier.

getDocumentsWithoutBlocks(int, int, int) - Method in class uk.ac.gla.terrier.structures.BlockInvertedIndex

getDocumentsWithoutBlocks(int) - Method in class uk.ac.gla.terrier.structures.BlockInvertedIndex

getEndBitOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream

Returns the bit offset in the ending byte in the direct file's entry for this document

getEndBitOffset() - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns the bit offset in the last byte of the term's entry in the inverted file.

getEndBitOffset() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the bit offset in the last byte of the term's entry in the inverted file.

getEndOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream

Returns the offset of the ending byte in the direct file for this document

getEndOffset() - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns the ending offset of the term's entry in the inverted file.

getEndOffset() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the ending offset of the term's entry in the inverted file.

getEntrySize() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

getExactResultSize() - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Returns the exact size of the result set.

getExactResultSize() - Method in interface uk.ac.gla.terrier.matching.ResultSet

Returns the exact size of the result set.

getExpandedTerms(int, QueryExpansionModel) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

This method implements the functionality of assigning expansion weights to the terms in the top-retrieved documents, and returns the most informative terms among them.

getExpansionProbability(int) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the probability of a given termid occurring in the expansion documents.

getExpansionWeight(String, QueryExpansionModel) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the weight of a given term, computed by the specified query expansion model.

getExpansionWeight(String) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the weight of a given term.

getExpansionWeight(int, QueryExpansionModel) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the weight of a term with the given term identifier, computed by the specified query expansion model.

getExpansionWeight(int) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the weight of a term with the given term identifier.

getField() - Method in class uk.ac.gla.terrier.querying.parser.FieldQuery

Gets the field that the query term should appear.

getFields() - Method in interface uk.ac.gla.terrier.indexing.Document

Returns a list of the fields the current term appears in.

getFields() - Method in class uk.ac.gla.terrier.indexing.FileDocument

Returns null because there is no support for fields with file documents.

getFields() - Method in class uk.ac.gla.terrier.indexing.TRECDocument

Returns the fields in which the current term appears in.

getFieldScore() - Method in class uk.ac.gla.terrier.structures.trees.FieldDocumentTreeNode

Deprecated. Gets the field score of the tree node.

getFieldScore() - Method in class uk.ac.gla.terrier.utility.FieldScore

Computes an field score associated with a page.

getFieldWeight() - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation

Returns the weight of the field for field retrieval.

getFileList() - Method in class uk.ac.gla.terrier.indexing.SimpleFileCollection

Returns the list of indexed files in the order they were indexed in.

getFinalNumberOfTerms() - Method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder

Returns the number of terms in the final lexicon.

getFolders() - Method in class uk.ac.gla.terrier.applications.desktop.IndexFolders

Returns the list of selected folders.

getFrequency(String) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the frequency of a given term in the top-ranked documents.

getFrequency(int) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the frequency of a given term in the top-ranked documents.

getIdTag() - Method in class uk.ac.gla.terrier.utility.TagSet

Return the id tag.

getInBuffer() - Method in class uk.ac.gla.terrier.compression.BitFile

Returns the current buffer being processed

getIndex() - Method in class uk.ac.gla.terrier.applications.TRECQuerying

Get the index pointer.

getIndex() - Method in class uk.ac.gla.terrier.querying.Manager

Returns the index used by the manager.

getIndexOfCurrentQuery() - Method in class uk.ac.gla.terrier.structures.TRECQuery

Returns the index of the last obtained query.

getInfo() - Method in class uk.ac.gla.terrier.matching.LMMatching

Returns a descriptive string for the retrieval process performed.

getInfo() - Method in class uk.ac.gla.terrier.matching.Matching

Returns a descriptive string for the retrieval process performed.

getInfo() - Method in interface uk.ac.gla.terrier.matching.Model

Returns a model dependant string, such that runs can be identified from TREC results.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.aftereffect.AfterEffect

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.aftereffect.B

This method returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.aftereffect.L

This method returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.aftereffect.LL

Returns the name of the method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.B

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.BasicModel

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.BM

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.Br

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.IF

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.In

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.In_exp

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.basicmodel.P

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.BB2

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.BM25

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.DFR_BM25

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.DLH

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.DLH13

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.Hiemstra_LM

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.IFB2

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.In_expB2

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.In_expC2

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.InL2

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.LemurTF_IDF

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation

This method provides the contract for getting the name of the implemented frequency normalisation method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation0

Get the name of the normalisation method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation2

Get the name of the normalisation method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation2exp

Get the name of the normalisation method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation3

Get the name of the normalisation method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.normalisation.NormalisationB

Get the name of the normalisation method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.normalisation.NormalisationStatic

Get the name of the normalisation method.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.PL2

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.Bo1

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.Bo2

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.KL

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel

Returns the name of the model.

getInfo() - Method in class uk.ac.gla.terrier.matching.models.TF_IDF

Returns the name of the model, in this case "TF_IDF"

getInfo() - Method in class uk.ac.gla.terrier.matching.models.WeightingModel

Returns the name of the model.

getInfo(SearchRequest) - Method in class uk.ac.gla.terrier.querying.Manager

Returns information about the weighting models and the post processors used for the given search request.

getInfo() - Method in interface uk.ac.gla.terrier.querying.PostProcess

Returns the name of the post processor.

getInfo() - Method in class uk.ac.gla.terrier.querying.QueryExpansion

Returns the name of the used query expansion model.

getInvertedIndex() - Method in class uk.ac.gla.terrier.structures.Index

Return the inverted index to use for retrieval.

getLastEndOffset() - Method in class uk.ac.gla.terrier.structures.indexing.DirectIndexBuilder

Returns the current offset in the direct index.

getLexicon() - Method in class uk.ac.gla.terrier.structures.Index

Return the lexicon to use for retrieval.

getLexiconEntry(int) - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns a LexiconEntry describing all the information in the lexicon about the term denoted by termid

getLexiconEntry(String) - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns a LexiconEntry describing all the information in the lexicon about the term denoted by _term

getLexiconEntry(int) - Method in class uk.ac.gla.terrier.structures.UTFLexicon

Returns a LexiconEntry describing all the information in the lexicon about the term denoted by termid

getLexiconEntry(String) - Method in class uk.ac.gla.terrier.structures.UTFLexicon

Returns a LexiconEntry describing all the information in the lexicon about the term denoted by _term

getLexInputStream(String) - Method in class uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder

getLexInputStream(String) - Method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder

getLexOutputStream(String) - Method in class uk.ac.gla.terrier.structures.indexing.InvertedIndexBuilder

getLexOutputStream(String) - Method in class uk.ac.gla.terrier.structures.indexing.LexiconBuilder

getLock() - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Returns the lock for enabling the modification of the result set by more than one threads.

getLock() - Method in interface uk.ac.gla.terrier.matching.ResultSet

Returns the lock associated with the result set.

getManager() - Method in class uk.ac.gla.terrier.applications.TRECQuerying

Get the querying manager.

getMatchingModel() - Method in class uk.ac.gla.terrier.querying.Request

returns the name of the matching model that should be used for retrieval

getMatchingQueryTerms() - Method in class uk.ac.gla.terrier.querying.Request

Return the MatchingQueryTerms object to use for matching

getMetaItem(String, int) - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Empty method.

getMetaItem(String, int) - Method in class uk.ac.gla.terrier.matching.QueryResultSet

Gets a metadata value for a given document.

getMetaItem(String, int) - Method in interface uk.ac.gla.terrier.matching.ResultSet

Gets a metadata value for a given document.

getMetaItems(String) - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Empty method.

getMetaItems(String) - Method in class uk.ac.gla.terrier.matching.QueryResultSet

Gets the metadata information for all documents.

getMetaItems(String) - Method in interface uk.ac.gla.terrier.matching.ResultSet

Gets the metadata information for all documents.

getMinutes() - Method in class uk.ac.gla.terrier.utility.TerrierTimer

Get the processing time in minutes.

getModifiers() - Static method in class uk.ac.gla.terrier.utility.FieldScore

Returns the modifiers scores.

getName() - Method in class uk.ac.gla.terrier.matching.dsms.BooleanFallback

Returns the name of the modifier, which is BooleanFallback.

getName() - Method in class uk.ac.gla.terrier.matching.dsms.BooleanScoreModifier

Returns the name of the document score modifier.

getName() - Method in interface uk.ac.gla.terrier.matching.dsms.DocumentScoreModifier

Returns the name of the document score modifier.

getName() - Method in class uk.ac.gla.terrier.matching.dsms.PhraseScoreModifier

Returns the name of the modifier.

getName() - Method in class uk.ac.gla.terrier.matching.tsms.FieldScoreModifier

getName() - Method in class uk.ac.gla.terrier.matching.tsms.RequiredTermModifier

getName() - Method in class uk.ac.gla.terrier.matching.tsms.TermInFieldModifier

getName() - Method in interface uk.ac.gla.terrier.matching.tsms.TermScoreModifier

Returns the name of the modifier.

getNextTerm() - Method in interface uk.ac.gla.terrier.indexing.Document

Gets the next term of the document.

getNextTerm() - Method in class uk.ac.gla.terrier.indexing.FileDocument

Gets the next term from the Document

getNextTerm() - Method in class uk.ac.gla.terrier.indexing.HTMLDocument

Returns the next term from a document.

getNextTerm() - Method in class uk.ac.gla.terrier.indexing.TRECDocument

Returns the next term from a document.

getNextTerms() - Method in class uk.ac.gla.terrier.structures.BlockDirectIndexInputStream

Reads the next document's entry from the direct file.

getNextTerms() - Method in class uk.ac.gla.terrier.structures.DirectIndexInputStream

One call returns all the data for one document - [0][] is term ids, [1][] is frequency, [2][] is fields.

getNextTerms(long, byte) - Method in class uk.ac.gla.terrier.structures.DirectIndexInputStream

getNonRelevantDocuments(String) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Get the pooled non-relevant documents for the given query.

getNonRelevantDocumentsToArray(String) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Get the pooled non-relevant documents for a given query.

getNt() - Method in class uk.ac.gla.terrier.structures.Lexicon

Return the document frequency for the given term.

getNt() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Return the document frequency for the given term.

getNumberOfBlocks() - Method in class uk.ac.gla.terrier.structures.trees.BlockFieldDocumentTree

Deprecated. Returns the number of blocks in the tree.

getNumberOfDocuments() - Method in class uk.ac.gla.terrier.structures.CollectionStatistics

Returns the total number of documents in the collection.

getNumberOfDocuments() - Method in class uk.ac.gla.terrier.structures.DocumentIndex

Returns the number of documents in the collection.

getNumberOfDocuments() - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded

Returns the number of documents in the document index.

getNumberOfDocuments() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory

Returns the number of documents.

getNumberOfDocumentsAfterFiltering() - Method in class uk.ac.gla.terrier.querying.Request

returns the number of documents in the result set after applying post filters.

getNumberOfDocumentsAfterFiltering() - Method in interface uk.ac.gla.terrier.querying.SearchRequest

gets the number of documents returned for a search request, after applying post filtering

getNumberOfLexiconEntries() - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns the number of entries in the lexicon.

getNumberOfNodes() - Method in class uk.ac.gla.terrier.structures.indexing.LexiconMap

Returns the numbe of nodes in the tree.

getNumberOfNodes() - Method in class uk.ac.gla.terrier.structures.trees.BlockLexiconTree

Deprecated. Returns the number of nodes in the tree.

getNumberOfNodes() - Method in class uk.ac.gla.terrier.structures.trees.BlockTree

Deprecated. Returns the number of nodes in the tree.

getNumberOfNodes() - Method in class uk.ac.gla.terrier.structures.trees.DocumentTree

Deprecated. Returns the number of nodes in the tree.

getNumberOfNodes() - Method in class uk.ac.gla.terrier.structures.trees.FieldDocumentTree

Deprecated. Returns the number of nodes in the tree.

getNumberOfNodes() - Method in class uk.ac.gla.terrier.structures.trees.LexiconTree

Deprecated. Returns the numbe of nodes in the tree.

getNumberOfNodes() - Method in class uk.ac.gla.terrier.structures.trees.TermTree

Deprecated. Returns the number of nodes in the tree.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.CollectionStatistics

Returns the total number of pointers in the collection.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.indexing.DocumentPostingList

Returns the number of unique terms in this document.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.indexing.LexiconMap

Returns the number of pointers in the tree.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.trees.BlockLexiconTree

Deprecated. Returns the number of pointers in the tree.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.trees.BlockTree

Deprecated. Returns the number of pointers in the tree.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.trees.DocumentTree

Deprecated. Returns the number of pointers in the tree.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.trees.FieldDocumentTree

Deprecated. Returns the number of pointers in the tree.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.trees.LexiconTree

Deprecated. Returns the number of pointers in the tree.

getNumberOfPointers() - Method in class uk.ac.gla.terrier.structures.trees.TermTree

Deprecated. Returns the number of pointers in the tree.

getNumberOfPointersWritten() - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream

Returns the number of pointers there would be in an inverted index built using this lexicon.

getNumberOfQueries() - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Returns the total number of queries contained in the loaded relevance assessments.

getNumberOfQueries() - Method in class uk.ac.gla.terrier.structures.TRECQuery

Returns the number of the queries read from the processed topic files.

getNumberOfRelevant(String) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Returns the numbe of relevant documents for a given query.

getNumberOfTerms() - Method in class uk.ac.gla.terrier.querying.parser.MultiTermQuery

Returns the number of terms, or subqueries.

getNumberOfTermsWritten() - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream

getNumberOfTokens() - Method in class uk.ac.gla.terrier.structures.CollectionStatistics

Returns the total number of tokens in the collection.

getNumberOfTokensWritten() - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream

Returns the number of tokens there are in the entire collection represented by this lexicon.

getNumberOfUniqueTerms() - Method in class uk.ac.gla.terrier.structures.CollectionStatistics

Returns the total number of unique terms in the lexicon.

getNumberOfUniqueTerms() - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the unique number of terms found in all the top-ranked documents

getOccurrences() - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Returns the occurrences array.

getOccurrences() - Method in interface uk.ac.gla.terrier.matching.ResultSet

Returns the occurrences array.

getOriginalExpansionWeight(String) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the un-normalised weight of a given term.

getOriginalQuery() - Method in class uk.ac.gla.terrier.querying.Request

gets the string of the original query, before applying any pre-processing.

getOriginalQuery() - Method in interface uk.ac.gla.terrier.querying.SearchRequest

gets the original query, before any preprocessing

getParameter() - Method in interface uk.ac.gla.terrier.matching.Model

Returns the current value of the parameter set using setParameter() method.

getParameter() - Method in class uk.ac.gla.terrier.matching.models.aftereffect.AfterEffect

getParameter() - Method in class uk.ac.gla.terrier.matching.models.BM25

Returns the b parameter to the BM25 ranking formula as set by setParameter()

getParameter() - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel

Return the parameter set by setParameter()

getParameter() - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel

getParameter() - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation

Returns the hyper-parameter value.

getParameter() - Method in class uk.ac.gla.terrier.matching.models.TF_IDF

Returns the b parameter to the ranking formula as set by setParameter()

getParameter() - Method in class uk.ac.gla.terrier.matching.models.WeightingModel

Returns the parameter as set by setParameter()

getPath() - Method in class uk.ac.gla.terrier.structures.Index

getPercentage() - Method in class uk.ac.gla.terrier.utility.TerrierTimer

getPostings() - Method in class uk.ac.gla.terrier.structures.indexing.BlockDocumentPostingList

returns the postings suitable to be written into the block direct index

getPostings() - Method in class uk.ac.gla.terrier.structures.indexing.DocumentPostingList

returns the postings suitable to be written into the direct index

getPrefix() - Method in class uk.ac.gla.terrier.structures.Index

getProperty(String) - Method in interface uk.ac.gla.terrier.indexing.Document

Allows access to a named property of the Document.

getProperty(String) - Method in class uk.ac.gla.terrier.indexing.FileDocument

getProperty(String) - Method in class uk.ac.gla.terrier.indexing.TRECDocument

Allows access to a named property of the Document.

getProperty(String, String) - Static method in class uk.ac.gla.terrier.utility.ApplicationSetup

Returns the value for the specified property, given a default value, in case the property was not defined during the initialization of the system.

getQuery() - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Returns guess what?

getQuery() - Method in class uk.ac.gla.terrier.querying.Request

Get the Query syntax tree

getQuery() - Method in interface uk.ac.gla.terrier.querying.SearchRequest

Get the Query syntax tree

getQuery(String) - Method in class uk.ac.gla.terrier.structures.TRECQuery

Return the query for the given query number.

getQueryExpansionModel(String) - Method in class uk.ac.gla.terrier.querying.QueryExpansion

Obtain the query expansion model for QE to use.

getQueryId() - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Returns the query id specified when constructing this object.

getQueryID() - Method in class uk.ac.gla.terrier.querying.Request

Returns the query id as set by setQueryID(String).

getQueryID() - Method in interface uk.ac.gla.terrier.querying.SearchRequest

Returns the query id as set by setQueryID(String).

getQueryId() - Method in class uk.ac.gla.terrier.structures.TRECQuery

Returns the query identifier of the last query fetched, or the first one, if none has been fetched yet.

getQueryids() - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Get ids of the queries that appear in the pool.

getQueryLength() - Method in class uk.ac.gla.terrier.structures.Query

Deprecated. Returns the query length, ie the number of non-stopwords in the query

getQueryNumber() - Method in class uk.ac.gla.terrier.structures.Query

Deprecated. Returns the query number

getQueryTerms() - Method in class uk.ac.gla.terrier.structures.Query

Deprecated. Returns a representation of the query as a TermTreeNode array

getQueryTermStrings() - Method in class uk.ac.gla.terrier.structures.Query

Deprecated.

getReader() - Method in interface uk.ac.gla.terrier.indexing.Document

Returns a Reader object so client code can tokenise the document or deal with the document itself.

getReader() - Method in class uk.ac.gla.terrier.indexing.FileDocument

Returns the underlying buffered reader, so that client code can tokenise the document itself, and deal with it how it likes.

getReader() - Method in class uk.ac.gla.terrier.indexing.TRECDocument

Returns the underlying buffered reader, so that client code can tokenise the document itself, and deal with it how it likes.

getRelevantDocuments(String) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Get the pooled relevant documents for the given query.

getRelevantDocuments(String, int) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Get the pooled relevant documents for the given query.

getRelevantDocuments(int) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory.QrelsHashSet

Get the relevant documents for a given relevance grade.

getRelevantDocumentsToArray(String) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Get the pooled relevant documents for a given query.

getRelevantDocumentsToArray(String, int) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory

Get the pooled relevant documents for a given query.

getRelevantDocumentsToArray(int) - Method in class uk.ac.gla.terrier.evaluation.TRECQrelsInMemory.QrelsHashSet

Get the relevant documents for a given relevance grade.

getRequired() - Method in class uk.ac.gla.terrier.querying.parser.RequirementQuery

Returns True if the subquery is REQUIRED to exist, or false if it REQUIRED to NOT exit.

getRequired() - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery

Indicates whether the query term is required, or it isn't required to appear in the retrieved documents.

getResultFile(String) - Method in class uk.ac.gla.terrier.applications.TRECQuerying

Returns a PrintWriter used to store the results.

getResultSet(int, int) - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Crops the existing result file and extracts a subset from the given starting point to the ending point.

getResultSet(int[]) - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Extracts a subset of the resultset given by the list parameter, which contains a list of positions in the resultset that should be saved.

getResultSet() - Method in class uk.ac.gla.terrier.matching.Matching

Returns the result set.

getResultSet(int, int) - Method in class uk.ac.gla.terrier.matching.QueryResultSet

Crops the existing result file and extracts a subset from the given starting point to the ending point.

getResultSet(int[]) - Method in class uk.ac.gla.terrier.matching.QueryResultSet

Extracts a subset of the resultset given by the list parameter, which contains a list of positions in the resultset that should be saved.

getResultSet(int, int) - Method in interface uk.ac.gla.terrier.matching.ResultSet

Crops the existing result file and extracts a subset from the given starting point, with the given length.

getResultSet(int[]) - Method in interface uk.ac.gla.terrier.matching.ResultSet

Extracts a subset of the resultset given by the list parameter, which contains a list of positions in the resultset that should be saved.

getResultSet() - Method in class uk.ac.gla.terrier.querying.Request

Returns the resultset generated by the query.

getResultSet() - Method in interface uk.ac.gla.terrier.querying.SearchRequest

Returns the resultset generated by the query.

getResultSize() - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Returns the effective size of the result set.

getResultSize() - Method in interface uk.ac.gla.terrier.matching.ResultSet

Returns the effective size of the result set.

getScores() - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Returns the documents scores after retrieval

getScores() - Method in interface uk.ac.gla.terrier.matching.ResultSet

Returns the documents scores after retrieval

getSeconds() - Method in class uk.ac.gla.terrier.utility.TerrierTimer

Get the processing time in seconds.

getStartBitOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream

Return the bit offset in the starting byte in the entry in the direct file for this document.

getStartBitOffset() - Method in class uk.ac.gla.terrier.structures.Lexicon

The bit offset in the starting byte of the entry in the inverted file.

getStartBitOffset() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the bit offset in the first byte of the term's entry in the inverted file.

getStartedProcessingTime() - Method in class uk.ac.gla.terrier.querying.Request

returns the time when the processing of the request started.

getStartedProcessingTime() - Method in interface uk.ac.gla.terrier.querying.SearchRequest

getStartOffset() - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream

Return the starting byte in the direct file for this document.

getStartOffset() - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns the beginning of the term's entry in the inverted file.

getStartOffset() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the starting offset of the term's entry in the inverted file.

getStatusCode() - Method in class uk.ac.gla.terrier.matching.CollectionResultSet

Returns the status code for the current result set.

getStatusCode() - Method in interface uk.ac.gla.terrier.matching.ResultSet

Returns a status code for the result set

getTagsToProcess() - Method in class uk.ac.gla.terrier.utility.TagSet

Returns a comma separated list of tags to process

getTagsToSkip() - Method in class uk.ac.gla.terrier.utility.TagSet

Returns a comma separated list of tags to skip

getTerm() - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery

Gets the query term.

getTerm() - Method in class uk.ac.gla.terrier.structures.Lexicon

Insert the method's description here.

getTerm() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the string representation of the term.

getTerm() - Method in class uk.ac.gla.terrier.structures.UTFBlockLexiconInputStream

Returns the string representation of the term.

getTerm() - Method in class uk.ac.gla.terrier.structures.UTFLexiconInputStream

Returns the string representation of the term.

getTermCharacters() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the bytes of the String.

getTermCharacters() - Method in class uk.ac.gla.terrier.structures.UTFBlockLexiconInputStream

Returns the bytes of the String.

getTermCharacters() - Method in class uk.ac.gla.terrier.structures.UTFLexiconInputStream

Returns the bytes of the String.

getTermCode(String) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Returns the assocciated code of the given query term.

getTermEstimateByTermid(int) - Method in class uk.ac.gla.terrier.structures.indexing.TermEstimateIndex

Get the term estimate of a term by termid.

getTermID() - Method in class uk.ac.gla.terrier.structures.ExpansionTerms.ExpansionTerm

Returns the ID of the term.

getTermId() - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns the term's id.

getTermId() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the term's id.

getTermIds() - Method in class uk.ac.gla.terrier.structures.ExpansionTerms

Returns the termids of all terms found in the top-ranked documents

getTerms() - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Currently uses Array.sort(Object[]), will retain order of query terms // in future.

getTerms(int) - Method in class uk.ac.gla.terrier.structures.BlockDirectIndex

Returns a five dimensional array containing the term ids and the term frequencies for the given document.

getTerms(int) - Method in class uk.ac.gla.terrier.structures.DirectIndex

Returns a two dimensional array containing the term ids and the term frequencies for the given document.

getTermScoreModifier(int) - Method in class uk.ac.gla.terrier.matching.Matching

Returns the i-th registered term score modifier.

getTermScoreModifiers(String) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Returns the term score modifiers assocciated with the given query term.

getTermsOf(Class, ArrayList, boolean) - Method in class uk.ac.gla.terrier.querying.parser.FieldQuery

Returns all the query terms, in subqueries that are instances of a given class

getTermsOf(Class, ArrayList, boolean) - Method in class uk.ac.gla.terrier.querying.parser.MultiTermQuery

Returns all the query terms, in subqueries that are instances of a given class

getTermsOf(Class, ArrayList, boolean) - Method in class uk.ac.gla.terrier.querying.parser.PhraseQuery

Returns all the query terms, in subqueries that are instances of a given class

getTermsOf(Class, ArrayList, boolean) - Method in class uk.ac.gla.terrier.querying.parser.Query

Returns all the query terms, in subqueries that are instances of a given class

getTermsOf(Class, ArrayList, boolean) - Method in class uk.ac.gla.terrier.querying.parser.RequirementQuery

Returns all the query terms, in subqueries that are instances of a given class.

getTermsOf(Class, ArrayList, boolean) - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery

An empty method because the single term query cannot have children.

getTermWeight(String) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Returns the assocciated weight of the given query term.

getTermWeights() - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms

Returns the associated weights of the given query terms.

getTF() - Method in class uk.ac.gla.terrier.structures.Lexicon

Returns the term frequency for the already seeked term.

getTF() - Method in class uk.ac.gla.terrier.structures.LexiconInputStream

Returns the term frequency for the already seeked term.

getTopicFilenames() - Method in class uk.ac.gla.terrier.structures.TRECQuery

Returns the filenames of the topic files from which the queries were extracted

getUsedProperties() - Static method in class uk.ac.gla.terrier.utility.ApplicationSetup

Returns a properties object detailing all the properties fetched during the lifetime of this class.

getWeight() - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery

Returns the weight of the query term.

getWeightExpansion() - Method in class uk.ac.gla.terrier.structures.ExpansionTerms.ExpansionTerm

The method returns the expansion weight of the term.

getWeightingModel() - Method in class uk.ac.gla.terrier.querying.Request

returns the name of the weighting model that should be used for retrieval

getWithinDocumentFrequency() - Method in class uk.ac.gla.terrier.structures.ExpansionTerms.ExpansionTerm

The method returns the frequency of the term in the X top-retrieved documents.