Cytoscape 3.0.1 API

org.cytoscape.group.data
Enum AttributeHandlingType

java.lang.Object
  extended by java.lang.Enum<AttributeHandlingType>
      extended by org.cytoscape.group.data.AttributeHandlingType
All Implemented Interfaces:
Serializable, Comparable<AttributeHandlingType>

public enum AttributeHandlingType
extends Enum<AttributeHandlingType>

The AttributeHandlingType enum contains the list of all of the different ways that attributes can be aggregated. Note that there is no explicit mapping from attribute type to allowable attribute aggregation type. That mapping is contained within the various AttributeHandlingType arrays defined below.


Enum Constant Summary
AND
          Aggregated as a logical AND of all values.
AVG
          Aggregated as the average of all values.
CONCAT
          Aggregated as a concatenation of all values.
CSV
          Aggregated as comma-separated values.
DEFAULT
          Default, no aggregation.
MAX
          Aggregated as the maximum value.
MCV
          Aggregated as most common value.
MEDIAN
          Aggregated as the median value.
MIN
          Aggregated as the minimum value.
NONE
          No aggregation.
OR
          Aggregated as a logical OR of all values.
SUM
          Aggregated as the sum of all values.
TSV
          Aggregated as tab-separated values.
UNIQUE
          Aggregated as unique values.
 
Method Summary
 String toString()
          Returns a human readable name for this enum value.
static AttributeHandlingType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AttributeHandlingType[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NONE

public static final AttributeHandlingType NONE
No aggregation.


CSV

public static final AttributeHandlingType CSV
Aggregated as comma-separated values.


TSV

public static final AttributeHandlingType TSV
Aggregated as tab-separated values.


MCV

public static final AttributeHandlingType MCV
Aggregated as most common value.


SUM

public static final AttributeHandlingType SUM
Aggregated as the sum of all values.


AVG

public static final AttributeHandlingType AVG
Aggregated as the average of all values.


MIN

public static final AttributeHandlingType MIN
Aggregated as the minimum value.


MAX

public static final AttributeHandlingType MAX
Aggregated as the maximum value.


MEDIAN

public static final AttributeHandlingType MEDIAN
Aggregated as the median value.


CONCAT

public static final AttributeHandlingType CONCAT
Aggregated as a concatenation of all values.


UNIQUE

public static final AttributeHandlingType UNIQUE
Aggregated as unique values.


AND

public static final AttributeHandlingType AND
Aggregated as a logical AND of all values.


OR

public static final AttributeHandlingType OR
Aggregated as a logical OR of all values.


DEFAULT

public static final AttributeHandlingType DEFAULT
Default, no aggregation.

Method Detail

values

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

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

valueOf

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

toString

public String toString()
Returns a human readable name for this enum value.

Overrides:
toString in class Enum<AttributeHandlingType>
Returns:
a human readable name for this enum value.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.