org.knime.base.node.viz.aggregation
Enum AggregationMethod

java.lang.Object
  extended by java.lang.Enum<AggregationMethod>
      extended by org.knime.base.node.viz.aggregation.AggregationMethod
All Implemented Interfaces:
Serializable, Comparable<AggregationMethod>, ButtonGroupEnumInterface

public enum AggregationMethod
extends Enum<AggregationMethod>
implements ButtonGroupEnumInterface

Enumerates all possible aggregation methods of the Histogram visualisation.

Author:
Tobias Koetter, University of Konstanz

Enum Constant Summary
AVERAGE
          The average of the selected y column.
COUNT
          The number of rows.
SUM
          The summary of the selected y column.
VALUE_COUNT
          The number of values without missing values.
 
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 AggregationMethod getDefaultMethod()
           
static AggregationMethod getMethod4Command(String action)
          Returns the aggregation method for the given name.
 String getText()
          
 String getToolTip()
          
 boolean isDefault()
          
static boolean valid(String aggrMethod)
           
static AggregationMethod valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AggregationMethod[] 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

AVERAGE

public static final AggregationMethod AVERAGE
The average of the selected y column.


SUM

public static final AggregationMethod SUM
The summary of the selected y column.


COUNT

public static final AggregationMethod COUNT
The number of rows.


VALUE_COUNT

public static final AggregationMethod VALUE_COUNT
The number of values without missing values.

Method Detail

values

public static AggregationMethod[] 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 (AggregationMethod c : AggregationMethod.values())
    System.out.println(c);

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

valueOf

public static AggregationMethod 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

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

getMethod4Command

public static AggregationMethod getMethod4Command(String action)
Returns the aggregation method for the given name. If the name is null or has length zero the method returns the default aggregation method.

Parameters:
action - the action command to check
Returns:
the aggregation method with the given name

getDefaultMethod

public static AggregationMethod getDefaultMethod()
Returns:
the default aggregation method

valid

public static boolean valid(String aggrMethod)
Parameters:
aggrMethod - the name of method to check
Returns:
true if it's a valid aggregation method otherwise it returns false.

getActionCommand

public String getActionCommand()
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 unique action command of this option

getText

public String getText()

Specified by:
getText in interface ButtonGroupEnumInterface
Returns:
the text to display

getToolTip

public String getToolTip()

Specified by:
getToolTip in interface ButtonGroupEnumInterface
Returns:
the tool tip of this option could be null

isDefault

public boolean isDefault()

Specified by:
isDefault in interface ButtonGroupEnumInterface
Returns:
true if this is the default option


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.