de.lmu.ifi.dbs.elki.visualization

Class VisualizerContext

java.lang.Object

de.lmu.ifi.dbs.elki.visualization.VisualizerContext

All Implemented Interfaces:

DataStoreListener, Result

public class VisualizerContext
extends Object
implements DataStoreListener, Result

Map to store context information for the visualizer. This can be any data that should to be shared among plots, such as line colors, styles etc.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private Result	baseResult Starting point of the result tree, may be null.
private Collection<VisualizationProcessor>	factories Factories to use
private ResultHierarchy	hier The full result object
private ArrayList<DataStoreListener>	listenerList The event listeners for this context.
private static Logging	LOG Logger.
private Relation<?>	relation Relation currently visualized.
private SelectionResult	selection Selection result
(package private) StyleLibrary	stylelibrary Style library
(package private) StylingPolicy	stylepolicy Styling policy
private VisualizationTree	vistree Tree of visualizations.

Constructor Summary

Constructors

Constructor and Description
VisualizerContext(ResultHierarchy hier, Result start, Relation<?> relation, StyleLibrary stylelib, Collection<VisualizationProcessor> factories) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataStoreListener(DataStoreListener l) Adds a listener for the DataStoreEvent posted after the content changes.
void	addResultListener(ResultListener listener) Register a result listener.
void	addVis(Object parent, VisualizationItem vis) Add (register) a visualization.
void	addVisualizationListener(VisualizationListener listener) Add a listener.
void	contentChanged(DataStoreEvent e) Proxy datastore event to child listeners.
private Clustering<Model>	generateDefaultClustering() Generate a default (fallback) clustering.
Result	getBaseResult() Starting point for visualization, may be null.
ResultHierarchy	getHierarchy() Get the hierarchy object
String	getLongName() A "pretty" name for the result, for use in titles, captions and menus.
Relation<?>	getRelation() Current relation.
DBIDSelection	getSelection() Get the current selection.
SelectionResult	getSelectionResult() Get the current selection result.
String	getShortName() A short name for the result, useful for file names.
StyleLibrary	getStyleLibrary() Get the style library
StylingPolicy	getStylingPolicy() Get the active styling policy
VisualizationTree	getVisHierarchy()
List<VisualizationTask>	getVisTasks(VisualizationItem item)
protected void	makeStyleResult(StyleLibrary stylelib) Generate a new style result for the given style library.
private void	notifyFactories(Object item) Notify factories of a change.
void	removeDataStoreListener(DataStoreListener l) Removes a listener previously added with addDataStoreListener.
void	removeResultListener(ResultListener listener) Remove a result listener.
void	removeVisualizationListener(VisualizationListener listener) Add a listener.
void	setRelation(Relation<?> rel) Set the current relation.
void	setSelection(DBIDSelection sel) Set a new selection.
void	setStyleLibrary(StyleLibrary library) Get the style library
void	setStylingPolicy(StylingPolicy policy) Set the active styling policy
void	visChanged(VisualizationItem item) A visualization item has changed.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logging LOG

Logger.

vistree

private VisualizationTree vistree

Tree of visualizations.

hier

private ResultHierarchy hier

The full result object

listenerList

private ArrayList<DataStoreListener> listenerList

The event listeners for this context.

factories

private Collection<VisualizationProcessor> factories

Factories to use

selection

private SelectionResult selection

Selection result

stylepolicy

StylingPolicy stylepolicy

Styling policy

stylelibrary

StyleLibrary stylelibrary

Style library

baseResult

private Result baseResult

Starting point of the result tree, may be null.

relation

private Relation<?> relation

Relation currently visualized.

Constructor Detail

VisualizerContext

public VisualizerContext(ResultHierarchy hier,
                 Result start,
                 Relation<?> relation,
                 StyleLibrary stylelib,
                 Collection<VisualizationProcessor> factories)

Constructor. We currently require a Database and a Result.

Parameters:

hier - Result hierarchy

start - Starting result

factories - Visualizer Factories to use

Method Detail

makeStyleResult

protected void makeStyleResult(StyleLibrary stylelib)

Generate a new style result for the given style library.

Parameters:

stylelib - Style library

getHierarchy

public ResultHierarchy getHierarchy()

Get the hierarchy object

Returns:

hierarchy object

getStylingPolicy

public StylingPolicy getStylingPolicy()

Get the active styling policy

Returns:

Styling policy

setStylingPolicy

public void setStylingPolicy(StylingPolicy policy)

Set the active styling policy

Parameters:

policy - new Styling policy

getStyleLibrary

public StyleLibrary getStyleLibrary()

Get the style library

Returns:

Style library

setStyleLibrary

public void setStyleLibrary(StyleLibrary library)

Get the style library

Parameters:

library - Style library

generateDefaultClustering

private Clustering<Model> generateDefaultClustering()

Generate a default (fallback) clustering.

Returns:

generated clustering

getSelectionResult

public SelectionResult getSelectionResult()

Get the current selection result.

Returns:

selection result

getSelection

public DBIDSelection getSelection()

Get the current selection.

Returns:

selection

setSelection

public void setSelection(DBIDSelection sel)

Set a new selection.

Parameters:

sel - Selection

getRelation

public Relation<?> getRelation()

Current relation.

setRelation

public void setRelation(Relation<?> rel)

Set the current relation.

Parameters:

rel - Relation

addDataStoreListener

public void addDataStoreListener(DataStoreListener l)

Adds a listener for the DataStoreEvent posted after the content changes.

Parameters:

l - the listener to add

See Also:

removeDataStoreListener(de.lmu.ifi.dbs.elki.database.datastore.DataStoreListener)

removeDataStoreListener

public void removeDataStoreListener(DataStoreListener l)

Removes a listener previously added with addDataStoreListener.

Parameters:

l - the listener to remove

See Also:

addDataStoreListener(de.lmu.ifi.dbs.elki.database.datastore.DataStoreListener)

contentChanged

public void contentChanged(DataStoreEvent e)

Proxy datastore event to child listeners.

Specified by:

contentChanged in interface DataStoreListener

Parameters:

e - the update event

addResultListener

public void addResultListener(ResultListener listener)

Register a result listener.

Parameters:

listener - Result listener.

removeResultListener

public void removeResultListener(ResultListener listener)

Remove a result listener.

Parameters:

listener - Result listener.

addVisualizationListener

public void addVisualizationListener(VisualizationListener listener)

Add a listener.

Parameters:

listener - Listener to add

removeVisualizationListener

public void removeVisualizationListener(VisualizationListener listener)

Add a listener.

Parameters:

listener - Listener to remove

getLongName

public String getLongName()

Description copied from interface: Result

A "pretty" name for the result, for use in titles, captions and menus.

Specified by:

getLongName in interface Result

Returns:

result name

getShortName

public String getShortName()

Description copied from interface: Result

A short name for the result, useful for file names.

Specified by:

getShortName in interface Result

Returns:

result name

getBaseResult

public Result getBaseResult()

Starting point for visualization, may be null.

Returns:

Starting point in the result tree, may be null.

addVis

public void addVis(Object parent,
          VisualizationItem vis)

Add (register) a visualization.

Parameters:

parent - Parent object

vis - Visualization

visChanged

public void visChanged(VisualizationItem item)

A visualization item has changed.

Parameters:

item - Item that has changed

notifyFactories

private void notifyFactories(Object item)

Notify factories of a change.

Parameters:

item - Item that has changed.

getVisTasks

public List<VisualizationTask> getVisTasks(VisualizationItem item)

getVisHierarchy

public VisualizationTree getVisHierarchy()