Serialized Form

Package org.terrier.indexing.tokenisation

Class org.terrier.indexing.tokenisation.EnglishTokeniser extends Tokeniser implements Serializable

Class org.terrier.indexing.tokenisation.IdentityTokeniser extends Tokeniser implements Serializable

Class org.terrier.indexing.tokenisation.Tokeniser extends java.lang.Object implements Serializable

Class org.terrier.indexing.tokenisation.UTFTokeniser extends Tokeniser implements Serializable

Class org.terrier.indexing.tokenisation.UTFTwitterTokeniser extends Tokeniser implements Serializable

Package org.terrier.learning

Class org.terrier.learning.FeaturedQueryResultSet extends QueryResultSet implements Serializable

serialVersionUID:

-3901317640015640668L

Serialized Fields

defLabel

java.lang.String defLabel

features

java.util.Map<java.lang.String,double[]> features

labels

java.lang.String[] labels

Package org.terrier.matching

Class org.terrier.matching.AccumulatorResultSet extends java.lang.Object implements Serializable

Serialized Fields

arraysInitialised

boolean arraysInitialised

docids

int[] docids

docid[]

exactResultSize

int exactResultSize

lock

java.util.concurrent.locks.Lock lock

mapsInitialised

boolean mapsInitialised

occurrences

short[] occurrences

occurrences

occurrencesMap

gnu.trove.TIntShortHashMap occurrencesMap

occurrence map

resultSize

int resultSize

scores

double[] scores

scores[]

scoresMap

gnu.trove.TIntDoubleHashMap scoresMap

score map

statusCode

int statusCode

Class org.terrier.matching.CollectionResultSet extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

arraysInitialised

boolean arraysInitialised

A static boolean flag indicating whether the arrays of docids and scores have been initialized (memory allocated for them) or not.

docids

int[] docids

The array that stores the document ids.

exactResultSize

int exactResultSize

The number of retrieved documents. This may be higher that <tt>resultSize<tt>, and corresponds to the number of documents that contain at least one query term.

lock

java.util.concurrent.locks.Lock lock

A lock for enabling access of the result set by different threads

occurrences

short[] occurrences

The occurrences of the query terms in a document. This allows to use Boolean operators and filter documents. If the i-th query term appears in the j-th document, then the i-th bit of occurrences[j] is set, otherwise it is zero. Using a 2-byte long integer allows to check for the occurence of up to 16 query terms.

resultSize

int resultSize

The number of documents that have been ranked and sorted according to their scores.

scores

double[] scores

An array holding the scores of documents in the collection.

statusCode

int statusCode

A status code for the result set.

Class org.terrier.matching.FatQueryResultSet extends QueryResultSet implements Serializable

serialVersionUID:

1L

Serialized Fields

collStats

CollectionStatistics collStats

entryStats

EntryStatistics[] entryStats

keyFrequency

double[] keyFrequency

postings

WritablePosting[][] postings

queryTerms

java.lang.String[] queryTerms

tags

java.util.Set<java.lang.String>[] tags

Class org.terrier.matching.MatchingQueryTerms extends java.util.ArrayList<MatchingQueryTerms.MatchingTerm> implements Serializable

serialVersionUID:

-9L

Serialized Fields

defaultTags

java.util.Set<java.lang.String> defaultTags

defaultWeightingModel

WeightingModel defaultWeightingModel

default weighting model for all terms

docScoreModifiers

java.util.ArrayList<DocumentScoreModifier> docScoreModifiers

The document score modifiers associated with the query terms. It should contain the phrase score modifiers for example.

numDocsRequest

int numDocsRequest

number of documents to request matching provides. -1 means default.

query

Query query

The original query as it came from the parser, in case any TSMs or DSMs wish to refer to it

queryId

java.lang.String queryId

The query ID, if provided

rq

Request rq

Class org.terrier.matching.MatchingQueryTerms.QueryTermProperties extends java.lang.Object implements Serializable

serialVersionUID:

6327392687128896557L

Serialized Fields

index

int index

the index at which this term was inserted

required

java.lang.Boolean required

stats

EntryStatistics stats

Info about the query term.

tags

java.util.Set<java.lang.String> tags

termModels

java.util.List<WeightingModel> termModels

The term score modifiers associated with a particular query term.

weight

double weight

The weight of a query term. This is usually how many times the term occurred in the query, but sometime may be altered if a weight has been specified on the query term: eg QueryExpansion will do this, as will manually specifying a weight on the unparsed query (example term1 term2^3).

Class org.terrier.matching.QueryResultSet extends CollectionResultSet implements Serializable

