VisualizationTask (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- de.lmu.ifi.dbs.elki.visualization.VisualizationTask

All Implemented Interfaces:

VisualizationItem, Comparable<VisualizationTask>
```
public class VisualizationTask
extends Object
implements VisualizationItem, Comparable<VisualizationTask>
```
Container class, with ugly casts to reduce generics crazyness.

Author:

Erich Schubert

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) VisualizerContext`	`context` The active context
`boolean`	`default_visibility` Flag to signal default visibility of a visualizer.
`(package private) VisFactory`	`factory` The factory
`static int`	`FLAG_NO_DETAIL` Mark as not having a (sensible) detail view.
`static int`	`FLAG_NO_EMBED` Flag to signal the visualizer should not be embedded.
`static int`	`FLAG_NO_EXPORT` Flag to signal the visualizer should not be exported.
`static int`	`FLAG_NO_THUMBNAIL` Flag to signal there is no thumbnail needed.
`private int`	`flags` Capabilities
`int`	`level` Meta data key: Level for visualizer ordering Returns an integer indicating the "height" of this Visualizer.
`static int`	`LEVEL_BACKGROUND` Background layer
`static int`	`LEVEL_DATA` Data layer
`static int`	`LEVEL_FOREGROUND` Passive foreground layer
`static int`	`LEVEL_INTERACTIVE` Active foreground layer (interactive elements)
`static int`	`LEVEL_STATIC` Static plot layer
`(package private) String`	`name` Name
`static int`	`ON_DATA` Constant to listen for data changes
`static int`	`ON_SAMPLE` Constant to listen for sampling result changes
`static int`	`ON_SELECTION` Constant to listen for selection changes
`static int`	`ON_STYLEPOLICY` Constant to listen for style result changes
`(package private) Relation<?>`	`relation` The main representation
`double`	`reqheight` Height request
`double`	`reqwidth` Width request
`(package private) Object`	`result` The result we are attached to
`boolean`	`tool` Flag to mark the visualizer as tool.
`int`	`updatemask` The update event mask.
`boolean`	`visible` Flag to control visibility.

Constructor Summary

Constructors
Constructor and Description
`VisualizationTask(String name, VisualizerContext context, Object result, Relation<?> relation, VisFactory factory)` Visualization task.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFlags(int bits)` Set a task flag.
`void`	`addUpdateFlags(int bits)` Set (OR) the update flags.
`int`	`compareTo(VisualizationTask other)`
`boolean`	`equals(Object o)`
`VisualizerContext`	`getContext()` Get the visualizer context.
`VisFactory`	`getFactory()` Get the visualizer factory.
`String`	`getMenuName()` Name to display in the menu.
`<R extends Relation<?>> R`	`getRelation()`
`<R> R`	`getResult()`
`boolean`	`hasAnyFlags(int bits)` Update if any oft these flags is set.
`int`	`hashCode()`
`void`	`initDefaultVisibility(boolean vis)` Init the default visibility of a task.
`String`	`toString()`
`boolean`	`updateOnAny(int bits)` Update if any oft these bits is set.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - level
```
public int level
```
    Meta data key: Level for visualizer ordering Returns an integer indicating the "height" 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.
  - visible
```
public boolean visible
```
    Flag to control visibility.
  - flags
```
private int flags
```
    Capabilities
  - FLAG_NO_THUMBNAIL
```
public static final int FLAG_NO_THUMBNAIL
```
    Flag to signal there is no thumbnail needed.
    
    See Also:
    Constant Field Values
  - FLAG_NO_DETAIL
```
public static final int FLAG_NO_DETAIL
```
    Mark as not having a (sensible) detail view.
    
    See Also:
    Constant Field Values
  - FLAG_NO_EXPORT
```
public static final int FLAG_NO_EXPORT
```
    Flag to signal the visualizer should not be exported.
    
    See Also:
    Constant Field Values
  - FLAG_NO_EMBED
```
public static final int FLAG_NO_EMBED
```
    Flag to signal the visualizer should not be embedded.
    
    See Also:
    Constant Field Values
  - default_visibility
```
public boolean default_visibility
```
    Flag to signal default visibility of a visualizer.
  - tool
```
public boolean tool
```
    Flag to mark the visualizer as tool.
  - LEVEL_BACKGROUND
```
public static final int LEVEL_BACKGROUND
```
    Background layer
    
    See Also:
    Constant Field Values
  - LEVEL_DATA
