org.cytoscape.cyni
Enum CyniMetricTypes

java.lang.Object
  java.lang.Enum<CyniMetricTypes>
      org.cytoscape.cyni.CyniMetricTypes

All Implemented Interfaces:

Serializable, Comparable<CyniMetricTypes>

public enum CyniMetricTypes
extends Enum<CyniMetricTypes>

An enum that captures the types of the default Cyni Metrics available

Enum Constant Summary

CORRELATION_METRIC
Cyni Metric based on searching for any statistical relationship between two sets of data

INPUT_NUMBERS
Cyni Metric accepts numbers as input

INPUT_STRINGS
Cyni Metric accepts strings as input

LOCAL_METRIC_SCORE
Cyni Metric decomposed as the sum or product of the score of each individual node

Method Summary

int	getType()
static CyniMetricTypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static CyniMetricTypes[]	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

INPUT_NUMBERS

public static final CyniMetricTypes INPUT_NUMBERS

Cyni Metric accepts numbers as input

INPUT_STRINGS

public static final CyniMetricTypes INPUT_STRINGS

Cyni Metric accepts strings as input

LOCAL_METRIC_SCORE

public static final CyniMetricTypes LOCAL_METRIC_SCORE

Cyni Metric decomposed as the sum or product of the score of each individual node

CORRELATION_METRIC

public static final CyniMetricTypes CORRELATION_METRIC

Cyni Metric based on searching for any statistical relationship between two sets of data

Method Detail

values

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

Returns:

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

valueOf

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

getType

public int getType()