gov.nist.nlpir.irf.result
Class ResultForDocMatchingQueryModalityUnit

java.lang.Object
  |
  +--gov.nist.nlpir.irf.result.ResultForDocMatchingQueryModalityUnit

public class ResultForDocMatchingQueryModalityUnit

extends java.lang.Object

The result of a search modelling the match between a document and a query modality unit - at the level of a single document field.

Version:

$Revision: 1.4 $

Author:

This software was produced by NIST, an agency of the U.S. government, and by statute is not subject to copyright in the United States. Recipients of this software assume all responsibilities associated with its operation, modification and maintenance.

Field Summary

private double	docScore The score of the document, computed with an index-dependent heuristic (derived from gov.nist.nlpir.irf.index.braf.IoAddrIntern.getScore())
private ProxyDocument	document The document associated with this result
private double	maxRSV The maximum Retrieval Status Value for any document in this modality
private int	numQueryFeatures Number of features in the query
private int	numUniqueQueryFeatures Number of unique features in the query
private java.util.Vector	partialResults Collection of lower-level results (ResultForDocMatchingQueryCondition) comprised by this result
private QueryModalityUnit	QMU The query modality unit associated with this result
private double	RSV Retrieval status value for the document at this level of result

Constructor Summary

ResultForDocMatchingQueryModalityUnit(QueryModalityUnit QMU, ProxyDocument document, double docScore, java.util.Vector partialResults, double maxRSV)
Creates a ResultForDocMatchingQueryModalityUnit for the supplied query modality unit, document, score, results and maximum RSV.

Method Summary

void	addPartialResult(ResultForDocMatchingQueryCondition aPR) Adds the ResultForDocMatchingQueryCondition to the partialResults.
int	getCountOfPartialResults() Gets number of entries in partialResults
double	getDocScore() Gets the docScore
ProxyDocument	getDocument() Gets the document associated with this result.
java.util.Vector	getIndexingFeatures() Gets a vector of the indexing features comprised by this result
double	getMaxRSV() Gets the maxRSV.
int	getNumQueryFeatures() Gets the number of query features.
int	getNumUniqueQueryFeatures() Gets the number of unique query features
java.util.Vector	getPartialResults() Gets the partialResults.
QueryModalityUnit	getQueryModalityUnit() Gets the query modality unit associated with this result
double	getRSV() Gets the RSV.
void	present() Displays information about this Result
void	setMaxRSV(double v) Sets the maxRSV to the supplied value.
void	setNumQueryFeatures(int n) Sets the number of query features to the supplied value.
void	setNumUniqueQueryFeatures(int n) Sets the number of unique query features to the supplied value.
void	setRSV(double r) Sets the RSV to the supplied value.
java.lang.String	toString() Creates a string representation for a ResultForDocMatchingQueryModalityUnit

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Field Detail

RSV

private double RSV

Retrieval status value for the document at this level of result

docScore

private double docScore

The score of the document, computed with an index-dependent heuristic (derived from gov.nist.nlpir.irf.index.braf.IoAddrIntern.getScore())

numQueryFeatures

private int numQueryFeatures

Number of features in the query

numUniqueQueryFeatures

private int numUniqueQueryFeatures

Number of unique features in the query

QMU

private QueryModalityUnit QMU

The query modality unit associated with this result

maxRSV

private double maxRSV

The maximum Retrieval Status Value for any document in this modality

document

private ProxyDocument document

The document associated with this result

partialResults

private java.util.Vector partialResults

Collection of lower-level results (ResultForDocMatchingQueryCondition) comprised by this result

Constructor Detail

ResultForDocMatchingQueryModalityUnit

public ResultForDocMatchingQueryModalityUnit(QueryModalityUnit QMU,
                                             ProxyDocument document,
                                             double docScore,
                                             java.util.Vector partialResults,
                                             double maxRSV)

Creates a ResultForDocMatchingQueryModalityUnit for the supplied query modality unit, document, score, results and maximum RSV. RSV is initialized to 0.0.

Parameters:

q - A query modality unit.

d - A document.

s - The document score,

results - partial results. Must be a Vector of ResultForDocMatchingQueryConditions.

mr - Maximum retrieval status value.

Method Detail

getQueryModalityUnit

public QueryModalityUnit getQueryModalityUnit()

Gets the query modality unit associated with this result

Returns:

The query modality unit

getDocument

public ProxyDocument getDocument()

Gets the document associated with this result.

Returns:

The document .

setRSV

public void setRSV(double r)

Sets the RSV to the supplied value.

Parameters:

r - The new RSV.

getRSV

public double getRSV()

Gets the RSV.

Returns:

The retrieval status value.

addPartialResult

public void addPartialResult(ResultForDocMatchingQueryCondition aPR)

Adds the ResultForDocMatchingQueryCondition to the partialResults.

Parameters:

aPR - result for doc matching query condition.

getCountOfPartialResults

public int getCountOfPartialResults()

Gets number of entries in partialResults

Returns:

count

getDocScore

public double getDocScore()

Gets the docScore

Returns:

document score.

setNumQueryFeatures

public void setNumQueryFeatures(int n)

Sets the number of query features to the supplied value.

Parameters:

n - The new number of query features.

getNumQueryFeatures

public int getNumQueryFeatures()

Gets the number of query features.

Returns:

The number of query features.

setNumUniqueQueryFeatures

public void setNumUniqueQueryFeatures(int n)

Sets the number of unique query features to the supplied value.

Parameters:

n - The new number unique of query features.

getNumUniqueQueryFeatures

public int getNumUniqueQueryFeatures()

Gets the number of unique query features

Returns:

The number of unique query features.

getIndexingFeatures

public java.util.Vector getIndexingFeatures()

Gets a vector of the indexing features comprised by this result

Returns:

a vector of unique query features.

setMaxRSV

public void setMaxRSV(double v)

Sets the maxRSV to the supplied value.

Parameters:

v - The new maxRSV.

getMaxRSV

public double getMaxRSV()

Gets the maxRSV.

Returns:

The maximum retrieval status value.

getPartialResults

public java.util.Vector getPartialResults()

Gets the partialResults.

Returns:

The partial results.

present

public void present()

Displays information about this Result

toString

public java.lang.String toString()

Creates a string representation for a ResultForDocMatchingQueryModalityUnit

Returns:

The string representation.

Overrides:

toString in class java.lang.Object