Package com.targomo.client.api.enums

Enum Class EdgeStatisticDirection

java.lang.Object

java.lang.Enum<EdgeStatisticDirection>

com.targomo.client.api.enums.EdgeStatisticDirection

All Implemented Interfaces:

Serializable, Comparable<EdgeStatisticDirection>, java.lang.constant.Constable

public enum EdgeStatisticDirection
extends Enum<EdgeStatisticDirection>

Specifying which directions of the edge should be considered and if more then one then how they will be aggregated. 0: the direction from the edges start node to its end node 1: the direction from the edges end node to its start node 2: both directions. The statistics value in this case is an already aggregated value for both directions. Usually either the directions 0 and 1 or direction 2 are available for an edge statistics group. any: all/any available direction(s). Depending on the service all directions that are available (0, 1, or 2) will be considered in the computation or will be returned in the request. sum: values for both direction (0 and 1) will be added. Only available if directions 0 and 1 are available. mean: the average of the values for both direction (0 and 1) will be used. Only available if directions 0 and 1 are available.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY
DIR0
DIR1
DIR2
MEAN
SUM

Method Summary

Modifier and Type	Method	Description
static EdgeStatisticDirection	fromString(String type)
boolean	isAggregation()
String	toString()
static EdgeStatisticDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EdgeStatisticDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DIR0

public static final EdgeStatisticDirection DIR0

DIR1

public static final EdgeStatisticDirection DIR1

DIR2

public static final EdgeStatisticDirection DIR2

ANY

public static final EdgeStatisticDirection ANY

SUM

public static final EdgeStatisticDirection SUM

MEAN

public static final EdgeStatisticDirection MEAN

Method Details

values

public static EdgeStatisticDirection[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EdgeStatisticDirection valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isAggregation

public boolean isAggregation()

fromString

public static EdgeStatisticDirection fromString(String type)

toString

public String toString()

Overrides:

toString in class Enum<EdgeStatisticDirection>