ddf.catalog.data

Interface Result

All Known Implementing Classes:

QueryResponseImpl.POISON_PILL_RESULT, ResultImpl

public interface Result

The Result is used to supplement Metacard fields when a Metacard is returned from a query. It adds a relevance score and distance in meters to the Metacard's existing attributes.

See Also:

Query

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISTANCE Constant used to specify a sort policy based on distance.
static String	RELEVANCE Constant used to specify a sort policy based on relevance.
static String	TEMPORAL Constant used to specify a sort policy based on temporal data.

Method Summary

Modifier and Type	Method and Description
Double	getDistanceInMeters() Gets the distance in meters.
Metacard	getMetacard() Gets the Metacard wrapped by this Result.
Double	getRelevanceScore() Gets the relevance score.

Field Detail

RELEVANCE

static final String RELEVANCE

Constant used to specify a sort policy based on relevance.

See Also:

Constant Field Values

DISTANCE

static final String DISTANCE

Constant used to specify a sort policy based on distance.

See Also:

Constant Field Values

TEMPORAL

static final String TEMPORAL

Constant used to specify a sort policy based on temporal data.

See Also:

Constant Field Values

Method Detail

getMetacard

Metacard getMetacard()

Gets the Metacard wrapped by this Result.

Returns:

the Metacard wrapped by this Result

getRelevanceScore

Double getRelevanceScore()

Gets the relevance score.

Returns:

relevance score (typical range of 0-1, values over 1 are those that have been boosted)

getDistanceInMeters

Double getDistanceInMeters()

Gets the distance in meters.

Returns:

distance in meters, null if Result was not part of a search that was sorted by distance.