info.aduna.gee.spectacle.webserver
Class Profile

java.lang.Object
  info.aduna.gee.spectacle.webserver.Profile

public final class Profile
extends Object

A representation of a profile that can be added to a Loader.

A profile has a name (aka 'mountpoint'), and can consist of one or more views that make a data selection (aka 'startpoint').

Constructor Summary

Profile(String profileName)
Construct a new profile representation with the given name.

Method Summary

void	addView(String name, String facetSelection) Add a view that selects data based on the given selection criteria.
String	getName() Returns the name of this profile.
Iterator	getViewNames() Get the names of all the views added so far.
String	getViewSelection(String viewName) Get the selection (aka 'startPoint') of the given view.

Methods inherited from class java.lang.Object

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

Constructor Detail

Profile

public Profile(String profileName)

Construct a new profile representation with the given name.

Parameters:

profileName - The name of the profile. This name is the actual channel name in spectacle, which means it will be what you see in the URL for accessing the profile.

Method Detail

addView

public void addView(String name,
                    String facetSelection)

Add a view that selects data based on the given selection criteria.

Parameters:

name - A name for the view representing the selection made in the view. Specify "/" to mount the view under the root of the profile, which makes it part of the initial view.

facetSelection - Also known as 'startPoint', this string makes a selection from the set of entities available using the known classifications. The same strings as returned by the FacetClassifier implementations must be used. Example could be: "/size/10Kb - 100Kb", where '10Kb - 100Kb' would be the string returned by a SizeFacetClassifier.

getName

public String getName()

Returns the name of this profile. This name is the actual channel name in spectacle, which means it will be what you see in the URL for accessing the profile.

getViewNames

public Iterator getViewNames()

Get the names of all the views added so far.

getViewSelection

public String getViewSelection(String viewName)

Get the selection (aka 'startPoint') of the given view.