com.j256.ormlite.field.types
Class SerializableType

java.lang.Object
  extended by com.j256.ormlite.field.types.BaseDataType
      extended by com.j256.ormlite.field.types.SerializableType
All Implemented Interfaces:
DataPersister, FieldConverter

public class SerializableType
extends BaseDataType

Persists an unknown Java Object that is Serializable.

Author:
graywatson

Method Summary
static SerializableType getSingleton()
           
 boolean isAppropriateId()
          Return true if this data type can be an id column in a class.
 boolean isComparable()
          Return true if this data type be compared in SQL statements.
 boolean isSelectArgRequired()
          Must use SelectArg when querying for values of this type.
 boolean isStreamType()
          Return whether or not this is a SQL "stream" object.
 boolean isValidForField(Field field)
          Return true if the field is appropriate for this persister.
 Object javaToSqlArg(FieldType fieldType, Object obj)
          Convert a Java object and return the appropriate argument to a SQL insert or update statement.
 Object parseDefaultString(FieldType fieldType, String defaultStr)
          Convert a default string object and return the appropriate argument to a SQL insert or update statement.
 Object resultToJava(FieldType fieldType, DatabaseResults results, int columnPos)
          Return the object extracted from the results associated with column in position columnPos.
 Object sqlArgToJava(FieldType fieldType, Object sqlArg, int columnPos)
          Return the object converted from the SQL arg to java.
 
Methods inherited from class com.j256.ormlite.field.types.BaseDataType
convertIdNumber, dataIsEqual, generateId, getAssociatedClasses, getDefaultWidth, getSqlType, isEscapedDefaultValue, isEscapedValue, isPrimitive, isSelfGeneratedId, isValidForVersion, isValidGeneratedType, makeConfigObject, moveToNextValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getSingleton

public static SerializableType getSingleton()

parseDefaultString

public Object parseDefaultString(FieldType fieldType,
                                 String defaultStr)
                          throws SQLException
Description copied from interface: FieldConverter
Convert a default string object and return the appropriate argument to a SQL insert or update statement.

Specified by:
parseDefaultString in interface FieldConverter
Specified by:
parseDefaultString in class BaseDataType
Throws:
SQLException

resultToJava

public Object resultToJava(FieldType fieldType,
                           DatabaseResults results,
                           int columnPos)
                    throws SQLException
Description copied from interface: FieldConverter
Return the object extracted from the results associated with column in position columnPos.

Specified by:
resultToJava in interface FieldConverter
Specified by:
resultToJava in class BaseDataType
Parameters:
fieldType - Associated FieldType which may be null.
Throws:
SQLException - If there is a problem accessing the results data.

sqlArgToJava

public Object sqlArgToJava(FieldType fieldType,
                           Object sqlArg,
                           int columnPos)
                    throws SQLException
Description copied from interface: FieldConverter
Return the object converted from the SQL arg to java.

Specified by:
sqlArgToJava in interface FieldConverter
Overrides:
sqlArgToJava in class BaseDataType
Parameters:
fieldType - Associated FieldType which may be null.
Throws:
SQLException

javaToSqlArg

public Object javaToSqlArg(FieldType fieldType,
                           Object obj)
                    throws SQLException
Description copied from interface: FieldConverter
Convert a Java object and return the appropriate argument to a SQL insert or update statement.

Specified by:
javaToSqlArg in interface FieldConverter
Overrides:
javaToSqlArg in class BaseDataType
Throws:
SQLException

isValidForField

public boolean isValidForField(Field field)
Description copied from interface: DataPersister
Return true if the field is appropriate for this persister.

Specified by:
isValidForField in interface DataPersister
Specified by:
isValidForField in class BaseDataType

isStreamType

public boolean isStreamType()
Description copied from interface: FieldConverter
Return whether or not this is a SQL "stream" object. Cannot get certain stream objects from the SQL results more than once. If true, the converter has to protect itself against null values.

Specified by:
isStreamType in interface FieldConverter
Overrides:
isStreamType in class BaseDataType

isComparable

public boolean isComparable()
Description copied from interface: DataPersister
Return true if this data type be compared in SQL statements.

Specified by:
isComparable in interface DataPersister
Overrides:
isComparable in class BaseDataType

isAppropriateId

public boolean isAppropriateId()
Description copied from interface: DataPersister
Return true if this data type can be an id column in a class.

Specified by:
isAppropriateId in interface DataPersister
Overrides:
isAppropriateId in class BaseDataType

isSelectArgRequired

public boolean isSelectArgRequired()
Description copied from interface: DataPersister
Must use SelectArg when querying for values of this type.

Specified by:
isSelectArgRequired in interface DataPersister
Overrides:
isSelectArgRequired in class BaseDataType


This content is licensed by Gray Watson under the Creative Commons Attribution-Share Alike 3.0 License.