simpleorm.dataset

Class SFieldString

java.lang.Object

simpleorm.dataset.SFieldMeta

simpleorm.dataset.SFieldScalar

simpleorm.dataset.SFieldString

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

LocaleField, StringField

public class SFieldString
extends SFieldScalar

Represents String field meta data.

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 and Description
SFieldString(SRecordMeta<?> meta, java.lang.String columnName, int maxSize, SFieldFlags... pvals) maxSize is the maximum size in bytes (not characters) of the column.

Method Summary

Modifier and Type	Method and Description
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.
boolean	isFKeyCompatible(SFieldScalar field) Check if two fields can be used on both sides of a foreign key relation (same type, length, ...)
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.

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, writeFieldValue

Methods inherited from class java.lang.Object

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

Constructor Detail

SFieldString

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

maxSize is the maximum size in bytes (not characters) of the column. This fairly meaningless number is required for all database DDL except PostgreSQL, for which it is ignored.

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.

Specified by:

queryFieldValue in class SFieldMeta

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.

Specified by:

convertToDataSetFieldType in class SFieldMeta

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.

Specified by:

defaultSqlDataType in class SFieldScalar

isFKeyCompatible

public boolean isFKeyCompatible(SFieldScalar field)

Description copied from class: SFieldScalar

Check if two fields can be used on both sides of a foreign key relation (same type, length, ...)

javaSqlType

public int javaSqlType()

Specified by:

javaSqlType in class SFieldScalar

Returns:

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