info.aduna.spectacle
Class GuidedExplorationResultImpl

java.lang.Object
  info.aduna.spectacle.GuidedExplorationResultImpl

All Implemented Interfaces:

GuidedExplorationResult

public class GuidedExplorationResultImpl
extends Object
implements GuidedExplorationResult

Constructor Summary

GuidedExplorationResultImpl(Profile profile, SpectacleLoader loader, NavigationTree root, List<FacetValue> selections)
Construct a new GuidedExplorationResult

Method Summary

static String	calculateLocation(List<FacetValue> facetValues) A string describing the location specified by the facetValues.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuidedExplorationResultImpl

public GuidedExplorationResultImpl(Profile profile,
                                   SpectacleLoader loader,
                                   NavigationTree root,
                                   List<FacetValue> selections)

Construct a new GuidedExplorationResult

Parameters:

profile - the profile in which this results resides

loader - the loader from which dynamic information can be retrieved

root - the root of the Guided Exploration Environment

selections - the selections that lead to this result

Method Detail

getProfile

public Profile getProfile()

Description copied from interface: GuidedExplorationResult

The profile this result is part of.

Specified by:

getProfile in interface GuidedExplorationResult

Returns:

the profile this result is part of

getLoader

public SpectacleLoader getLoader()

Description copied from interface: GuidedExplorationResult

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

Specified by:

getLoader in interface GuidedExplorationResult

Returns:

the loader from which dynamic information can be retrieved

getLocation

public String getLocation()

Description copied from interface: GuidedExplorationResult

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

Specified by:

getLocation in interface GuidedExplorationResult

Returns:

the human-readable location of this result

getEntities

public List<Entity> getEntities()

Description copied from interface: GuidedExplorationResult

The list of entities that occur at this location.

Specified by:

getEntities in interface GuidedExplorationResult

Returns:

the list of entities that occur at this location

getAvailableSelections

public List<FacetValue> getAvailableSelections()

Description copied from interface: GuidedExplorationResult

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().

Specified by:

getAvailableSelections in interface GuidedExplorationResult

Returns:

the list of selections that are actually available

getUnavailableSelections

public List<FacetValue> getUnavailableSelections()

Description copied from interface: GuidedExplorationResult

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().

Specified by:

getUnavailableSelections in interface GuidedExplorationResult

Returns:

the list of selections that are actually available

getEntityRelevances

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

Specified by:

getEntityRelevances in interface GuidedExplorationResult

getExits

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

Description copied from interface: GuidedExplorationResult

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

Specified by:

getExits in interface GuidedExplorationResult

Returns:

the exits from this location

getNextExits

public List<String> getNextExits(FacetValue facetValue)

Description copied from interface: GuidedExplorationResult

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.

Specified by:

getNextExits in interface GuidedExplorationResult

Parameters:

facetValue - a facet and value indicating the known location

Returns:

the exits for the specified facet from the specified relative location

getSuggestions

public Map<String,Integer> getSuggestions(String facet)

Description copied from interface: GuidedExplorationResult

Get suggested values for the specified facet.

Specified by:

getSuggestions in interface GuidedExplorationResult

Parameters:

facet - the facet

Returns:

suggested values for the specified facet

calculateLocation

public static String calculateLocation(List<FacetValue> facetValues)

A string describing the location specified by the facetValues.

Parameters:

facetValues - the facet values that specify the path taken to reach the location

Returns:

a UNIX-path-like string describing the location specified by the facet values