com.inductiveautomation.ignition.gateway.localdb.persistence

Class EncodedStringField

java.lang.Object

simpleorm.dataset.SFieldMeta

simpleorm.dataset.SFieldScalar

simpleorm.dataset.SFieldString

com.inductiveautomation.ignition.gateway.localdb.persistence.StringField

com.inductiveautomation.ignition.gateway.localdb.persistence.EncodedStringField

All Implemented Interfaces:

java.io.Serializable

public class EncodedStringField
extends StringField

Created by carl.gould on 8/27/2014.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncodedStringField.ConvertStringToEncodedSchemaFeature

Field Summary

Fields inherited from class simpleorm.dataset.SFieldScalar

sqlDataTypeOverride, theGenerator

Fields inherited from class simpleorm.dataset.SFieldMeta

quoteName

Constructor Summary

Constructors

Constructor and Description
EncodedStringField(SRecordMeta<?> meta, java.lang.String columnName, int maxValue, SFieldFlags... pvals)
EncodedStringField(SRecordMeta<?> meta, java.lang.String columnName, SFieldFlags... pvals)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	queryFieldValue(java.sql.ResultSet rs, int sqlIndex) Issues a JDBC get*() on the result set for the field and converts the database type to the appropriate internal type, eg, Double for a double field.
EncodedStringField	setDefault(java.lang.String value)
EncodedStringField	setDefaultSupplier(java.util.function.Supplier<java.lang.String> supplier)
java.lang.Object	writeFieldValue(java.lang.Object value) Converts a single value from internal representation to database representation.

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

addValidator, getDefault, getFormMeta, setIndexed, setMultiLine, setShort, setUnique, setWide, setWidth

Methods inherited from class simpleorm.dataset.SFieldString

convertToDataSetFieldType, defaultSqlDataType, isFKeyCompatible, javaSqlType

Methods inherited from class simpleorm.dataset.SFieldScalar

getColumnName, getGeneratorMode, getGeneratorParameter, getMaxSize, getReferences, getTheGenerator, isForeignKey, isGenerated, isMandatory, isNotOptimisticLocked, isPrimary, overrideSqlDataType, setGeneratorMode, setMaxSize, setTheGenerator, toLongerString

Methods inherited from class simpleorm.dataset.SFieldMeta

addFlag, addValidator, doValidate, equals, getFieldName, getFlags, getRecordMeta, getUserProperties, getUserProperty, getValidators, hashCode, isDescriptive, isUnqueried, nextGeneratedValue, putUserProperty, readResolve, setQuoted, toString, writeFieldValue

Methods inherited from class java.lang.Object

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

Constructor Detail

EncodedStringField

public EncodedStringField(SRecordMeta<?> meta,
                          java.lang.String columnName,
                          SFieldFlags... pvals)

EncodedStringField

public EncodedStringField(SRecordMeta<?> meta,
                          java.lang.String columnName,
                          int maxValue,
                          SFieldFlags... pvals)

Method Detail

queryFieldValue

public java.lang.Object queryFieldValue(java.sql.ResultSet rs,
                                        int sqlIndex)
                                 throws java.lang.Exception

Description copied from class: SFieldMeta

Issues a JDBC get*() on the result set for the field and converts the database type to the appropriate internal type, eg, Double for a double field. The first column has sqlIndex==1.

Overrides:

queryFieldValue in class SFieldString

Throws:

java.lang.Exception

writeFieldValue

public java.lang.Object writeFieldValue(java.lang.Object value)

Description copied from class: SFieldMeta

Converts a single value from internal representation to database representation. Used primarily by the writeFieldValue above, but also used for converting optimistic lock values in SRecordInstance.flush.

Overidden by SFieldBoolean. (not by SFieldString).

NOTE: This does NOT need to handle NULL values (those are handled seperately by SRecordInstance)

Overrides:

writeFieldValue in class SFieldMeta

setDefault

public EncodedStringField setDefault(java.lang.String value)

Overrides:

setDefault in class StringField

setDefaultSupplier

public EncodedStringField setDefaultSupplier(java.util.function.Supplier<java.lang.String> supplier)

Overrides:

setDefaultSupplier in class StringField