Serialized Form

Package uk.ac.gla.terrier.applications.desktop

Class uk.ac.gla.terrier.applications.desktop.AboutTerrier extends javax.swing.JDialog implements Serializable

Serialized Fields

imagePath

java.lang.String imagePath

jContentPane

javax.swing.JPanel jContentPane

jLabel

javax.swing.JLabel jLabel

jPanel

javax.swing.JPanel jPanel

jButton

javax.swing.JButton jButton

jTextPane

javax.swing.JTextPane jTextPane

jScrollPane

javax.swing.JScrollPane jScrollPane

Class uk.ac.gla.terrier.applications.desktop.DesktopTerrier extends javax.swing.JFrame implements Serializable

Serialized Fields

piErr

java.io.PipedInputStream piErr

poErr

java.io.PipedOutputStream poErr

jTextArea

javax.swing.JTextArea jTextArea

filetypeColors

uk.ac.gla.terrier.applications.desktop.FiletypeColors filetypeColors

queryRunning

boolean queryRunning

me

DesktopTerrier me

indexFolders

IndexFolders indexFolders

aboutTerrier

AboutTerrier aboutTerrier

helpDialog

HelpDialog helpDialog

managerName

java.lang.String managerName

folderList

java.util.List<E> folderList

queryingManager

Manager queryingManager

diskIndex

Index diskIndex

fileList

java.util.List<E> fileList

jContentPane

javax.swing.JPanel jContentPane

jJMenuBar

javax.swing.JMenuBar jJMenuBar

jMenuFile

javax.swing.JMenu jMenuFile

jMenu

javax.swing.JMenu jMenu

jMenuItem

javax.swing.JMenuItem jMenuItem

jMenuItem1

javax.swing.JMenuItem jMenuItem1

jMenuItem2

javax.swing.JMenuItem jMenuItem2

jTabbedPane

javax.swing.JTabbedPane jTabbedPane

searchPanel

javax.swing.JPanel searchPanel

jPanel1

javax.swing.JPanel jPanel1

jTextField

javax.swing.JTextField jTextField

jButton

javax.swing.JButton jButton

jPanel2

javax.swing.JPanel jPanel2

jTable

javax.swing.JTable jTable

jScrollPane

javax.swing.JScrollPane jScrollPane

jButton1

javax.swing.JButton jButton1

jButton2

javax.swing.JButton jButton2

desktop_debug

boolean desktop_debug

jScrollPane1

javax.swing.JScrollPane jScrollPane1

jSplitPane

javax.swing.JSplitPane jSplitPane

jPanel3

javax.swing.JPanel jPanel3

jPanel

javax.swing.JPanel jPanel

jLabel

javax.swing.JLabel jLabel

jLabel1

javax.swing.JLabel jLabel1

jLabel2

javax.swing.JLabel jLabel2

jLabel3

javax.swing.JLabel jLabel3

jPanel4

javax.swing.JPanel jPanel4

reada

uk.ac.gla.terrier.applications.desktop.DesktopTerrier.ReaderThread reada

Class uk.ac.gla.terrier.applications.desktop.HelpDialog extends javax.swing.JDialog implements Serializable

Serialized Fields

jContentPane

javax.swing.JPanel jContentPane

jPanel

javax.swing.JPanel jPanel

jButton

javax.swing.JButton jButton

jScrollPane

javax.swing.JScrollPane jScrollPane

jTextPane

javax.swing.JTextPane jTextPane

Class uk.ac.gla.terrier.applications.desktop.IndexFolders extends javax.swing.JDialog implements Serializable

Serialized Fields

folders

java.util.List<E> folders

workingFolders

java.util.Vector<E> workingFolders

jContentPane

javax.swing.JPanel jContentPane

jPanel

javax.swing.JPanel jPanel

jPanel1

javax.swing.JPanel jPanel1

jButton

javax.swing.JButton jButton

jButton1

javax.swing.JButton jButton1

jButton2

javax.swing.JButton jButton2

jScrollPane

javax.swing.JScrollPane jScrollPane

jList1

javax.swing.JList jList1

jButton3

javax.swing.JButton jButton3

jPanel2

javax.swing.JPanel jPanel2

jLabel

javax.swing.JLabel jLabel

jPanel3

javax.swing.JPanel jPanel3

Package uk.ac.gla.terrier.applications.desktop.filehandling

Class uk.ac.gla.terrier.applications.desktop.filehandling.ApplicationSelector extends javax.swing.JDialog implements Serializable

Serialized Fields

jContentPane

javax.swing.JPanel jContentPane

jButton

javax.swing.JButton jButton

jPanel

javax.swing.JPanel jPanel

jPanel1

javax.swing.JPanel jPanel1

jPanel2

javax.swing.JPanel jPanel2

jLabel

javax.swing.JLabel jLabel

jButton1

javax.swing.JButton jButton1

jLabel2

javax.swing.JLabel jLabel2

jTextField

javax.swing.JTextField jTextField

jButton2

javax.swing.JButton jButton2

applicationPath

java.lang.String applicationPath

Package uk.ac.gla.terrier.matching

