org.gephi.graph.api

Enum Estimator

java.lang.Object

java.lang.Enum<Estimator>

org.gephi.graph.api.Estimator

All Implemented Interfaces:

Serializable, Comparable<Estimator>

public enum Estimator
extends Enum<Estimator>

Estimators specify the strategy to merge attribute values over time.

Estimators are associated with actions that require to transform a sorted set of values over time into a single value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE Average value.
FIRST First value.
LAST Last value.
MAX Maximum value.
MEDIAN Median value.
MIN Minimum value.
SUM Sum value.

Method Summary

Modifier and Type	Method and Description
boolean	is(Estimator... estimators) Returns true if this estimator is any of the given estimators.
boolean	is(Estimator estimator) Returns true if this estimator is equals to estimator.
static Estimator	valueOf(String name) Returns the enum constant of this type with the specified name.
static Estimator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, 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 Estimator AVERAGE

Average value.

MEDIAN

public static final Estimator MEDIAN

Median value.

SUM

public static final Estimator SUM

Sum value.

MIN

public static final Estimator MIN

Minimum value.

MAX

public static final Estimator MAX

Maximum value.

FIRST

public static final Estimator FIRST

First value.

LAST

public static final Estimator LAST

Last value.

Method Detail

values

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

Returns:

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

valueOf

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

is

public boolean is(Estimator estimator)

Returns true if this estimator is equals to estimator.

Parameters:

estimator - estimator to test equality

Returns:

true if estimator is equal to this instance

is

public boolean is(Estimator... estimators)

Returns true if this estimator is any of the given estimators.

Parameters:

estimators - estimators to test equality

Returns:

true if estimators contains this estimator