Package com.inductiveautomation.historian.gateway.api.storage.realtime

Enum Class CollectionMode

java.lang.Object

java.lang.Enum<CollectionMode>

com.inductiveautomation.historian.gateway.api.storage.realtime.CollectionMode

All Implemented Interfaces:

Serializable, Comparable<CollectionMode>, Constable

public enum CollectionMode
extends Enum<CollectionMode>

Enum representing the collection mode of the DataCollector.

See Also:

• DataCollector

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
MANUAL	In this mode, data processing is initiated by manual calls to the DataCollector.executeDataCollection(com.inductiveautomation.historian.gateway.api.storage.realtime.CollectionContext) method.
STREAMING	In this mode, data is processed and stored in near real-time, independent of DataCollector.executeDataCollection(com.inductiveautomation.historian.gateway.api.storage.realtime.CollectionContext) being called.

Method Summary

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

STREAMING

public static final CollectionMode STREAMING

In this mode, data is processed and stored in near real-time, independent of DataCollector.executeDataCollection(com.inductiveautomation.historian.gateway.api.storage.realtime.CollectionContext) being called. It may use techniques like debouncing or setting a maximum wait time to allow for efficient grouping of data. Doing a collection in this mode might trigger immediate processing of any pending data and perform consistency checks.

MANUAL

public static final CollectionMode MANUAL

In this mode, data processing is initiated by manual calls to the DataCollector.executeDataCollection(com.inductiveautomation.historian.gateway.api.storage.realtime.CollectionContext) method. Between these calls, incoming data is queued internally. Each collection triggers the processing and storage of all data accumulated since the previous call. This mode provides flexibility in controlling when data is processed, allowing for on-demand collection or custom scheduling.

Method Details

values

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