Class uk.ac.gla.terrier.matching.CollectionResultSet extends java.lang.Object implements Serializable

Serialized Fields

docids

int[] docids

The array that stores the document ids.

scores

double[] scores

An array holding the scores of documents in the collection.

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.

arraysInitialised

boolean arraysInitialised

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

resultSize

int resultSize

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

exactResultSize

int exactResultSize

The number of retrieved documents. This may be higher that resultSize, 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

statusCode

int statusCode

A status code for the result set.

Class uk.ac.gla.terrier.matching.MatchingQueryTerms extends java.lang.Object implements Serializable

Serialized Fields

queryId

java.lang.String queryId

The query ID, if provided

termProperties

java.util.HashMap<K,V> termProperties

A mapping from the string of a query term to its properties.

docScoreModifiers

java.util.ArrayList<E> docScoreModifiers

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

query

Query query

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

Class uk.ac.gla.terrier.matching.MatchingQueryTerms.QueryTermProperties extends java.lang.Object implements Serializable

Serialized Fields

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).

termCode

int termCode

The term code (identifier) of the query term.

modifiers

java.util.ArrayList<E> modifiers

The term score modifiers associated with a particular query term.

Class uk.ac.gla.terrier.matching.QueryResultSet extends CollectionResultSet implements Serializable

Serialized Fields

metaMap

gnu.trove.TObjectIntHashMap<K> 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.

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.

Package uk.ac.gla.terrier.matching.dsms

Class uk.ac.gla.terrier.matching.dsms.BooleanScoreModifier extends java.lang.Object implements Serializable

Serialized Fields

terms

java.util.ArrayList<E> 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 uk.ac.gla.terrier.matching.models

Class uk.ac.gla.terrier.matching.models.BB2 extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.BM25 extends WeightingModel implements Serializable

Serialized Fields

k_1

double k_1

The constant k_1.

k_3

double k_3

The constant k_3.

b

double b

The parameter b.

Class uk.ac.gla.terrier.matching.models.DFR_BM25 extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.DFRee extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.DFRWeightingModel extends WeightingModel implements Serializable

Serialized Fields

basicModel

BasicModel basicModel

The applied basic model for randomness.

afterEffect

AfterEffect afterEffect

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

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.

BASICMODEL_PREFIX

java.lang.String BASICMODEL_PREFIX

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

AFTEREFFECT_PREFIX

java.lang.String AFTEREFFECT_PREFIX

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

parameter

double parameter

The parameter of the frequency normalisation component.

ENABLE_NORMALISATION

boolean ENABLE_NORMALISATION

A boolean that indicates if the frequency normalisation is enabled.

ENABLE_AFTEREFFECT

boolean ENABLE_AFTEREFFECT

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

Class uk.ac.gla.terrier.matching.models.DLH extends WeightingModel implements Serializable

Serialized Fields

k

double k

Class uk.ac.gla.terrier.matching.models.DLH13 extends WeightingModel implements Serializable

Serialized Fields

k

double k

Class uk.ac.gla.terrier.matching.models.Hiemstra_LM extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.Idf extends java.lang.Object implements Serializable

Serialized Fields

numberOfDocuments

double numberOfDocuments

The number of documents in the collection.

Class uk.ac.gla.terrier.matching.models.IFB2 extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.In_expB2 extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.In_expC2 extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.InL2 extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.LemurTF_IDF extends WeightingModel implements Serializable

Serialized Fields

k_1

double k_1

The constant k_1.

b

double b

The constant b.

Class uk.ac.gla.terrier.matching.models.PL2 extends WeightingModel implements Serializable

Class uk.ac.gla.terrier.matching.models.TF_IDF extends WeightingModel implements Serializable

Serialized Fields

k_1

double k_1

The constant k_1.

b

double b

The constant b.

Class uk.ac.gla.terrier.matching.models.WeightingModel extends java.lang.Object implements Serializable

Serialized Fields

i

Idf i

The class used for computing the idf values.

averageDocumentLength

double averageDocumentLength

The average length of documents in the collection.

keyFrequency

double keyFrequency

The term frequency in the query.

documentFrequency

double documentFrequency

The document frequency of the term in the collection.

termFrequency

double termFrequency

The term frequency in the collection.

numberOfDocuments

double numberOfDocuments

The number of documents in the collection.

numberOfTokens

double numberOfTokens

The number of tokens in the collections.

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.

numberOfUniqueTerms

double numberOfUniqueTerms

Number of unique terms in the collection

numberOfPointers

double numberOfPointers

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

Package uk.ac.gla.terrier.matching.models.aftereffect

Class uk.ac.gla.terrier.matching.models.aftereffect.AfterEffect extends java.lang.Object implements Serializable

Serialized Fields

avl

double avl

The average document length in collection.

parameter

double parameter

The term frequency normalisation parameter used for method L5

Class uk.ac.gla.terrier.matching.models.aftereffect.B extends AfterEffect implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the model.

Class uk.ac.gla.terrier.matching.models.aftereffect.L extends AfterEffect implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the model.

Class uk.ac.gla.terrier.matching.models.aftereffect.LL extends AfterEffect implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the model.

