Package com.targomo.client.api.enums

Enum Class MultiGraphAggregationType

java.lang.Object

java.lang.Enum<MultiGraphAggregationType>

com.targomo.client.api.enums.MultiGraphAggregationType

All Implemented Interfaces:

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

public enum MultiGraphAggregationType
extends Enum<MultiGraphAggregationType>

The currently implemented aggregations that are supported by the multi graph request.

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
COUNT
GRAVITATION_HUFF
GRAVITATION_HUFF_OPTIMIZED	the following two aggregations can only be used as main aggregation with no other aggregations in the pipeline - needs to be enabled for the endpoint
GRAVITATION_HUFF_OPTIMIZED_HEATMAP
LOGIT
LOGIT_OPTIMIZED
LOGIT_OPTIMIZED_HEATMAP
MATH
MAXIMUM
MEAN
MEDIAN
MINIMUM
NEAREST
NEAREST_ROUTING_UNION
NONE
ONE
ROUTING_UNION
SUM

Method Summary

Modifier and Type	Method	Description
static MultiGraphAggregationType	fromString(String key)
String	getKey()
boolean	isAggregationInRouting()
boolean	isOptimizedProbabilityAggregation()
boolean	isOptimizedProbabilityAggregationForHeatmap()
boolean	mayIgnoreOutliers()
boolean	requiresGravitationParameters()
static MultiGraphAggregationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MultiGraphAggregationType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final MultiGraphAggregationType NONE

ONE

public static final MultiGraphAggregationType ONE

MINIMUM

public static final MultiGraphAggregationType MINIMUM

MAXIMUM

public static final MultiGraphAggregationType MAXIMUM

SUM

public static final MultiGraphAggregationType SUM

MEAN

public static final MultiGraphAggregationType MEAN

MEDIAN

public static final MultiGraphAggregationType MEDIAN

NEAREST

public static final MultiGraphAggregationType NEAREST

NEAREST_ROUTING_UNION

public static final MultiGraphAggregationType NEAREST_ROUTING_UNION

COUNT

public static final MultiGraphAggregationType COUNT

ROUTING_UNION

public static final MultiGraphAggregationType ROUTING_UNION

MATH

public static final MultiGraphAggregationType MATH

GRAVITATION_HUFF

public static final MultiGraphAggregationType GRAVITATION_HUFF

LOGIT

public static final MultiGraphAggregationType LOGIT

GRAVITATION_HUFF_OPTIMIZED

public static final MultiGraphAggregationType GRAVITATION_HUFF_OPTIMIZED

the following two aggregations can only be used as main aggregation with no other aggregations in the pipeline - needs to be enabled for the endpoint

GRAVITATION_HUFF_OPTIMIZED_HEATMAP

public static final MultiGraphAggregationType GRAVITATION_HUFF_OPTIMIZED_HEATMAP

LOGIT_OPTIMIZED

public static final MultiGraphAggregationType LOGIT_OPTIMIZED

LOGIT_OPTIMIZED_HEATMAP

public static final MultiGraphAggregationType LOGIT_OPTIMIZED_HEATMAP

Method Details

values

public static MultiGraphAggregationType[] 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 MultiGraphAggregationType 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

fromString

public static MultiGraphAggregationType fromString(String key)

getKey

public String getKey()

isAggregationInRouting

public boolean isAggregationInRouting()

mayIgnoreOutliers

public boolean mayIgnoreOutliers()

requiresGravitationParameters

public boolean requiresGravitationParameters()

isOptimizedProbabilityAggregation

public boolean isOptimizedProbabilityAggregation()

isOptimizedProbabilityAggregationForHeatmap

public boolean isOptimizedProbabilityAggregationForHeatmap()