serialVersionUID:

1L

Serialized Fields

metadata

java.lang.String[][] metadata

The structure holding the metadata. Each column is associated with a named metavalue type, as known by metaMap. Each row is for a given document.

metaMap

gnu.trove.TObjectIntHashMap<java.lang.String> metaMap

The structure that holds the metadata about the results. It maps the metadata name, a string, to an array index of the metadata array that contains the particular metadata.

Package org.terrier.matching.daat

Class org.terrier.matching.daat.CandidateResultSet extends java.lang.Object implements Serializable

Serialized Fields

docids

int[] docids

exactResultSize

int exactResultSize

lock

java.util.concurrent.locks.Lock lock

occurrences

short[] occurrences

resultSize

int resultSize

scores

double[] scores

statusCode

int statusCode

Class org.terrier.matching.daat.FatCandidateResultSet extends CandidateResultSet implements Serializable

Serialized Fields

collStats

CollectionStatistics collStats

entryStats

EntryStatistics[] entryStats

keyFrequency

double[] keyFrequency

postings

WritablePosting[][] postings

queryTerms

java.lang.String[] queryTerms

tags

java.util.Set<java.lang.String>[] tags

Package org.terrier.matching.dsms

Class org.terrier.matching.dsms.BooleanScoreModifier extends java.lang.Object implements Serializable

serialVersionUID:

8827289509840106672L

Serialized Fields

terms

java.util.ArrayList<Query> terms

The terms to check. If this is null, then we check for the whole query. This property can only be set from the constructor.

Package org.terrier.matching.matchops

Class org.terrier.matching.matchops.ANDQueryOp extends MultiTermOp implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.matchops.DateRangeOp extends Operator implements Serializable

serialVersionUID:

1L

Serialized Fields

hiRange

java.util.Date hiRange

lowRange

java.util.Date lowRange

Class org.terrier.matching.matchops.FuzzyTermOp extends PrefixTermOp implements Serializable

serialVersionUID:

1L

Serialized Fields

lev

org.apache.commons.text.similarity.EditDistance<java.lang.Integer> lev

prefix_length

int prefix_length

Class org.terrier.matching.matchops.MultiTermOp extends Operator implements Serializable

serialVersionUID:

1L

Serialized Fields

allRequired

boolean allRequired

terms

Operator[] terms

Class org.terrier.matching.matchops.Operator extends java.lang.Object implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.matchops.ParseException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Serialized Fields

currentToken

Token currentToken

This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.

expectedTokenSequences

int[][] expectedTokenSequences

Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.

tokenImage

java.lang.String[] tokenImage

This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.

Class org.terrier.matching.matchops.PhraseOp extends ANDQueryOp implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.matchops.PrefixTermOp extends SynonymOp implements Serializable

serialVersionUID:

1L

Serialized Fields

maxMatch

java.lang.Integer maxMatch

predFunction

java.util.function.Predicate<java.lang.String> predFunction

Class org.terrier.matching.matchops.SingleTermOp extends Operator implements Serializable

serialVersionUID:

1L

Serialized Fields

field

java.lang.String field

queryTerm

java.lang.String queryTerm

Class org.terrier.matching.matchops.SynonymOp extends MultiTermOp implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.matchops.Token extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

beginColumn

int beginColumn

The column number of the first character of this Token.

beginLine

int beginLine

The line number of the first character of this Token.

endColumn

int endColumn

The column number of the last character of this Token.

endLine

int endLine

The line number of the last character of this Token.

image

java.lang.String image

The string image of the token.

kind

int kind

An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.

next

Token next

A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.

specialToken

Token specialToken

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.

Class org.terrier.matching.matchops.TokenMgrError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

int errorCode

Indicates the reason why the exception is thrown. It will have one of the above 4 values.

Class org.terrier.matching.matchops.UnorderedWindowOp extends ANDQueryOp implements Serializable

serialVersionUID:

1L

Serialized Fields

distance

int distance

Package org.terrier.matching.models

Class org.terrier.matching.models.BB2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.BM25 extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

b

double b

The parameter b.

k_1

double k_1

The constant k_1.

k_3

double k_3

The constant k_3.

Class org.terrier.matching.models.BM25F extends PerFieldNormWeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.CoordinateMatch extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.DFIC extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

name

java.lang.String name

Class org.terrier.matching.models.DFIZ extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

name

java.lang.String name

Class org.terrier.matching.models.DFR_BM25 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.DFRee extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.DFReeKLIM extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.DFRWeightingModel extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

afterEffect

AfterEffect afterEffect

