org.terrier.matching

Class MatchingQueryTerms

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<MatchingQueryTerms.MatchingTerm>

org.terrier.matching.MatchingQueryTerms

All Implemented Interfaces:

Serializable, Cloneable, Iterable<MatchingQueryTerms.MatchingTerm>, Collection<MatchingQueryTerms.MatchingTerm>, List<MatchingQueryTerms.MatchingTerm>, RandomAccess

public class MatchingQueryTerms
extends ArrayList<MatchingQueryTerms.MatchingTerm>
implements Serializable, Cloneable

Models a query used for matching documents. It is created by creating an instance of this class, and then passing it as an argument to the method obtainQueryTerms of a Query. It contains the query terms, their weights, optionally the corresponding term identifiers and the associated term score modifiers. It also stores the document score modifiers for the query.

Author:

Vassilis Plachouras, Craig Macdonald.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatchingQueryTerms.MatchingTerm
static class	MatchingQueryTerms.QueryTermProperties The weight and the modifiers associated with a query term.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	defaultTags
protected WeightingModel	defaultWeightingModel default weighting model for all terms
protected ArrayList<DocumentScoreModifier>	docScoreModifiers The document score modifiers associated with the query terms.
protected Query	query The original query as it came from the parser, in case any TSMs or DSMs wish to refer to it
protected String	queryId The query ID, if provided
protected Request	rq

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
MatchingQueryTerms() Generate a MatchingQueryTerms object.
MatchingQueryTerms(Collection<MatchingQueryTerms.MatchingTerm> coll)
MatchingQueryTerms(String qid) Generate a MatchingQueryTerms object, with the specified query id.
MatchingQueryTerms(String qid, Request _rq) Generate a MatchingQueryTerms object, with the specified query id, and request

Method Summary

Modifier and Type	Method and Description
boolean	add(MatchingQueryTerms.MatchingTerm e)
void	addDocumentScoreModifier(DocumentScoreModifier dsm) Adds a document score modifier for the query.
void	addTermPropertyWeight(String term, double d)
MatchingQueryTerms	clone() Performs a deep clone of this object, and all objects it contains.
protected MatchingQueryTerms.QueryTermProperties	combine(MatchingQueryTerms.QueryTermProperties existingProps, MatchingQueryTerms.QueryTermProperties newProps)
MatchingQueryTerms.QueryTermProperties	get(Operator term)
Map.Entry<Operator,MatchingQueryTerms.QueryTermProperties>	get(String singleTerm)
DocumentScoreModifier[]	getDocumentScoreModifiers() Returns the document score modifiers used for the query.
Operator[]	getMatchingTerms() Returns the query terms, as they were added to this object.
List<MatchingQueryTerms.MatchingTerm>	getMatchingTerms(String tag)
Query	getQuery() Returns guess what?
String	getQueryId() Returns the query id specified when constructing this object.
Request	getRequest() Returns the request.
EntryStatistics	getStatistics(Operator term) Returns the assocciated code of the given query term.
EntryStatistics	getStatistics(String term)
String[]	getTerms() Returns the query terms, as they were added to this object.
double	getTermWeight(Operator term) Returns the associated weight of the given query term.
double	getTermWeight(String term)
double[]	getTermWeights() Returns the associated weights of the given query terms.
int	length() Deprecated.
void	normaliseTermWeights() This method normalises the term weights by dividing each term weight by the maximum of the terms.
void	removeTerm(Operator term) Remove a term from the list of terms to be matched
void	resetTermProperties() This method resets query term statistics to allow for a single instance of MatchingQueryTerms to be reused for matching against different indices.
void	setDefaultTermWeightingModel(WeightingModel weightingModel) Set the default weighting model to be used for terms that do NOT have an explicit WeightingModel set.
void	setQuery(Query q) Allows the manager to set the query that was used to query the system.
void	setQueryId(String newId) Sets the query id
void	setTermProperty(Operator term, double weight) Adds a term to the query with a given weight.
void	setTermProperty(Operator term, double weight, WeightingModel tsm) Sets the weight and a term score modifier for the given query term.
void	setTermProperty(Operator term, EntryStatistics e)
void	setTermProperty(Operator term, WeightingModel tsm) Sets a term score modifier for the given query term.
void	setTermProperty(String term, double weight)
void	setTermProperty(String term, EntryStatistics e) Sets a term's statistics for the given query term.
String	toString()

Methods inherited from class java.util.ArrayList

add, addAll, addAll, clear, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

queryId

protected String queryId

The query ID, if provided

rq

protected Request rq

defaultTags

protected Set<String> defaultTags

defaultWeightingModel

protected WeightingModel defaultWeightingModel

default weighting model for all terms

docScoreModifiers

protected ArrayList<DocumentScoreModifier> docScoreModifiers

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

query

protected Query query

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

Constructor Detail

MatchingQueryTerms

public MatchingQueryTerms(Collection<MatchingQueryTerms.MatchingTerm> coll)

MatchingQueryTerms

public MatchingQueryTerms()

Generate a MatchingQueryTerms object. Query id will be null.

MatchingQueryTerms

public MatchingQueryTerms(String qid)

Generate a MatchingQueryTerms object, with the specified query id.

Parameters:

qid - A string representation of the query id

MatchingQueryTerms

public MatchingQueryTerms(String qid,
                          Request _rq)

