Package com.inductiveautomation.ignition.gateway.localdb.persistence

Class PersistentRecord

java.lang.Object

simpleorm.dataset.SRecordInstance

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ADAuthProperties, ADHybridProperties, ADtoDBHybridAuthProperties, AlarmNotificationProfileRecord, AlertNotificationProfileRecord, AlertStorageProfileRecord, AuditProfileRecord, BasicScheduleRecord, CompositeScheduleRecord, DatasourceRecord, DBAuthProperties, DBTranslatorRecord, EdgeSystemPropertiesRecord, EmailProfileSettingsRecord, GatewayTaskRecord, HolidayRecord, HomepagePanelSettingsRecord, ImageRecord, IncomingConnection, InternalAuthProperties, InternalContactInfoRecord, InternalRoleRecord, InternalScheduleAdjustmentRecord, InternalUserExtraPropsRecord, InternalUserRecord, InternalUserRoleMapping, JDBCDriverRecord, MetricsDashboardRecord, OPCServerSettingsRecord, ProjectChangeRecord, ProjectRecord, ProjectResourceRecord, ProxyRulesRecord, QueueOverrideSettings, ScheduleProfileRecord, ScheduleRecord, SmtpSettings, SQLTagProviderRecord, StoreAndForwardConfigRecord, SystemPropertiesRecord, TagHistoryProviderRecord, TagProviderSettingsRecord, TaskStatusEventRecord, UserSourceProfileRecord, WSChannelSettings, WSConnectionSettings

public abstract class PersistentRecord
extends SRecordInstance

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	Description
static final Object	DEFAULT_VALUE	Key value for our "default value" extension to the SimpleORM api
static final Object	FORM_META_KEY	Key for the field meta object
static final Object	INDEXED	Key value for our "indexed" extension to the SimpleORM api
static final Object	UNIQUE	Key value for our "unique" extension to the SimpleORM api

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PersistentRecord()

Method Summary

Modifier and Type	Method	Description
boolean	getBoolean(SFieldMeta field)	Overridden in order to work around the fact that the base doesn't work well, expects them to be exactly Boolean.TRUE or Boolean.FALSE (like, the actual objects).
Double	getDoubleObj(SFieldMeta field)	Provides a null-safe alternative to getDouble(), which returns zero if the field was null.
Integer	getIntObj(SFieldMeta field)	Provides a null-safe alternative to getInt(), which returns zero if the field was null.
Long	getLongObj(SFieldMeta field)	Provides a null-safe alternative to getLong(), which returns zero if the field was null.
abstract RecordMeta<?>	getMeta()	This must be defined in every user record's definition to access the SRecord which provides the meta data for this instance.
String	getString(SFieldMeta field)	Returns the field as a string, or null if the field was null.
void	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 Details

DEFAULT_VALUE

public static final Object DEFAULT_VALUE

Key value for our "default value" extension to the SimpleORM api

INDEXED

public static final Object INDEXED

Key value for our "indexed" extension to the SimpleORM api

UNIQUE

public static final Object UNIQUE

Key value for our "unique" extension to the SimpleORM api

FORM_META_KEY

public static final Object FORM_META_KEY

Key for the field meta object

Constructor Details

PersistentRecord

protected PersistentRecord()

Method Details

installDefaultValues

public void installDefaultValues()

getMeta

public abstract 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 SRecordInstance

getString

public String getString(SFieldMeta field)

Returns the field as a string, or null if the field was null. Overridden from SRecordInstance to avoid trimming logic.

Overrides:

getString in class SRecordInstance

getIntObj

public Integer getIntObj(SFieldMeta field)

Provides a null-safe alternative to getInt(), which returns zero if the field was null.

Parameters:

field - The filed to retrieve

Returns:

The integer value, or null if the field is null.

getLongObj

public Long getLongObj(SFieldMeta field)

Provides a null-safe alternative to getLong(), which returns zero if the field was null.

Parameters:

field - The filed to retrieve

Returns:

The long value, or null if the field is null.

getDoubleObj

public Double getDoubleObj(SFieldMeta field)

Provides a null-safe alternative to getDouble(), which returns zero if the field was null.

Parameters:

field - The filed to retrieve

Returns:

The double value, or null if the field is null.

getBoolean

public boolean getBoolean(SFieldMeta field)

Overridden in order to work around the fact that the base doesn't work well, expects them to be exactly Boolean.TRUE or Boolean.FALSE (like, the actual objects).

Overrides:

getBoolean in class SRecordInstance