com.inductiveautomation.gateway.tags.history.config

Class TagHistorianSettingsRecord

java.lang.Object

simpleorm.dataset.SRecordInstance

com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

com.inductiveautomation.gateway.tags.history.config.TagHistorianSettingsRecord

All Implemented Interfaces:

java.io.Serializable

public class TagHistorianSettingsRecord
extends PersistentRecord

This is the settings record for our internal, system-managed, datasource based TagHistoryProviders. Note: there is a bit of refactor confusion here- this was originally supposed to be the master record for the SQLTagHistoryProvider extension point. However, since all of the datasource based settings were present on it, we had to create a new master record type when actually implementing the extension point. Thus, this record has a table name that doesn't match its class name. The real master record is in GatewayAPI.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class simpleorm.dataset.SRecordInstance

SRecordInstance.BrokenOptimisticLockException

Field Summary

Fields

Modifier and Type	Field and Description
static RecordMeta<TagHistorianSettingsRecord>	META
static BooleanField	OptimizedPartitionsEnabled
static IntField	OptimizedWindowSizeSec
static BooleanField	PartitioningEnabled
static IntField	PartitionSize
static EnumField<TimeUnits>	PartitionSizeUnits
static ReferenceField<SQLTagHistoryProviderRecord>	Profile
static LongField	ProfileId
static IntField	PruneAge
static EnumField<TimeUnits>	PruneAgeUnits
static BooleanField	PruningEnabled
static IntField	StaleMultiplier
static BooleanField	TrackSCE

Fields inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

DEFAULT_VALUE, FORM_META_KEY, INDEXED, UNIQUE

Constructor Summary

Constructors

Constructor and Description
TagHistorianSettingsRecord()

Method Summary

Modifier and Type	Method and Description
RecordMeta<?>	getMeta() This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance.
int	getPartitionSize()
TimeUnits	getPartitionSizeUnits()
int	getProcessingWindowSeconds()
int	getPruneAge()
TimeUnits	getPruneAgeUnits()
int	getStaleMultiplier()
boolean	isPartitioningEnabled()
boolean	isProcessingEnabled()
boolean	isPruningEnabled()
boolean	isTrackSCEEnabled()
void	setFrom(LegacySettingsRecord legacy)

Methods inherited from class com.inductiveautomation.ignition.gateway.localdb.persistence.PersistentRecord

getBoolean, getDoubleObj, getIntObj, getLongObj, getString, installDefaultValues

Methods inherited from class simpleorm.dataset.SRecordInstance

allFields, assertNewRow, assertNotNewRow, defineInitialValue, deleteRecord, doQueryRecord, doValidateRecord, equals, findReference, findReference, findReference, findReference, getBigDecimal, getBytes, getDataSet, getDate, getDouble, getEnum, getInitialValue, getInt, getLogger, getLong, getObject, getRawArrayValue, getReferenceNoQuery, getTime, getTimestamp, hashCode, isAttached, isDeleted, isDirty, isDirty, isEmpty, isNewRow, isNotDestroyed, isNull, isReadOnly, isValid, onQueryRecord, onValidateField, onValidateRecord, setBigDecimal, setBoolean, setBytes, setDate, setDirty, setDouble, setEmpty, setEnum, setInt, setLong, setNewRow, setNull, setObject, setObject, setRawArrayValue, setReadOnly, setReference, setString, setTime, setTimestamp, toString, validatePrimaryKeys, wasInCache

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

META

public static final RecordMeta<TagHistorianSettingsRecord> META

ProfileId

public static final LongField ProfileId

Profile

public static final ReferenceField<SQLTagHistoryProviderRecord> Profile

PartitioningEnabled

public static final BooleanField PartitioningEnabled

PartitionSize

public static final IntField PartitionSize

PartitionSizeUnits

public static final EnumField<TimeUnits> PartitionSizeUnits

OptimizedPartitionsEnabled

public static final BooleanField OptimizedPartitionsEnabled

OptimizedWindowSizeSec

public static final IntField OptimizedWindowSizeSec

PruningEnabled

public static final BooleanField PruningEnabled

PruneAge

public static final IntField PruneAge

PruneAgeUnits

public static final EnumField<TimeUnits> PruneAgeUnits

TrackSCE

public static final BooleanField TrackSCE

StaleMultiplier

public static final IntField StaleMultiplier

Constructor Detail

TagHistorianSettingsRecord

public TagHistorianSettingsRecord()

Method Detail

getMeta

public RecordMeta<?> getMeta()

Description copied from class: SRecordInstance

This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance. It is normally defined as:-

 SRecord getMeta() {
        return meta;
 };
 

The actual meta variable is thus not Serialized, but it would not be anyway as it is usually static.

Specified by:

getMeta in class PersistentRecord

isPartitioningEnabled

public boolean isPartitioningEnabled()

getPartitionSize

public int getPartitionSize()

getPartitionSizeUnits

public TimeUnits getPartitionSizeUnits()

isProcessingEnabled

public boolean isProcessingEnabled()

getProcessingWindowSeconds

public int getProcessingWindowSeconds()

isPruningEnabled

public boolean isPruningEnabled()

getPruneAge

public int getPruneAge()

getPruneAgeUnits

public TimeUnits getPruneAgeUnits()

getStaleMultiplier

public int getStaleMultiplier()

isTrackSCEEnabled

public boolean isTrackSCEEnabled()

setFrom

public void setFrom(LegacySettingsRecord legacy)