The applied model for after effect (aka. first normalisation).

AFTEREFFECT_PREFIX

java.lang.String AFTEREFFECT_PREFIX

The prefix of the package of the first normalisation methods by after effect.

basicModel

BasicModel basicModel

The applied basic model for randomness.

BASICMODEL_PREFIX

java.lang.String BASICMODEL_PREFIX

The prefix of the package of the basic models for randomness.

ENABLE_AFTEREFFECT

boolean ENABLE_AFTEREFFECT

A boolean that indicates if the first normalisation by after effect is enabled.

ENABLE_NORMALISATION

boolean ENABLE_NORMALISATION

A boolean that indicates if the frequency normalisation is enabled.

normalisation

Normalisation normalisation

The applied frequency normalisation method.

NORMALISATION_PREFIX

java.lang.String NORMALISATION_PREFIX

The prefix of the package of the frequency normalisation methods.

parameter

double parameter

The parameter of the frequency normalisation component.

Class org.terrier.matching.models.DirichletLM extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.Dl extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.DLH extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

k

double k

Class org.terrier.matching.models.DLH13 extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

k

double k

Class org.terrier.matching.models.DPH extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.Hiemstra_LM extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.Idf extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

numberOfDocuments

double numberOfDocuments

The number of documents in the collection.

Class org.terrier.matching.models.IFB2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.In_expB2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.In_expC2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.InB2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.InL2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.Js_KLs extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.LemurTF_IDF extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

b

double b

The constant b.

k_1

double k_1

The constant k_1.

Class org.terrier.matching.models.LGD extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.MDL2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

fieldCount

int fieldCount

fieldNormalisations

Normalisation[] fieldNormalisations

fieldTermFrequencies

int[] fieldTermFrequencies

fieldWeights

double[] fieldWeights

gF

GammaFunction gF

initialScore

double initialScore

normClass

java.lang.Class<? extends Normalisation> normClass

p

double[] p

Class org.terrier.matching.models.ML2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

fieldCount

int fieldCount

fieldNormalisations

Normalisation[] fieldNormalisations

fieldTermFrequencies

int[] fieldTermFrequencies

fieldWeights

double[] fieldWeights

gF

GammaFunction gF

initialScore

double initialScore

normClass

java.lang.Class<? extends Normalisation> normClass

p

double[] p

Class org.terrier.matching.models.Null extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.PerFieldNormWeightingModel extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

basicModel

BasicModel basicModel

fieldCount

int fieldCount

fieldGlobalFrequencies

double[] fieldGlobalFrequencies

fieldNormalisations

Normalisation[] fieldNormalisations

fieldWeights

double[] fieldWeights

normClass

java.lang.Class<? extends Normalisation> normClass

params

java.lang.String[] params

Class org.terrier.matching.models.PL2 extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.PL2F extends PerFieldNormWeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.SingleFieldModel extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

activeFieldIds

int[] activeFieldIds

basicModel

WeightingModel basicModel

params

java.lang.String[] params

Class org.terrier.matching.models.StaticFeature extends StaticScoreModifierWeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.StaticScoreModifierWeightingModel extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

asFloat

boolean asFloat

FstaticMap

gnu.trove.TIntFloatHashMap FstaticMap

FstaticScores

float[] FstaticScores

map

boolean map

source

java.lang.String source

staticMap

gnu.trove.TIntDoubleHashMap staticMap

staticScores

double[] staticScores

Class org.terrier.matching.models.Tf extends WeightingModel implements Serializable

serialVersionUID:

1L

Class org.terrier.matching.models.TF_IDF extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

b

double b

The constant b.

k_1

double k_1

The constant k_1.

Class org.terrier.matching.models.WeightingModel extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

averageDocumentLength

double averageDocumentLength

The average length of documents in the collection.

c

double c

The parameter c. This defaults to 1.0, but should be set using in the constructor of each child weighting model to the sensible default for that weighting model.

cs

CollectionStatistics cs

documentFrequency

double documentFrequency

The document frequency of the term in the collection.

es

EntryStatistics es

i

Idf i

The class used for computing the idf values.

keyFrequency

double keyFrequency

The term frequency in the query.

numberOfDocuments

double numberOfDocuments

The number of documents in the collection.

numberOfPointers

double numberOfPointers

Deprecated.

The number of distinct entries in the inverted file. This figure can be calculated as the sum of all Nt over all terms. Deprecated in favour of numberOfPostings

numberOfPostings

double numberOfPostings

The number of distinct entries in the inverted file. This figure can be calculated as the sum of all Nt over all terms

numberOfTokens

