gov.nist.nlpir.irf.result
Class BasicRetrievalResult

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

public class BasicRetrievalResult

extends java.lang.Object

Represents a the lowest level result of a search - a single indexing feature (from within a single field within a single document within a single index)

Version:

$Revision: 1.2 $

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.

See Also:

IndexingFeature

Field Summary

private ProxyIndexingFeature	IF The indexing feature which is the basic result of the search.
private double	matchingDegree The degree to which the indexing feature in this result matches the corresponding feature in the query.
private double	score The score held in the index for this feature.

Constructor Summary

BasicRetrievalResult(ProxyIndexingFeature IF)
Creates a BasicRetrievalResult, but assumes the score and the matching degree are 0.

BasicRetrievalResult(ProxyIndexingFeature IF, double matchingDegree, double score)
Creates a BasicRetrievalResult with the score and the degree given.

Method Summary

ProxyIndexingFeature	getIndexingFeature() Retrieves the Indexing Feature.
double	getMatchingDegree() Gets the matching degree.
double	getScore() Gets the score.
void	setMatchingDegree(double matchingDegree) Sets the matching degree.
void	setScore(double score) Sets the score.
java.lang.String	toString() Returns string representation of BasicRetrievalResult including indexing feature, matching degree, and score.

Methods inherited from class java.lang.Object

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

Field Detail

matchingDegree

private double matchingDegree

The degree to which the indexing feature in this result matches the corresponding feature in the query. Not used.

score

private double score

The score held in the index for this feature.

IF

private ProxyIndexingFeature IF

The indexing feature which is the basic result of the search.

Constructor Detail

BasicRetrievalResult

public BasicRetrievalResult(ProxyIndexingFeature IF,
                            double matchingDegree,
                            double score)

Creates a BasicRetrievalResult with the score and the degree given.

Parameters:

IF - the Indexing Feature concerned

matchingDegree - the matching degree

score - the score of the represented matching

BasicRetrievalResult

public BasicRetrievalResult(ProxyIndexingFeature IF)

Creates a BasicRetrievalResult, but assumes the score and the matching degree are 0.

Parameters:

IF - the Indexing Feature concerned

Method Detail

getIndexingFeature

public ProxyIndexingFeature getIndexingFeature()

Retrieves the Indexing Feature.

Returns:

Indexing Feature

getMatchingDegree

public double getMatchingDegree()

Gets the matching degree.

Returns:

matching degree

getScore

public double getScore()

Gets the score.

setMatchingDegree

public void setMatchingDegree(double matchingDegree)

Sets the matching degree.

Parameters:

md - matching degree

setScore

public void setScore(double score)

Sets the score.

Parameters:

score - the value of the score

toString

public java.lang.String toString()

Returns string representation of BasicRetrievalResult including indexing feature, matching degree, and score.

Returns:

string representation of BasicRetrievalResult.

Overrides:

toString in class java.lang.Object