com.languagecomputer.api.query
Interface QueryResult

All Known Implementing Classes:

DefaultQueryResult

public interface QueryResult

Result of a Document Retrieval Query. A QueryResult is basically a Document and a score in the range (0.0-1.0]. The score can be considered optional (e.g., for boolean query types), in which case the score should be 1.0.

Since:

1.0

Author:

Kirk Roberts

See Also:

DocumentRetrieval

Method Summary

Document	getDocument() Returns the Document associated with this QueryResult.
double	getScore() Returns a score for this QueryResult in the range of (0.0-1.0] (optional).

Method Detail

getDocument

Document getDocument()

Returns the Document associated with this QueryResult.

Returns:

The resulting Document.

getScore

double getScore()

Returns a score for this QueryResult in the range of (0.0-1.0] (optional). If the implementor chooses not to provide a score, then 1.0 should be used.

Returns:

The (0.0-1.0] score of this QueryResult.