double numberOfTokens

The number of tokens in the collections.

numberOfUniqueTerms

double numberOfUniqueTerms

Number of unique terms in the collection

rq

Request rq

termFrequency

double termFrequency

The term frequency in the collection.

Class org.terrier.matching.models.XSqrA_M extends WeightingModel implements Serializable

serialVersionUID:

1L

Package org.terrier.matching.models.aftereffect

Class org.terrier.matching.models.aftereffect.AfterEffect extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avl

double avl

The average document length in collection.

parameter

double parameter

The term frequency normalisation parameter used for method L5

Class org.terrier.matching.models.aftereffect.B extends AfterEffect implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the model.

Class org.terrier.matching.models.aftereffect.L extends AfterEffect implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the model.

Class org.terrier.matching.models.aftereffect.L5 extends AfterEffect implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the model.

Class org.terrier.matching.models.aftereffect.LL extends AfterEffect implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the model.

Package org.terrier.matching.models.basicmodel

Class org.terrier.matching.models.basicmodel.B extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class org.terrier.matching.models.basicmodel.BasicModel extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

i

Idf i

The class used for computing the idf values.

numberOfDocuments

double numberOfDocuments

The number of documents in the whole collection.

numberOfTokens

double numberOfTokens

The number of tokens in the whole collection

Class org.terrier.matching.models.basicmodel.BM extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

k_1

double k_1

The constant k_1.

k_3

double k_3

The constant k_3.

modelName

java.lang.String modelName

The name of the model.

Class org.terrier.matching.models.basicmodel.Br extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class org.terrier.matching.models.basicmodel.DFR_BM extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

k_1

double k_1

The constant k_1.

k_3

double k_3

The constant k_3.

modelName

java.lang.String modelName

The name of the model.

Class org.terrier.matching.models.basicmodel.IF extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class org.terrier.matching.models.basicmodel.In extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

numberOfDocuments

double numberOfDocuments

The number of documents in the whole collection.

Class org.terrier.matching.models.basicmodel.In_exp extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class org.terrier.matching.models.basicmodel.P extends BasicModel implements Serializable

serialVersionUID:

1L

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class org.terrier.matching.models.basicmodel.PL extends P implements Serializable

serialVersionUID:

1L

Package org.terrier.matching.models.dependence

Class org.terrier.matching.models.dependence.MRF extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultCf

double defaultCf

defaultDf

double defaultDf

ngramLength

int ngramLength

Class org.terrier.matching.models.dependence.pBiL extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

ngramLength

int ngramLength

norm2

boolean norm2

Class org.terrier.matching.models.dependence.pBiL2 extends pBiL implements Serializable

serialVersionUID:

1L

Package org.terrier.matching.models.normalisation

Class org.terrier.matching.models.normalisation.Normalisation extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

averageDocumentLength

double averageDocumentLength

The average document length in the collection.

idf

Idf idf

The class used for computing the logorithm values.

Nt

double Nt

The document frequency of the term.

numberOfDocuments

double numberOfDocuments

The number of documents in the whole collection.

numberOfTokens

double numberOfTokens

The number of tokens in the whole collection.

parameter

double parameter

The free parameter of the normalisation method.

termFrequency

double termFrequency

The frequency of the query term in the whole collection.

Class org.terrier.matching.models.normalisation.Normalisation0 extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.Normalisation1 extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.Normalisation2 extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.Normalisation2exp extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.Normalisation3 extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.NormalisationB extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.NormalisationF extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.NormalisationJ extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.NormalisationJN extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.NormalisationP extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class org.terrier.matching.models.normalisation.NormalisationStatic extends Normalisation implements Serializable

serialVersionUID:

1L

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Package org.terrier.matching.tsms

Class org.terrier.matching.tsms.RequiredTermModifier extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

required

boolean required

Indicates whether a query term is required, not required, or whether this has been left unspecified.

Class org.terrier.matching.tsms.TermInFieldModifier extends WeightingModel implements Serializable

serialVersionUID:

1L

Serialized Fields

field

java.lang.String field

The fields that a query term should appear in.

fieldIndex

int fieldIndex

requirement

boolean requirement

The requirement. By default it is true.

Package org.terrier.querying

Class org.terrier.querying.IndexRef extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

location

java.lang.String[] location

Class org.terrier.querying.Request extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextObjects

java.util.Map<java.lang.String,java.lang.Object> contextObjects

Context object Map that can hold object values.

Control

java.util.Map<java.lang.String,java.lang.String> Control

