com.j256.ormlite.field
Interface FieldConverter

All Known Implementing Classes:
BaseDatabaseType.BooleanNumberFieldConverter, DataType

public interface FieldConverter

Convert a Java object into the appropriate argument to a SQL statement and then back from the result set to the Java object. This allows databases to configure per-type conversion. This is used by the BaseDatabaseType.getFieldConverter(DataType) method to find the converter for a particular database type. Databases can then override the default data conversion mechanisms as necessary.

Author:
graywatson

Method Summary
 SqlType getSqlType()
          Return the SQL type that is stored in the database for this argument.
 boolean isStreamType()
          Return whether or not this is a SQL "stream" object.
 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.
 

Method Detail

parseDefaultString

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

Throws:
SQLException

javaToSqlArg

Object javaToSqlArg(FieldType fieldType,
                    Object obj)
                    throws SQLException
Convert a Java object and return the appropriate argument to a SQL insert or update statement.

Throws:
SQLException

resultToJava

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

Parameters:
fieldType - Associated FieldType which may be null.
Throws:
SQLException - If there is a problem accessing the results data.

getSqlType

SqlType getSqlType()
Return the SQL type that is stored in the database for this argument.


isStreamType

boolean isStreamType()
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.



Copyright © 2011. All Rights Reserved.