Package com.inductiveautomation.ignition.gateway.sqltags.config

Class TagHistoryProviderType

java.lang.Object

com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

com.inductiveautomation.ignition.gateway.sqltags.config.TagHistoryProviderType

All Implemented Interfaces:

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

Direct Known Subclasses:

StandardTagHistorianProviderType

public abstract class TagHistoryProviderType
extends BaseExtensionPointType

Extension point for a tag history provider. Tag history providers can be used to read tag history, or potentially store it.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

description, name, typeId

Constructor Summary

Constructors

Constructor	Description
TagHistoryProviderType(java.lang.String typeId, java.lang.String name, java.lang.String description)

Method Summary

Modifier and Type	Method	Description
abstract TagHistoryProvider	createHistoryProvider(TagHistoryProviderRecord profile, GatewayContext context)	Create a new HistoryProvider given the persistent record(s) that defines its properties
java.util.Optional<java.util.Collection<Property<?>>>	getStorageTagExtensionProperties()
java.util.Optional<java.util.Collection<Property<?>>>	getStorageTagGroupExtensionProperties()
boolean	isEnabled()	A flag that indicates whether this type is currently enabled (true) or deprecated (false).
boolean	isSystemManaged()	If true, indicates that the user cannot add or delete these types of providers.
abstract boolean	supportsStorage()

Methods inherited from class com.inductiveautomation.ignition.gateway.model.BaseExtensionPointType

addRecordInstanceActions, compareTo, findProfileSettingsRecord, getDescription, getName, getSettingsRecordForeignKey, getTypeId, newRecordConfigPanel, onRecordDestroyed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointType

getSettingsRecordType

Constructor Detail

TagHistoryProviderType

public TagHistoryProviderType(java.lang.String typeId,
                              java.lang.String name,
                              java.lang.String description)

Method Detail

isSystemManaged

public boolean isSystemManaged()

If true, indicates that the user cannot add or delete these types of providers.

isEnabled

public boolean isEnabled()

Description copied from interface: ExtensionPointType

A flag that indicates whether this type is currently enabled (true) or deprecated (false). Useful for when you want to discontinue the use of a profile, but it needs to stick around for backwards-compatibility purposes. A false value will prevent users from making new instances of this type.

Specified by:

isEnabled in interface ExtensionPointType

Overrides:

isEnabled in class BaseExtensionPointType

createHistoryProvider

public abstract TagHistoryProvider createHistoryProvider(TagHistoryProviderRecord profile,
                                                         GatewayContext context)
                                                  throws java.lang.Exception

Create a new HistoryProvider given the persistent record(s) that defines its properties

Parameters:

profile - The record that defines this sqltag provider profile. Provider types should be able to use this record to look up their provider-specific settings object via the PersistenceInterface

Throws:

java.lang.Exception

supportsStorage

public abstract boolean supportsStorage()

getStorageTagGroupExtensionProperties

public java.util.Optional<java.util.Collection<Property<?>>> getStorageTagGroupExtensionProperties()

getStorageTagExtensionProperties

public java.util.Optional<java.util.Collection<Property<?>>> getStorageTagExtensionProperties()