Package org.apache.ofbiz.entity.jdbc

Class JdbcValueHandler<T>

java.lang.Object

org.apache.ofbiz.entity.jdbc.JdbcValueHandler<T>

Direct Known Subclasses:

JdbcValueHandler.ArrayJdbcValueHandler, JdbcValueHandler.BigDecimalJdbcValueHandler, JdbcValueHandler.BlobJdbcValueHandler, JdbcValueHandler.BooleanJdbcValueHandler, JdbcValueHandler.ByteArrayJdbcValueHandler, JdbcValueHandler.ClobJdbcValueHandler, JdbcValueHandler.DateJdbcValueHandler, JdbcValueHandler.DoubleJdbcValueHandler, JdbcValueHandler.FloatJdbcValueHandler, JdbcValueHandler.IntegerJdbcValueHandler, JdbcValueHandler.LongJdbcValueHandler, JdbcValueHandler.ObjectJdbcValueHandler, JdbcValueHandler.RowIdJdbcValueHandler, JdbcValueHandler.ShortJdbcValueHandler, JdbcValueHandler.StringJdbcValueHandler, JdbcValueHandler.TimeJdbcValueHandler, JdbcValueHandler.TimestampJdbcValueHandler

public abstract class JdbcValueHandler<T>
extends Object

An object that handles getting/setting column values in JDBC PreparedStatement and ResultSet objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JdbcValueHandler.ArrayJdbcValueHandler	A java.sql.Array JDBC value handler.
protected static class	JdbcValueHandler.BigDecimalJdbcValueHandler	A java.math.BigDecimal JDBC value handler.
protected static class	JdbcValueHandler.BlobJdbcValueHandler	A java.sql.Blob JDBC value handler.
protected static class	JdbcValueHandler.BooleanJdbcValueHandler	A java.lang.Boolean JDBC value handler.
protected static class	JdbcValueHandler.ByteArrayJdbcValueHandler	A byte[] JDBC value handler.
protected static class	JdbcValueHandler.ClobJdbcValueHandler	A java.sql.Clob JDBC value handler.
protected static class	JdbcValueHandler.DateJdbcValueHandler	A java.sql.Date JDBC value handler.
protected static class	JdbcValueHandler.DoubleJdbcValueHandler	A java.lang.Double JDBC value handler.
protected static class	JdbcValueHandler.FloatJdbcValueHandler	A java.lang.Float JDBC value handler.
protected static class	JdbcValueHandler.IntegerJdbcValueHandler	A java.lang.Integer JDBC value handler.
protected static class	JdbcValueHandler.LongJdbcValueHandler	A java.lang.Long JDBC value handler.
protected static class	JdbcValueHandler.ObjectJdbcValueHandler	A java.lang.Object JDBC value handler.
protected static class	JdbcValueHandler.RowIdJdbcValueHandler	A java.sql.RowId JDBC value handler.
protected static class	JdbcValueHandler.ShortJdbcValueHandler	A java.lang.Short JDBC value handler.
protected static class	JdbcValueHandler.StringJdbcValueHandler	A java.lang.String JDBC value handler.
protected static class	JdbcValueHandler.TimeJdbcValueHandler	A java.sql.Time JDBC value handler.
protected static class	JdbcValueHandler.TimestampJdbcValueHandler	A java.sql.Timestamp JDBC value handler.

Field Summary

Fields

Modifier and Type	Field	Description
static String	module

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JdbcValueHandler(int sqlType)

Method Summary

Modifier and Type	Method	Description
protected abstract void	castAndSetValue(PreparedStatement ps, int parameterIndex, T obj)	Sets a value in a PreparedStatement.
protected JdbcValueHandler<T>	create(int sqlType)
static JdbcValueHandler<?>	getInstance(String javaType, String sqlType)	Returns the JdbcValueHandler that corresponds to a field type.
abstract Class<T>	getJavaClass()
int	getSqlType()	Returns the SQL type for this handler.
abstract T	getValue(ResultSet rs, int columnIndex)	Returns a value from a ResultSet.
protected abstract JdbcValueHandler<T>	newInstance(int sqlType)	Returns a new instance of the object - initialized with the specified SQL type.
protected static String	parseSqlType(String sqlType)
protected static byte[]	serializeObject(Object obj)
void	setValue(PreparedStatement ps, int parameterIndex, T obj)	Sets a value in a PreparedStatement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

module

public static final String module

Constructor Detail

JdbcValueHandler

protected JdbcValueHandler(int sqlType)

Method Detail

getInstance

public static JdbcValueHandler<?> getInstance(String javaType,
                                              String sqlType)

Returns the JdbcValueHandler that corresponds to a field type.

Parameters:

javaType - The Java type specified in fieldtype*.xml

sqlType - The SQL type specified in fieldtype*.xml

Returns:

A JdbcValueHandler instance

parseSqlType

protected static String parseSqlType(String sqlType)

serializeObject

protected static byte[] serializeObject(Object obj)
                                 throws SQLException

Throws:

SQLException

castAndSetValue

protected abstract void castAndSetValue(PreparedStatement ps,
                                        int parameterIndex,
                                        T obj)
                                 throws SQLException

Sets a value in a PreparedStatement. The obj argument is converted to the correct data type. Subclasses override this method to cast obj to the correct data type and call the appropriate PreparedStatement.setXxx method.

Parameters:

ps -

parameterIndex -

obj -

Throws:

SQLException

create

protected JdbcValueHandler<T> create(int sqlType)

getSqlType

public int getSqlType()

Returns the SQL type for this handler.

Returns:

return the SQL type

See Also:

java.sql.Types

getValue

public abstract T getValue(ResultSet rs,
                           int columnIndex)
                    throws SQLException

Returns a value from a ResultSet. The returned object is converted to the Java data type specified in the fieldtype file.

Parameters:

rs - the ResultSet object

columnIndex - the column index

Returns:

get value from result set

Throws:

SQLException

newInstance

protected abstract JdbcValueHandler<T> newInstance(int sqlType)

Returns a new instance of the object - initialized with the specified SQL type.

Parameters:

sqlType - the sql type

Returns:

returns a new instance

getJavaClass

public abstract Class<T> getJavaClass()

setValue

public void setValue(PreparedStatement ps,
                     int parameterIndex,
                     T obj)
              throws SQLException

Sets a value in a PreparedStatement. The obj argument is converted to the correct data type.

Parameters:

ps -

parameterIndex -

obj -

Throws:

SQLException