```
public static final int LEVEL_DATA
```
    Data layer
    
    See Also:
    Constant Field Values
  - LEVEL_STATIC
```
public static final int LEVEL_STATIC
```
    Static plot layer
    
    See Also:
    Constant Field Values
  - LEVEL_FOREGROUND
```
public static final int LEVEL_FOREGROUND
```
    Passive foreground layer
    
    See Also:
    Constant Field Values
  - LEVEL_INTERACTIVE
```
public static final int LEVEL_INTERACTIVE
```
    Active foreground layer (interactive elements)
    
    See Also:
    Constant Field Values
  - updatemask
```
public int updatemask
```
    The update event mask. See ON_DATA, ON_SELECTION, ON_STYLEPOLICY, ON_SAMPLE.
  - ON_DATA
```
public static final int ON_DATA
```
    Constant to listen for data changes
    
    See Also:
    Constant Field Values
  - ON_SELECTION
```
public static final int ON_SELECTION
```
    Constant to listen for selection changes
    
    See Also:
    Constant Field Values
  - ON_STYLEPOLICY
```
public static final int ON_STYLEPOLICY
```
    Constant to listen for style result changes
    
    See Also:
    Constant Field Values
  - ON_SAMPLE
```
public static final int ON_SAMPLE
```
    Constant to listen for sampling result changes
    
    See Also:
    Constant Field Values
  - name
```
String name
```
    Name
  - context
```
VisualizerContext context
```
    The active context
  - factory
```
VisFactory factory
```
    The factory
  - result
```
Object result
```
    The result we are attached to
  - relation
```
Relation<?> relation
```
    The main representation
  - reqwidth
```
public double reqwidth
```
    Width request
  - reqheight
```
public double reqheight
```
    Height request
- Constructor Detail
  - VisualizationTask
```
public VisualizationTask(String name,
                 VisualizerContext context,
                 Object result,
                 Relation<?> relation,
                 VisFactory factory)
```
    Visualization task.
    
    Parameters:
    name - Name
    context - Visualization context
    result - Result
    relation - Relation to use
    factory - Factory
- Method Detail
  - getContext
```
public VisualizerContext getContext()
```
    Get the visualizer context.
    
    Returns:
    context
  - getFactory
```
public VisFactory getFactory()
```
    Get the visualizer factory.
    
    Returns:
    Visualizer factory
  - getResult
```
public <R> R getResult()
```
  - getRelation
```
public <R extends Relation<?>> R getRelation()
```
  - initDefaultVisibility
```
public void initDefaultVisibility(boolean vis)
```
    Init the default visibility of a task.
    
    Parameters:
    vis - Visibility.
  - getMenuName
```
public String getMenuName()
```
    Description copied from interface: VisualizationItem
    
    Name to display in the menu. May be null or empty string.
    
    Specified by:
    
    getMenuName in interface VisualizationItem
    
    Returns:
    Menu name.
  - compareTo
```
public int compareTo(VisualizationTask other)
```
    Specified by:
    
    compareTo in interface Comparable<VisualizationTask>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - addUpdateFlags
```
public void addUpdateFlags(int bits)
```
    Set (OR) the update flags.
    
    Parameters:
    bits - Bits to set
  - updateOnAny
```
public boolean updateOnAny(int bits)
```
    Update if any oft these bits is set.
    
    Parameters:
    bits - Bits to check.
    
    Returns:
    true if any bit is set.
  - hasAnyFlags
```
public boolean hasAnyFlags(int bits)
```
    Update if any oft these flags is set.
    
    Parameters:
    bits - Bits to check.
    
    Returns:
    true if any bit is set.
  - addFlags
```
public void addFlags(int bits)
```
    Set a task flag.
    
    Parameters:
    bits - Flag to set

Class VisualizationTask

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

level

visible

flags

FLAG_NO_THUMBNAIL

FLAG_NO_DETAIL

FLAG_NO_EXPORT

FLAG_NO_EMBED

default_visibility

tool

LEVEL_BACKGROUND

LEVEL_DATA

LEVEL_STATIC

LEVEL_FOREGROUND

LEVEL_INTERACTIVE

updatemask

ON_DATA

ON_SELECTION

ON_STYLEPOLICY

ON_SAMPLE

name

context

factory

result

relation

reqwidth

reqheight

Constructor Detail

VisualizationTask

Method Detail

getContext

getFactory

getResult

getRelation

initDefaultVisibility

getMenuName

compareTo

toString

hashCode

equals

addUpdateFlags

updateOnAny

hasAnyFlags

addFlags