Package org.terrier.matching

Interface FatResultSet

All Superinterfaces:

ResultSet, java.io.Serializable, org.apache.hadoop.io.Writable

All Known Implementing Classes:

FatCandidateResultSet, FatQueryResultSet

public interface FatResultSet
extends ResultSet, org.apache.hadoop.io.Writable

A result set that encapsulates the postings for terms within the query

Since:

4.0

Author:

Craig Macdonald

Method Summary

Modifier and Type	Method	Description
CollectionStatistics	getCollectionStatistics()	Get the collection statistics that should be applied when (re)scoring any documents in this query
EntryStatistics[]	getEntryStatistics()	Return the EntryStatistics of each of the query terms in the query
double[]	getKeyFrequencies()	Return the frequencies of each of the query terms in the query
WritablePosting[][]	getPostings()	Returns a 2D array of posting objects for the document and terms in this result set.
java.lang.String[]	getQueryTerms()	Get the query terms in this query.
java.util.Set<java.lang.String>[]	getTags()	Return the tags of each of the query terms in the query
void	setCollectionStatistics(CollectionStatistics cs)
void	setDocids(int[] ds)
void	setEntryStatistics(EntryStatistics[] es)
void	setKeyFrequencies(double[] ks)
void	setOccurrences(short[] os)
void	setPostings(WritablePosting[][] wp)
void	setQueryTerms(java.lang.String[] qs)
void	setScores(double[] ss)
void	setTags(java.util.Set<java.lang.String>[] ks)

Methods inherited from interface org.terrier.matching.ResultSet

addMetaItem, addMetaItems, allMetaItems, getDocids, getExactResultSize, getLock, getMetaItem, getMetaItems, getMetaKeys, getOccurrences, getResultSet, getResultSet, getResultSize, getScores, getStatusCode, hasMetaItems, initialise, initialise, setExactResultSize, setResultSize, setStatusCode, sort, sort

Methods inherited from interface org.apache.hadoop.io.Writable

readFields, write

Method Detail

getPostings

WritablePosting[][] getPostings()

Returns a 2D array of posting objects for the document and terms in this result set. The array is indexed by document then by term. The first dimension retains the same order as the Docids array of the result set. The second dimension has the same ordering as the QueryTerms/EntryStatistics arrays.

Returns:

2D array of postings.

setPostings

void setPostings(WritablePosting[][] wp)

getKeyFrequencies

double[] getKeyFrequencies()

Return the frequencies of each of the query terms in the query

setKeyFrequencies

void setKeyFrequencies(double[] ks)

getTags

java.util.Set<java.lang.String>[] getTags()

Return the tags of each of the query terms in the query

setTags

void setTags(java.util.Set<java.lang.String>[] ks)

getEntryStatistics

EntryStatistics[] getEntryStatistics()

Return the EntryStatistics of each of the query terms in the query

setEntryStatistics

void setEntryStatistics(EntryStatistics[] es)

getCollectionStatistics

CollectionStatistics getCollectionStatistics()

Get the collection statistics that should be applied when (re)scoring any documents in this query

setCollectionStatistics

void setCollectionStatistics(CollectionStatistics cs)

getQueryTerms

java.lang.String[] getQueryTerms()

Get the query terms in this query. This might be encoded in PostingListManager form

setQueryTerms

void setQueryTerms(java.lang.String[] qs)

setDocids

void setDocids(int[] ds)

setOccurrences

void setOccurrences(short[] os)

setScores

void setScores(double[] ss)