bcds.phison.gm
Enum MetricTarget

java.lang.Object
  java.lang.Enum<MetricTarget>
      bcds.phison.gm.MetricTarget

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetricTarget>

public enum MetricTarget
extends java.lang.Enum<MetricTarget>

Defines the domain of a metric, that is, if it is applicable to the whole graph, nodes or links.

Enum Constant Summary

EDGE
A metric that is applicable to links, for example, betweenness centrality.

GRAPH
A metric that is applicable to the whole graph, for example, diameter, clustering coefficient, or average node degree.

NODE
A metric that is applicable to nodes, for example, betweenness centrality and clustering coefficient.

Method Summary

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

GRAPH

public static final MetricTarget GRAPH

A metric that is applicable to the whole graph, for example, diameter, clustering coefficient, or average node degree.

NODE

public static final MetricTarget NODE

A metric that is applicable to nodes, for example, betweenness centrality and clustering coefficient.

EDGE

public static final MetricTarget EDGE

A metric that is applicable to links, for example, betweenness centrality.

Method Detail

values

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

Returns:

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

valueOf

public static MetricTarget valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null