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

Class LocaleField

java.lang.Object

simpleorm.dataset.SFieldMeta

simpleorm.dataset.SFieldScalar

simpleorm.dataset.SFieldString

com.inductiveautomation.ignition.gateway.localdb.persistence.LocaleField

All Implemented Interfaces:

java.io.Serializable

public class LocaleField
extends SFieldString

See Also:

Serialized Form

Field Summary

Fields inherited from class simpleorm.dataset.SFieldScalar

sqlDataTypeOverride, theGenerator

Fields inherited from class simpleorm.dataset.SFieldMeta

quoteName

Constructor Summary

Constructors

Constructor	Description
LocaleField(SRecordMeta meta, java.lang.String fieldName, SFieldFlags... pvals)

Method Summary

Modifier and Type	Method	Description
LocaleField	addValidator(org.apache.wicket.validation.IValidator wicketValidator)
protected java.lang.Object	convertToDataSetFieldType(java.lang.Object raw)	Converts the parameter from the raw type parameter to the correct internal Object type that is stored in the data set.
java.lang.String	defaultSqlDataType()	The default data type if not overriden by overrideSqlDataType.
java.util.Locale	getDefault()
FormMeta	getFormMeta()
boolean	isFKeyCompatible(SFieldScalar field)
int	javaSqlType()
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.
LocaleField	setDefault(java.util.Locale value)
LocaleField	setIndexed(boolean value)
LocaleField	setUnique(boolean value)
java.lang.Object	writeFieldValue(java.lang.Object value)	Converts a single value from internal representation to database representation.

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

LocaleField

public LocaleField(SRecordMeta meta,
                   java.lang.String fieldName,
                   SFieldFlags... pvals)

Method Detail

getFormMeta

public FormMeta getFormMeta()

getDefault

public java.util.Locale getDefault()

setDefault

public LocaleField setDefault(java.util.Locale value)

setIndexed

public LocaleField setIndexed(boolean value)

setUnique

public LocaleField setUnique(boolean value)

addValidator

public LocaleField addValidator(org.apache.wicket.validation.IValidator wicketValidator)

defaultSqlDataType

public java.lang.String defaultSqlDataType()

Description copied from class: SFieldScalar

The default data type if not overriden by overrideSqlDataType. This is only called when the data type is actually needed by CREATE TABLE, ie if no sqlDataTypeOverride is specified.

Overrides:

defaultSqlDataType in class SFieldString

javaSqlType

public int javaSqlType()

Overrides:

javaSqlType in class SFieldString

Returns:

int constant from java.sql.Types, used for setting sql datatype with null values

isFKeyCompatible

public boolean isFKeyCompatible(SFieldScalar field)

Overrides:

isFKeyCompatible in class SFieldString

queryFieldValue

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

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. This uses the LocaleWrapper class to appropriately source the locale.

Overrides:

queryFieldValue in class SFieldString

Returns:

a Locale object or null if the ResultSet has no value at the requested index.

Throws:

java.lang.Exception

convertToDataSetFieldType

protected java.lang.Object convertToDataSetFieldType(java.lang.Object raw)

Description copied from class: SFieldMeta

Converts the parameter from the raw type parameter to the correct internal Object type that is stored in the data set. Returns the object if no conversion necessary. Used by SRecordInstance.setObject etc., Not getObject.

Overrides:

convertToDataSetFieldType in class SFieldString

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