org.cytoscape.view.layout

Enum WeightTypes

java.lang.Object

java.lang.Enum<WeightTypes>

org.cytoscape.view.layout.WeightTypes

All Implemented Interfaces:

Serializable, Comparable<WeightTypes>

public enum WeightTypes
extends Enum<WeightTypes>

An enum describing different weighting strategies.

Cytoscape Backwards Compatibility (Enum): This class is an enum therefore can't be extended by users. This means that we may add methods or enum values for minor version updates. Methods or enum values will only be removed for major version updates.

Module: layout-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>layout-api</artifactId>
</dependency>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTANCE Use 1 minus the normalized value.
GUESS Use a heuristic to guess.
LOG Use the negative log value.
WEIGHT Use the normalized value.

Method Summary

Modifier and Type	Method and Description
String	toString() Returns the name of the weighting type.
static WeightTypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static WeightTypes[]	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

GUESS

public static final WeightTypes GUESS

Use a heuristic to guess.

LOG

public static final WeightTypes LOG

Use the negative log value.

DISTANCE

public static final WeightTypes DISTANCE

Use 1 minus the normalized value.

WEIGHT

public static final WeightTypes WEIGHT

Use the normalized value.

Method Detail

values

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

Returns:

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

valueOf

public static WeightTypes 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 the name of the weighting type.

Overrides:

toString in class Enum<WeightTypes>

Returns:

the name of the weighting type.