Generate a MatchingQueryTerms object, with the specified query id, and request

Parameters:

qid - A string representation of the query id

_rq - A request for matching

Method Detail

getRequest

public Request getRequest()

Returns the request.

Returns:

Request

addDocumentScoreModifier

public void addDocumentScoreModifier(DocumentScoreModifier dsm)

Adds a document score modifier for the query.

Parameters:

dsm - DocumentScoreModifier a document score modifier for the query.

getDocumentScoreModifiers

public DocumentScoreModifier[] getDocumentScoreModifiers()

Returns the document score modifiers used for the query.

Returns:

DocumentScoreModifiers[] an array of the registered document score modifiers for the query. If there are no document score modifiers, then it returns null.

setQuery

public void setQuery(Query q)

Allows the manager to set the query that was used to query the system.

Parameters:

q - The Query, duh

getQuery

public Query getQuery()

Returns guess what?

Returns:

the query

getQueryId

public String getQueryId()

Returns the query id specified when constructing this object.

Returns:

String query id, or null if none was specified.

setQueryId

public void setQueryId(String newId)

Sets the query id

normaliseTermWeights

public void normaliseTermWeights()

This method normalises the term weights by dividing each term weight by the maximum of the terms.

resetTermProperties

public void resetTermProperties()

This method resets query term statistics to allow for a single instance of MatchingQueryTerms to be reused for matching against different indices.

setTermProperty

public void setTermProperty(Operator term,
                            EntryStatistics e)

setTermProperty

public void setTermProperty(String term,
                            EntryStatistics e)

Sets a term's statistics for the given query term.

Parameters:

term - String the term for which to override the statitics

e - EntryStatistics the term score modifier to apply for the given term.

setTermProperty

public void setTermProperty(Operator term,
                            WeightingModel tsm)

Sets a term score modifier for the given query term.

Parameters:

term - String the term for which to add a term score modifier.

tsm - TermScoreModifier the term score modifier to apply for the given term.

setTermProperty

public void setTermProperty(Operator term,
                            double weight,
                            WeightingModel tsm)

Sets the weight and a term score modifier for the given query term.

Parameters:

term - String the term for which we set the properties.

weight - int the weight of the query term.

tsm - TermScoreModifier the term score modifier applied for the query term.

combine

protected MatchingQueryTerms.QueryTermProperties combine(MatchingQueryTerms.QueryTermProperties existingProps,
                                                         MatchingQueryTerms.QueryTermProperties newProps)

add

public boolean add(MatchingQueryTerms.MatchingTerm e)

Specified by:

add in interface Collection<MatchingQueryTerms.MatchingTerm>

Specified by:

add in interface List<MatchingQueryTerms.MatchingTerm>

Overrides:

add in class ArrayList<MatchingQueryTerms.MatchingTerm>

getTermWeight

public double getTermWeight(Operator term)

Returns the associated weight of the given query term.

Parameters:

term - String the query term for which the weight is returned.

Returns:

double the weight of the given query term. If the term is not part of the query, then it returns 0.

getTermWeight

public double getTermWeight(String term)

getTermWeights

public double[] getTermWeights()

Returns the associated weights of the given query terms.

Returns:

double The weights of the given terms in a double array.

getStatistics

public EntryStatistics getStatistics(Operator term)

Returns the assocciated code of the given query term.

Parameters:

term - String the query term for which the weight is returned.

Returns:

EntryStatistics the statistics of the term, or null if the term does not appear in the query.

getStatistics

public EntryStatistics getStatistics(String term)

get

public MatchingQueryTerms.QueryTermProperties get(Operator term)

get

public Map.Entry<Operator,MatchingQueryTerms.QueryTermProperties> get(String singleTerm)

setTermProperty

public void setTermProperty(String term,
                            double weight)

getMatchingTerms

public Operator[] getMatchingTerms()

Returns the query terms, as they were added to this object.

Returns:

Query terms in order that they were added to the query. Empty array if object has no query terms added.

getTerms

public String[] getTerms()

Returns the query terms, as they were added to this object.

Returns:

Query terms in order that they were added to the query. Empty array if object has no query terms added.

getMatchingTerms

public List<MatchingQueryTerms.MatchingTerm> getMatchingTerms(String tag)

setTermProperty

public void setTermProperty(Operator term,
                            double weight)

Adds a term to the query with a given weight. If the term already exists, the existing weight is overwritten.

Parameters:

term - String the term to add.

weight - double the weight of the added term.

length

@Deprecated
public int length()

Deprecated.

Returns the number of unique terms in the query.

Returns:

int the number of unique terms in the query.

clone

public MatchingQueryTerms clone()

Performs a deep clone of this object, and all objects it contains. This allows a MQT to be copied, and changed without affecting the original object.

Overrides:

clone in class ArrayList<MatchingQueryTerms.MatchingTerm>

removeTerm

public void removeTerm(Operator term)

Remove a term from the list of terms to be matched

Since:

3.6

setDefaultTermWeightingModel

public void setDefaultTermWeightingModel(WeightingModel weightingModel)

Set the default weighting model to be used for terms that do NOT have an explicit WeightingModel set.

addTermPropertyWeight

public void addTermPropertyWeight(String term,
                                  double d)

toString

public String toString()

Overrides:

toString in class AbstractCollection<MatchingQueryTerms.MatchingTerm>