Controls are querying stage flags and variables. These are typically set by defaults in the configuration file, or by flags in the query itself (if querying.HTTPSearchEngine is used). They often depict which pre, matching, post and output modules will be used.

EmptyQuery

boolean EmptyQuery

does the query have any terms. Used by Manager.runMatching() to short circuit the matching process - if this is set, then a resultset with 0 documents is created automatically.

matchingTerms

MatchingQueryTerms matchingTerms

This is an aggregated form of the query terms, suitable for matching, which requires term frequencies for each term.

numOfDocsAfterFiltering

int numOfDocsAfterFiltering

The number of documents returned after performing post filtering

originalQuery

java.lang.String originalQuery

The query text, before applying any pre-processsing

q

Query q

This contains the parsed syntax tree of the query, as generated by the Antlr parser

QueryID

java.lang.String QueryID

QueryID - used by TREC querying and output format for supporting relevance assessments

resultSet

ResultSet resultSet

This is the resultset of the query. It is provided by the matching/weighting stage, and may be operated on (eg decorated) by PostProcesses and PostFilters

startedProcessingTime

long startedProcessingTime

The time point when the processing of this search request started.

Package org.terrier.querying.parser

Class org.terrier.querying.parser.DisjunctiveQuery extends MultiTermQuery implements Serializable

serialVersionUID:

1L

Serialized Fields

activeIndex

int activeIndex

weight

double weight

The weight of this "term".

Class org.terrier.querying.parser.ExplicitMultiTermQuery extends MultiTermQuery implements Serializable

serialVersionUID:

1L

Serialized Fields

weight

java.lang.Double weight

Class org.terrier.querying.parser.FieldQuery extends Query implements Serializable

serialVersionUID:

1L

Serialized Fields

field

java.lang.String field

The optional field.

Class org.terrier.querying.parser.MultiTermQuery extends Query implements Serializable

serialVersionUID:

1L

Serialized Fields

prefix

java.lang.String prefix

suffix

java.lang.String suffix

v

java.util.ArrayList<Query> v

A list for holding the sub-queries. A LinkedList is ideal as we have no need to access numbered sub-query elements of the query - only be able to iterate throught them.

weight

double weight

The weight of this "term".

Class org.terrier.querying.parser.ParseException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Serialized Fields

currentToken

Token currentToken

This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.

expectedTokenSequences

int[][] expectedTokenSequences

Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.

tokenImage

java.lang.String[] tokenImage

This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.

Class org.terrier.querying.parser.PhraseQuery extends MultiTermQuery implements Serializable

serialVersionUID:

1L

Serialized Fields

proximityDistance

int proximityDistance

Indicates the distance, in number of blocks, that the phrase terms can appear in a document. A value of zero corresponds to phrase searching and it is the default value, while any higher value enables proximity searching.

Class org.terrier.querying.parser.Query extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

child

Query child

An encapsulated query.

Class org.terrier.querying.parser.QueryParserException extends java.lang.RuntimeException implements Serializable

serialVersionUID:

1L

Class org.terrier.querying.parser.RequirementQuery extends Query implements Serializable

serialVersionUID:

1L

Serialized Fields

MustHave

boolean MustHave

The query requirement. The default value is true.

Class org.terrier.querying.parser.SegmentQuery extends MultiTermQuery implements Serializable

serialVersionUID:

1L

Class org.terrier.querying.parser.SingleTermQuery extends Query implements Serializable

serialVersionUID:

1L

Serialized Fields

required

int required

The optional required qualifier. It takes the values -1 that corresponds to '-', +1 that corresponds to '+' and 0 that corresponds to unspecified. The default value is 0

term

java.lang.String term

The query term string.

weight

double weight

The weight of a query term.

Class org.terrier.querying.parser.Token extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

beginColumn

int beginColumn

The column number of the first character of this Token.

beginLine

int beginLine

The line number of the first character of this Token.

endColumn

int endColumn

The column number of the last character of this Token.

endLine

int endLine

The line number of the last character of this Token.

image

java.lang.String image

The string image of the token.

kind

int kind

An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.

next

Token next

A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.

specialToken

Token specialToken

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.

Class org.terrier.querying.parser.TokenMgrError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

int errorCode

Indicates the reason why the exception is thrown. It will have one of the above 4 values.

Package org.terrier.realtime.memory

Class org.terrier.realtime.memory.MemoryCollectionStatistics extends CollectionStatistics implements Serializable

Class org.terrier.realtime.memory.MemoryCompressedMetaIndex extends MemoryMetaIndex implements Serializable

serialVersionUID:

-4026137439218916329L

