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

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

All Implemented Interfaces:

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

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
`boolean`	`hasoptions` Indicate whether this task has options.
`double`	`height` Height
`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
`boolean`	`nodetail` Mark as not having a (sensible) detail view.
`boolean`	`noembed` Flag to signal the visualizer should not be embedded.
`boolean`	`noexport` Flag to signal the visualizer should not be exported.
`(package private) Projection`	`proj` The current projection
`(package private) Relation<?>`	`relation` The main representation
`(package private) Result`	`result` The result we are attached to
`(package private) SVGPlot`	`svgp` The plot to draw onto
`boolean`	`thumbnail` Flag to signal there is no thumbnail needed.
`static String`	`THUMBNAIL` Constant for using thumbnail
`static String`	`THUMBNAIL_RESOLUTION` Thumbnail size
`int`	`thumbsize` Thumbnail size
`boolean`	`tool` Flag to mark the visualizer as tool.
`boolean`	`visible` Flag to control visibility.
`double`	`width` Width

Constructor Summary

Constructors
Constructor and Description
`VisualizationTask(String name, Result result, Relation<?> relation, VisFactory factory)` Visualization task.
`VisualizationTask(String name, VisualizerContext context, Result result, Relation<?> relation, VisFactory factory, Projection proj, SVGPlot svgp, double width, double height)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`VisualizationTask`	`clone()`
`VisualizationTask`	`clone(SVGPlot newplot, VisualizerContext context)` Special clone operation that replaces the target plot.
`VisualizationTask`	`clone(SVGPlot plot, VisualizerContext context, Projection p, double width, double height)` Special clone operation to set projection and size.
`int`	`compareTo(VisualizationTask other)`
`boolean`	`equals(Object o)`
`VisualizerContext`	`getContext()` Get the visualizer context.
`VisFactory`	`getFactory()` Get the visualizer factory.
`double`	`getHeight()`
`String`	`getLongName()` A "pretty" name for the result, for use in titles, captions and menus.
`SVGPlot`	`getPlot()`
`<P extends Projection> P`	`getProj()`
`<R extends Relation<?>> R`	`getRelation()`
`<R extends Result> R`	`getResult()`
`String`	`getShortName()` A short name for the result, useful for file names.
`double`	`getWidth()`
`int`	`hashCode()`
`void`	`initDefaultVisibility(boolean vis)` Init the default visibility of a task.
`String`	`toString()`

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

- Field Detail
  - THUMBNAIL
```
public static final String THUMBNAIL
```
    Constant for using thumbnail
    
    See Also:
    Constant Field Values
  - THUMBNAIL_RESOLUTION
```
public static final String THUMBNAIL_RESOLUTION
```
    Thumbnail size
    
    See Also:
    Constant Field Values
  - 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.
  - thumbnail
```
public boolean thumbnail
```
    Flag to signal there is no thumbnail needed.
  - nodetail
```
public boolean nodetail
```
    Mark as not having a (sensible) detail view.
  - noexport
```
public boolean noexport
```
    Flag to signal the visualizer should not be exported.
  - noembed
```
public boolean noembed
```
    Flag to signal the visualizer should not be embedded.
  - 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.
  - hasoptions
```
public boolean hasoptions
```
    Indicate whether this task has options.
  - 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
  - name
```
String name
```
    Name
  - context
```
VisualizerContext context
```
    The active context
  - factory
```
VisFactory factory
```
    The factory
  - result
```
Result result
```
    The result we are attached to
  - proj
```
Projection proj
```
    The current projection
  - relation
```
Relation<?> relation
```
    The main representation
  - svgp
```
SVGPlot svgp
```
    The plot to draw onto
  - width
```
public double width
```
    Width
  - height
```
public double height
```
    Height
  - thumbsize
```
public int thumbsize
```
    Thumbnail size
- Constructor Detail
  - VisualizationTask
```
public VisualizationTask(String name,
                 Result result,
                 Relation<?> relation,
                 VisFactory factory)
```
    Visualization task.
    
    Parameters:
    name - Name
    result - Result
    relation - Relation to use
    factory - Factory
  - VisualizationTask
```
public VisualizationTask(String name,
                 VisualizerContext context,
                 Result result,
                 Relation<?> relation,
                 VisFactory factory,
                 Projection proj,
                 SVGPlot svgp,
                 double width,
                 double height)
```
    Constructor
    
    Parameters:
    name - Name
    context - Context
    result - Result
    relation - Representation
    factory - Factory
    proj - Projection
    svgp - Plot
    width - Width
    height - Height
- 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 extends Result> R getResult()
```
  - getProj
```
public <P extends Projection> P getProj()
```
  - getRelation
```
public <R extends Relation<?>> R getRelation()
```
  - getPlot
```
public SVGPlot getPlot()
```
  - getWidth
```
public double getWidth()
```
  - getHeight
```
public double getHeight()
```
  - initDefaultVisibility
```
public void initDefaultVisibility(boolean vis)
```
    Init the default visibility of a task.
    
    Parameters:
    vis - Visibility.
  - clone
```
public VisualizationTask clone()
```
    Overrides:
    
    clone in class Object
  - clone
```
public VisualizationTask clone(SVGPlot newplot,
                      VisualizerContext context)
```
    Special clone operation that replaces the target plot.
    
    Parameters:
    newplot - Replacement plot to use
    context - Visualizer context
    
    Returns:
    clone with different plot
  - clone
```
public VisualizationTask clone(SVGPlot plot,
                      VisualizerContext context,
                      Projection p,
                      double width,
                      double height)
```
    Special clone operation to set projection and size.
    
    Parameters:
    plot - new plot
    p - Projection to use
    width - Width
    height - Height
    
    Returns:
    clone with different plot
  - 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
  - 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

Class VisualizationTask

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

THUMBNAIL

THUMBNAIL_RESOLUTION

level

visible

thumbnail

nodetail

noexport

noembed

default_visibility

tool

hasoptions

LEVEL_BACKGROUND

LEVEL_DATA

LEVEL_STATIC

LEVEL_FOREGROUND

LEVEL_INTERACTIVE

name

context

factory

result

proj

relation

svgp

width

height

thumbsize

Constructor Detail

VisualizationTask

VisualizationTask

Method Detail

getContext

getFactory

getResult

getProj

getRelation

getPlot

getWidth

getHeight

initDefaultVisibility

clone

clone

clone

getLongName

getShortName

compareTo

toString

hashCode

equals