info.aduna.spectacle
Interface GuidedExplorationResult

All Known Implementing Classes:

GuidedExplorationResultImpl, PartialGuidedExplorationResult

public interface GuidedExplorationResult

Method Summary

List<FacetValue>	getAvailableSelections() The list of selections that are actually available.
List<Entity>	getEntities() The list of entities that occur at this location.
Map<FacetValue,Map<Object,Double>>	getEntityRelevances()
Map<String,Map<String,Integer>>	getExits() The Guided Exploration exits from this location, along with the number of entities at the new location, per facet.
SpectacleLoader	getLoader() The loader the loader from which dynamic information can be retrieved.
String	getLocation() The human-readable location of this result.
List<String>	getNextExits(FacetValue facetValue) The Guided Exploration exits for a specific facet from a known location relative to this location.
Profile	getProfile() The profile this result is part of.
Map<String,Integer>	getSuggestions(String facet) Get suggested values for the specified facet.
List<FacetValue>	getUnavailableSelections() The list of selections that are NOT available.

Method Detail

getProfile

Profile getProfile()

The profile this result is part of.

Returns:

the profile this result is part of

getLoader

SpectacleLoader getLoader()

The loader the loader from which dynamic information can be retrieved.

Returns:

the loader from which dynamic information can be retrieved

getLocation

String getLocation()

The human-readable location of this result. E.g. /facet1/facetvalue/facet2/facetvalue

Returns:

the human-readable location of this result

getEntities

List<Entity> getEntities()

The list of entities that occur at this location.

Returns:

the list of entities that occur at this location

getAvailableSelections

List<FacetValue> getAvailableSelections()

The list of selections that are actually available. This is a sub-set of the original selections passed to the constructor. Its complement can be obtained through getUnavailableSelections().

Returns:

the list of selections that are actually available

getUnavailableSelections

List<FacetValue> getUnavailableSelections()

The list of selections that are NOT available. This is a sub-set of the original selections passed to the constructor. Its complement can be obtained through getAvailableSelections().

Returns:

the list of selections that are actually available

getEntityRelevances

Map<FacetValue,Map<Object,Double>> getEntityRelevances()

getExits

Map<String,Map<String,Integer>> getExits()

The Guided Exploration exits from this location, along with the number of entities at the new location, per facet.

Returns:

the exits from this location

getNextExits

List<String> getNextExits(FacetValue facetValue)

The Guided Exploration exits for a specific facet from a known location relative to this location. This effectively looks ahead one step in a hierarchical facet hierarchy.

Parameters:

facetValue - a facet and value indicating the known location

Returns:

the exits for the specified facet from the specified relative location

getSuggestions

Map<String,Integer> getSuggestions(String facet)

Get suggested values for the specified facet.

Parameters:

facet - the facet

Returns:

suggested values for the specified facet