Serialized Fields

currentDocId

int currentDocId

key2meta

gnu.trove.TObjectIntHashMap<java.lang.String> key2meta

keylengths

int[] keylengths

keylens

java.lang.String[] keylens

keys

java.lang.String[] keys

metadata

gnu.trove.TIntObjectHashMap<byte[]> metadata

Class org.terrier.realtime.memory.MemoryDocumentIndex extends java.lang.Object implements Serializable

serialVersionUID:

-7639008149037297229L

Serialized Fields

docLengths

gnu.trove.TIntArrayList docLengths

Class org.terrier.realtime.memory.MemoryDocumentIndexMap extends MemoryDocumentIndex implements Serializable

serialVersionUID:

1L

Serialized Fields

docids2lengths

gnu.trove.TIntIntHashMap docids2lengths

Class org.terrier.realtime.memory.MemoryInvertedIndex extends java.lang.Object implements Serializable

serialVersionUID:

-7814322137698041488L

Serialized Fields

doi

DocumentIndex doi

lex

Lexicon<java.lang.String> lex

postings

gnu.trove.TIntObjectHashMap<MemoryPostingList> postings

Class org.terrier.realtime.memory.MemoryLexicon extends MapLexicon<java.lang.String,org.apache.hadoop.io.Text> implements Serializable

serialVersionUID:

6642638617614776293L

Class org.terrier.realtime.memory.MemoryLexiconEntry extends LexiconEntry implements Serializable

Serialized Fields

df

int df

maxtf

int maxtf

termid

int termid

tf

int tf

Class org.terrier.realtime.memory.MemoryMetaIndex extends MetaIndexBuilder implements Serializable

serialVersionUID:

8260494137553522514L

Serialized Fields

isReverse

boolean[] isReverse

isSorted

boolean[] isSorted

key2meta

gnu.trove.TObjectIntHashMap<java.lang.String> key2meta

key2value2id

java.util.Map<java.lang.String,gnu.trove.TObjectIntHashMap<java.lang.String>> key2value2id

keylengths

int[] keylengths

keys

java.lang.String[] keys

metadata

java.util.List<java.lang.String[]> metadata

revkeys

java.lang.String[] revkeys

Class org.terrier.realtime.memory.MemoryMetaIndexMap extends MemoryMetaIndex implements Serializable

serialVersionUID:

8860561423432492113L

Serialized Fields

key2meta

gnu.trove.TObjectIntHashMap<java.lang.String> key2meta

keylengths

int[] keylengths

keylens

java.lang.String[] keylens

keys

java.lang.String[] keys

metadata

gnu.trove.TIntObjectHashMap<java.lang.String[]> metadata

Class org.terrier.realtime.memory.WTreeMap extends java.util.TreeMap<K,V> implements Serializable

Serialized Fields

ordering

java.util.List<K> ordering

Package org.terrier.realtime.memory.fields

Class org.terrier.realtime.memory.fields.MemoryDocumentIndexFields extends MemoryDocumentIndex implements Serializable

serialVersionUID:

-3154305694924339094L

Serialized Fields

fieldLengths

java.util.List<gnu.trove.TIntArrayList> fieldLengths

Class org.terrier.realtime.memory.fields.MemoryDocumentIndexFieldsMap extends MemoryDocumentIndexMap implements Serializable

serialVersionUID:

5719096024449880656L

Serialized Fields

bitpointers

gnu.trove.TIntObjectHashMap<BitIndexPointer> bitpointers

fieldLengths

gnu.trove.TIntObjectHashMap<gnu.trove.TIntArrayList> fieldLengths

Class org.terrier.realtime.memory.fields.MemoryFieldsInvertedIndex extends MemoryInvertedIndex implements Serializable

serialVersionUID:

-4471360517668596542L

Class org.terrier.realtime.memory.fields.MemoryFieldsLexiconEntry extends MemoryLexiconEntry implements Serializable

Serialized Fields

fields

int[] fields

Package org.terrier.realtime.multi

Class org.terrier.realtime.multi.MultiLexiconEntry extends LexiconEntry implements Serializable

Serialized Fields

children

LexiconEntry[] children

hashcode

int hashcode

maxtf

int maxtf

Class org.terrier.realtime.multi.MultiStats extends CollectionStatistics implements Serializable

Package org.terrier.statistics

Class org.terrier.statistics.GammaFunction extends java.lang.Object implements Serializable

serialVersionUID:

1L

Package org.terrier.structures

Class org.terrier.structures.BasicLexiconEntry extends LexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

maxtf

int maxtf

n_t

int n_t

the number of document that this entry occurs in

