Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.visualization.visualizers
Interface Visualizer

All Superinterfaces:
Parameterizable
All Known Subinterfaces:
ProjectedVisualizer, UnprojectedVisualizer
All Known Implementing Classes:
AbstractVisualizer, AxisVisualizer, BubbleVisualizer, ClusteringVisualizer, ClusterOrderVisualizer, CurveVisualizer, DataDotVisualizer, HistogramVisualizer, KeyVisualizer, OPTICSPlotVisualizer, Projection1DHistogramVisualizer, Projection1DVisualizer, Projection2DVisualizer, ReferencePointsVisualizer, SettingsVisualizer, TooltipVisualizer, TreeMBRVisualizer

public interface Visualizer
extends Parameterizable

Defines the requirements for a visualizer.
Note: Any implementation is supposed to provide a constructor without parameters (default constructor) to be used for parameterization.

Author:
Remigius Wojdanowski

Field Summary
static int LEVEL_BACKGROUND
          Background layer
static int LEVEL_FOREGROUND
          Passive foreground layer
static int LEVEL_INTERACTIVE
          Active foreground layer (interactive elements)
static int LEVEL_STATIC
          Static plot layer
static String META_LEVEL
          Meta data key: Level for visualizer ordering Returns an integer indicating the "temporal position" of this Visualizer.
static String META_NAME
          Meta data key: Visualizer name for UI Type: String
static String META_NOTHUMB
          Flag to signal there is no thumbnail needed.
static String META_VISIBLE
          Flag to control visibility.
static String META_VISIBLE_DEFAULT
          Flag to signal default visibility of a visualizer.
 
Method Summary
 void addRedrawListener(RedrawListener listener)
          Add a redraw listener to the visualizer.
 AnyMap<String> getMetadata()
          Get visualization meta data, such as dimensions visualized.
 boolean removeRedrawListener(RedrawListener listener)
          Remove a redraw listener to the visualizer.
 

Field Detail

META_NAME

static final String META_NAME
Meta data key: Visualizer name for UI Type: String

See Also:
Constant Field Values

META_LEVEL

static final String META_LEVEL
Meta data key: Level for visualizer ordering Returns an integer indicating the "temporal position" of this Visualizer. It is intended to impose an ordering on the execution of Visualizers as a Visualizer may depend on another Visualizer running earlier.
Lower numbers should result in a earlier use of this Visualizer, while higher numbers should result in a later use. If more Visualizers have the same level, no ordering is guaranteed.
Note that this value is only a recommendation, as it is totally up to the framework to ignore it. Type: Integer

See Also:
Constant Field Values

META_VISIBLE

static final String META_VISIBLE
Flag to control visibility. Type: Boolean

See Also:
Constant Field Values

META_NOTHUMB

static final String META_NOTHUMB
Flag to signal there is no thumbnail needed. Type: Boolean

See Also:
Constant Field Values

META_VISIBLE_DEFAULT

static final String META_VISIBLE_DEFAULT
Flag to signal default visibility of a visualizer. Type: Boolean

See Also:
Constant Field Values

LEVEL_BACKGROUND

static final int LEVEL_BACKGROUND
Background layer

See Also:
Constant Field Values

LEVEL_STATIC

static final int LEVEL_STATIC
Static plot layer

See Also:
Constant Field Values

LEVEL_FOREGROUND

static final int LEVEL_FOREGROUND
Passive foreground layer

See Also:
Constant Field Values

LEVEL_INTERACTIVE

static final int LEVEL_INTERACTIVE
Active foreground layer (interactive elements)

See Also:
Constant Field Values
Method Detail

getMetadata

AnyMap<String> getMetadata()
Get visualization meta data, such as dimensions visualized.

Returns:
AnyMap reference with meta data.

addRedrawListener

void addRedrawListener(RedrawListener listener)
Add a redraw listener to the visualizer.

Parameters:
listener - Listener to be called on redraws.

removeRedrawListener

boolean removeRedrawListener(RedrawListener listener)
Remove a redraw listener to the visualizer.

Parameters:
listener - Listener to be removed.
Returns:
success

Release 0.3 (2010-03-31_1612)