Package uk.ac.gla.terrier.matching.models.basicmodel

Class uk.ac.gla.terrier.matching.models.basicmodel.B extends BasicModel implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class uk.ac.gla.terrier.matching.models.basicmodel.BasicModel extends java.lang.Object implements Serializable

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 uk.ac.gla.terrier.matching.models.basicmodel.BM extends BasicModel implements Serializable

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 uk.ac.gla.terrier.matching.models.basicmodel.Br extends BasicModel implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class uk.ac.gla.terrier.matching.models.basicmodel.IF extends BasicModel implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class uk.ac.gla.terrier.matching.models.basicmodel.In extends BasicModel implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

numberOfDocuments

double numberOfDocuments

The number of documents in the whole collection.

Class uk.ac.gla.terrier.matching.models.basicmodel.In_exp extends BasicModel implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Class uk.ac.gla.terrier.matching.models.basicmodel.P extends BasicModel implements Serializable

Serialized Fields

modelName

java.lang.String modelName

The name of the model.

Package uk.ac.gla.terrier.matching.models.normalisation

Class uk.ac.gla.terrier.matching.models.normalisation.Normalisation extends java.lang.Object implements Serializable

Serialized Fields

isFieldRetrieval

boolean isFieldRetrieval

A boolean variable that indicates if the system is running field retrieval.

averageDocumentLength

double averageDocumentLength

The average document length in the collection.

idf

Idf idf

The class used for computing the logorithm values.

termFrequency

double termFrequency

The frequency of the query term in the whole collection.

parameter

double parameter

The free parameter of the normalisation method.

fieldWeight

double fieldWeight

The weight of the field. This takes effect only when fieldRetrieval is enabled. It is equal 1 by default. To change the setting, call method setFieldWeight.

numberOfTokens

double numberOfTokens

The number of tokens in the whole collection.

Nt

double Nt

The document frequency of the term.

numberOfDocuments

double numberOfDocuments

The number of documents in the whole collection.

Class uk.ac.gla.terrier.matching.models.normalisation.Normalisation0 extends Normalisation implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class uk.ac.gla.terrier.matching.models.normalisation.Normalisation2 extends Normalisation implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class uk.ac.gla.terrier.matching.models.normalisation.Normalisation2exp extends Normalisation implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class uk.ac.gla.terrier.matching.models.normalisation.Normalisation3 extends Normalisation implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class uk.ac.gla.terrier.matching.models.normalisation.NormalisationB extends Normalisation implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Class uk.ac.gla.terrier.matching.models.normalisation.NormalisationStatic extends Normalisation implements Serializable

Serialized Fields

methodName

java.lang.String methodName

The name of the normalisation method .

Package uk.ac.gla.terrier.matching.tsms

Class uk.ac.gla.terrier.matching.tsms.RequiredTermModifier extends java.lang.Object implements Serializable

Serialized Fields

required

boolean required

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

Package uk.ac.gla.terrier.querying

Class uk.ac.gla.terrier.querying.Request extends java.lang.Object implements Serializable

Serialized Fields

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.

QueryID

java.lang.String QueryID

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

Control

java.util.Hashtable<K,V> 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.

q

Query q

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

originalQuery

java.lang.String originalQuery

The query text, before applying any pre-processsing

numOfDocsAfterFiltering

int numOfDocsAfterFiltering

The number of documents returned after performing post filtering

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

matchingTerms

MatchingQueryTerms matchingTerms

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

startedProcessingTime

long startedProcessingTime

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

Package uk.ac.gla.terrier.querying.parser

Class uk.ac.gla.terrier.querying.parser.FieldQuery extends Query implements Serializable

Serialized Fields

field

java.lang.String field

The optional field.

Class uk.ac.gla.terrier.querying.parser.MultiTermQuery extends Query implements Serializable

Serialized Fields

v

java.util.LinkedList<E> 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.

Class uk.ac.gla.terrier.querying.parser.PhraseQuery extends MultiTermQuery implements Serializable

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 uk.ac.gla.terrier.querying.parser.Query extends java.lang.Object implements Serializable

Serialized Fields

child

Query child

An encapsulated query.

Class uk.ac.gla.terrier.querying.parser.QueryParserException extends java.lang.Exception implements Serializable

serialVersionUID: 1L

Class uk.ac.gla.terrier.querying.parser.RequirementQuery extends Query implements Serializable

Serialized Fields

MustHave

boolean MustHave

The query requirement. The default value is true.

Class uk.ac.gla.terrier.querying.parser.SingleTermQuery extends Query implements Serializable

Serialized Fields

term

java.lang.String term

The query term string.

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

weight

double weight

The weight of a query term.

Package uk.ac.gla.terrier.structures.indexing.singlepass

Class uk.ac.gla.terrier.structures.indexing.singlepass.RunsMerger.PostingComparator extends java.lang.Object implements Serializable

serialVersionUID: 8674662139960016073L

Package uk.ac.gla.terrier.utility.io

Class uk.ac.gla.terrier.utility.io.WrappedIOException extends java.io.IOException implements Serializable

serialVersionUID: 1L