startBitOffset

byte startBitOffset

the start bit offset of the entry in the inverted index

startOffset

long startOffset

the start offset of the entry in the inverted index

termId

int termId

the termid of this entry

TF

int TF

the total number of occurrences of the term in the index

Class org.terrier.structures.BasicTermStatsLexiconEntry extends LexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

maxtf

int maxtf

n_t

int n_t

termId

int termId

TF

int TF

Class org.terrier.structures.CollectionStatistics extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

averageDocumentLength

double averageDocumentLength

Average length of a document in the collection.

avgFieldLengths

double[] avgFieldLengths

Average length of each field

fieldNames

java.lang.String[] fieldNames

Field names

fieldTokens

long[] fieldTokens

Number of tokens in each field

hasPositions

boolean hasPositions

Does the index have positions

numberOfDocuments

int numberOfDocuments

Total number of documents in the collection.

numberOfFields

int numberOfFields

Number of fields used to index

numberOfPointers

long numberOfPointers

Total number of pointers in the inverted file. This corresponds to the sum of the document frequencies for the terms in the lexicon.

numberOfTokens

long numberOfTokens

Total number of tokens in the collection.

numberOfUniqueTerms

int numberOfUniqueTerms

Total number of unique terms in the collection. This corresponds to the number of entries in the lexicon.

Class org.terrier.structures.FieldLexiconEntry extends BasicLexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

fieldFrequencies

int[] fieldFrequencies

Class org.terrier.structures.Index.DirectIndexRef extends IndexRef implements Serializable

serialVersionUID:

1L

Serialized Fields

underlyingIndex

Index underlyingIndex

Class org.terrier.structures.LexiconEntry extends java.lang.Object implements Serializable

serialVersionUID:

1L

Class org.terrier.structures.PropertiesIndex.UpdatingCollectionStatistics extends CollectionStatistics implements Serializable

serialVersionUID:

1L

Class org.terrier.structures.SimpleNgramEntryStatistics extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

f

int f

maxtf

int maxtf

nt

int nt

ws

int ws

Package org.terrier.structures.collections

Class org.terrier.structures.collections.FSOrderedMapFile.MapFileInMemory extends java.util.TreeMap<IK extends org.apache.hadoop.io.Writable,IV extends org.apache.hadoop.io.Writable> implements Serializable

serialVersionUID:

1L

Class org.terrier.structures.collections.LRUMap extends java.util.LinkedHashMap<K,V> implements Serializable

serialVersionUID:

1L

Serialized Fields

maxSize

int maxSize

Package org.terrier.structures.indexing

Class org.terrier.structures.indexing.BlockDocumentPostingList extends DocumentPostingList implements Serializable

serialVersionUID:

1L

Serialized Fields

blockCount

int blockCount

number of blocks in this document. usually equal to document length, but perhaps less

term_blocks

gnu.trove.THashMap<java.lang.String,gnu.trove.TIntHashSet> term_blocks

mapping term to blockids in this document

Class org.terrier.structures.indexing.BlockFieldDocumentPostingList extends FieldDocumentPostingList implements Serializable

serialVersionUID:

1L

Serialized Fields

blockCount

int blockCount

number of blocks in this document. usually equal to document length, but perhaps less

term_blocks

gnu.trove.THashMap<java.lang.String,gnu.trove.TIntHashSet> term_blocks

mapping term to blockids in this document

Class org.terrier.structures.indexing.DocumentPostingList extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

documentLength

int documentLength

length of the document so far. Sum of the term frequencies inserted so far.

occurrences

gnu.trove.TObjectIntHashMap<java.lang.String> occurrences

mapping term to tf mapping

Class org.terrier.structures.indexing.FieldDocumentPostingList extends DocumentPostingList implements Serializable

serialVersionUID:

1L

Serialized Fields

field_occurrences

gnu.trove.TObjectIntHashMap<java.lang.String>[] field_occurrences

occurrences of terms in fields

fieldCount

int fieldCount

number of fields

fieldLengths

int[] fieldLengths

length of each field

Package org.terrier.structures.indexing.singlepass

Class org.terrier.structures.indexing.singlepass.RunsMerger.PostingComparator extends java.lang.Object implements Serializable

serialVersionUID:

8674662139960016073L

Package org.terrier.structures.postings

Class org.terrier.structures.postings.BasicPostingImpl extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

dl

int dl

id

int id

id of the posting

tf

int tf

frequency of this posting

Class org.terrier.structures.postings.BlockFieldPostingImpl extends BlockPostingImpl implements Serializable

Serialized Fields

fieldFrequencies

