org.knime.base.node.viz.histogram
Enum HistogramLayout

java.lang.Object
  java.lang.Enum<HistogramLayout>
      org.knime.base.node.viz.histogram.HistogramLayout

All Implemented Interfaces:

Serializable, Comparable<HistogramLayout>, ButtonGroupEnumInterface

public enum HistogramLayout
extends Enum<HistogramLayout>
implements ButtonGroupEnumInterface

Enumerates all possible layouts of the Histogram visualisation.

Author:

Tobias Koetter, University of Konstanz

Enum Constant Summary

SIDE_BY_SIDE
The BarElements are displayed next to each other.

STACKED
The BarElements are displayed on top of each other.

Method Summary

static List<String>	asStringList() Returns the enumeration fields as a String list of their names.
String	getActionCommand() Should return the ButtonGroup wide unique action command.
static HistogramLayout	getDefaultLayout()
static HistogramLayout	getLayout4ID(String id)
static HistogramLayout	getLayout4String(String name) Returns the histogram layout for the given name.
String	getText()
String	getToolTip()
boolean	isDefault()
static boolean	valid(String layout)
static HistogramLayout	valueOf(String name) Returns the enum constant of this type with the specified name.
static HistogramLayout[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SIDE_BY_SIDE

public static final HistogramLayout SIDE_BY_SIDE

The BarElements are displayed next to each other.

STACKED

public static final HistogramLayout STACKED

The BarElements are displayed on top of each other.

Method Detail

values

public static HistogramLayout[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HistogramLayout c : HistogramLayout.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HistogramLayout valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getActionCommand

public String getActionCommand()

Description copied from interface: ButtonGroupEnumInterface

Should return the ButtonGroup wide unique action command. This is typically the return value of the Enum.name() method.

Specified by:

getActionCommand in interface ButtonGroupEnumInterface

Returns:

the id of the layout option

getText

public String getText()

Specified by:

getText in interface ButtonGroupEnumInterface

Returns:

the name of the layout option

getToolTip

public String getToolTip()

Specified by:

getToolTip in interface ButtonGroupEnumInterface

Returns:

the tool tip of this option could be null

asStringList

public static List<String> asStringList()

Returns the enumeration fields as a String list of their names.

Returns:

the enumeration fields as a String list of their names

getLayout4String

public static HistogramLayout getLayout4String(String name)

Returns the histogram layout for the given name. If the name is null or has length zero the method returns the default layout.

Parameters:

name - the name to check

Returns:

the layout with the given name

getDefaultLayout

public static HistogramLayout getDefaultLayout()

Returns:

the default aggregation method

isDefault

public boolean isDefault()

Specified by:

isDefault in interface ButtonGroupEnumInterface

Returns:

true if this is the default option

valid

public static boolean valid(String layout)

Parameters:

layout - the name of the layout to check

Returns:

true if it's a valid histogram layout otherwise it returns false.

getLayout4ID

public static HistogramLayout getLayout4ID(String id)

Parameters:

id - the id to search for

Returns:

the HistogramLayout object with the given id