int[] fieldFrequencies

fieldLengths

int[] fieldLengths

Class org.terrier.structures.postings.BlockPostingImpl extends BasicPostingImpl implements Serializable

serialVersionUID:

1L

Serialized Fields

positions

int[] positions

positions of occurrence in document

Class org.terrier.structures.postings.FieldPostingImpl extends BasicPostingImpl implements Serializable

serialVersionUID:

1L

Serialized Fields

fieldFrequencies

int[] fieldFrequencies

fieldLengths

int[] fieldLengths

Class org.terrier.structures.postings.PostingIdComparator extends java.lang.Object implements Serializable

serialVersionUID:

1L

Package org.terrier.structures.postings.bit

Class org.terrier.structures.postings.bit.BasicIterablePosting extends BasicPostingImpl implements Serializable

Serialized Fields

bitFileReader

BitIn bitFileReader

doi

DocumentIndex doi

numEntries

int numEntries

Class org.terrier.structures.postings.bit.BasicIterablePostingDocidOnly extends BasicIterablePosting implements Serializable

Class org.terrier.structures.postings.bit.BlockFieldIterablePosting extends BasicIterablePosting implements Serializable

Serialized Fields

doiIsFieldDocumentIndex

boolean doiIsFieldDocumentIndex

fdoi

FieldDocumentIndex fdoi

fieldCount

int fieldCount

fieldFrequencies

int[] fieldFrequencies

positions

int[] positions

Class org.terrier.structures.postings.bit.BlockIterablePosting extends BasicIterablePosting implements Serializable

serialVersionUID:

1L

Serialized Fields

positions

int[] positions

Class org.terrier.structures.postings.bit.FieldIterablePosting extends BasicIterablePosting implements Serializable

serialVersionUID:

1L

Serialized Fields

doiIsFieldDocumentIndex

boolean doiIsFieldDocumentIndex

can we lookup fields lengths in a cheap manner?

fdoi

FieldDocumentIndex fdoi

pre-cast DocumentIndex to FieldDocumentIndex

fieldCount

int fieldCount

number of fields

fieldFrequencies

int[] fieldFrequencies

frequency in each field

Package org.terrier.structures.restructure

Class org.terrier.structures.restructure.Tr3BlockFieldLexiconEntry extends Tr4BasicLexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

blockCount

int blockCount

Deprecated.

fieldFrequencies

int[] fieldFrequencies

Deprecated.

Class org.terrier.structures.restructure.Tr3BlockLexiconEntry extends Tr4BasicLexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

blockCount

int blockCount

Deprecated.

Class org.terrier.structures.restructure.Tr4BasicLexiconEntry extends LexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

maxtf

int maxtf

n_t

int n_t

the number of document that this entry occurs in

startBitOffset

byte startBitOffset

the start bit offset of the entry in the inverted index

startOffset

long startOffset

the start offset of the entry in the inverted index

termId

int termId

the termid of this entry

TF

int TF

the total number of occurrences of the term in the index

Class org.terrier.structures.restructure.Tr4BasicTermStatsLexiconEntry extends LexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

maxtf

int maxtf

n_t

int n_t

termId

int termId

TF

int TF

Class org.terrier.structures.restructure.Tr4FieldLexiconEntry extends Tr4BasicLexiconEntry implements Serializable

serialVersionUID:

1L

Serialized Fields

fieldFrequencies

int[] fieldFrequencies

Package org.terrier.utility

Class org.terrier.utility.ParseException extends java.lang.Exception implements Serializable

serialVersionUID:

1L

Serialized Fields

currentToken

Token currentToken

This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token followng this token will (therefore) be the first error token.

expectedTokenSequences

int[][] expectedTokenSequences

Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.

tokenImage

java.lang.String[] tokenImage

This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.

Class org.terrier.utility.Token extends java.lang.Object implements Serializable

serialVersionUID:

1L

Serialized Fields

beginColumn

int beginColumn

The column number of the first character of this Token.

beginLine

int beginLine

The line number of the first character of this Token.

endColumn

int endColumn

The column number of the last character of this Token.

endLine

int endLine

The line number of the last character of this Token.

image

java.lang.String image

The string image of the token.

kind

int kind

An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.

next

Token next

A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.

specialToken

Token specialToken

This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.

Class org.terrier.utility.TokenMgrError extends java.lang.Error implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

int errorCode

Indicates the reason why the exception is thrown. It will have one of the above 4 values.

Package org.terrier.utility.io

Class org.terrier.utility.io.WrappedIOException extends java.io.IOException implements Serializable

serialVersionUID:

1L