manifold.sql.rt.api

Interface ValueAccessor

All Known Implementing Classes:

ArrayValueAccessor, BigIntValueAccessor, BinaryValueAccessor, BitValueAccessor, BlobValueAccessor, BooleanValueAccessor, CharValueAccessor, ClobValueAccessor, DataLinkValueAccessor, DateValueAccessor, DecimalValueAccessor, DistinctValueAccessor, DoubleValueAccessor, FloatValueAccessor, IntegerValueAccessor, JavaObjectValueAccessor, LongNvarcharValueAccessor, LongVarBinaryValueAccessor, LongVarcharValueAccessor, NcharValueAccessor, NclobValueAccessor, NumericValueAccessor, NvarcharValueAccessor, Oracle_IntervalDsValueAccessor, Oracle_IntervalYmValueAccessor, Oracle_TimestampLtzValueAccessor, Oracle_TimestampTzValueAccessor, OtherValueAccessor, RealValueAccessor, RowIdValueAccessor, SmallIntValueAccessor, SqlXmlValueAccessor, TimestampValueAccessor, TimestampWithTimeZoneValueAccessor, TimeValueAccessor, TimeWithTimeZoneValueAccessor, TinyIntValueAccessor, VarBinaryValueAccessor, VarcharValueAccessor

public interface ValueAccessor

The value returned from getJdbcType() indicates the JDBC type handled by the implementation. Manifold provides default implementations that are suitable for most use-cases.

This interface performs the following:
- resolves the Java type corresponding with the JDBC type from Types
- sets query parameter values
- gets query result values

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOGGER

Method Summary

Modifier and Type	Method and Description
default java.lang.Class<?>	getClassForColumnClassName(java.lang.String className, java.lang.Class<?> defaultClass) Use column class name
java.lang.Class<?>	getJavaType(BaseElement elem)
int	getJdbcType()
default java.lang.String	getParameterExpression(java.sql.DatabaseMetaData metaData, java.lang.Object value, ColumnInfo ci) Supply a parameter expression.
java.lang.Object	getRowValue(java.sql.ResultSet rs, BaseElement elem) Returns a query result value corresponding with a elem from rs.
void	setParameter(java.sql.PreparedStatement ps, int pos, java.lang.Object value) Sets the query parameter value corresponding with pos.

Field Detail

LOGGER

static final org.slf4j.Logger LOGGER

Method Detail

getJdbcType

int getJdbcType()

Returns:

The Types id this accessor handles.

getJavaType

java.lang.Class<?> getJavaType(BaseElement elem)

Returns:

The resulting type of the value in Java code. Note this type may not correspond with SQL-to-Java type mappings from the JDBC specification. For instance, although java.sql.Types#CLOB maps to java.sql.CLOB (appendix table B.3 from the JDBC 4.2 specification) the actual type generated for CLOB is String.

getRowValue

java.lang.Object getRowValue(java.sql.ResultSet rs,
                             BaseElement elem)
                      throws java.sql.SQLException

Returns a query result value corresponding with a elem from rs.

Parameters:

rs - The result set containing rows of column values

elem - The query column from which to find a value

Returns:

The value corresponding with elem. Note, the type of the value must match the Java type returned from elem.getType().

Throws:

java.sql.SQLException

setParameter

void setParameter(java.sql.PreparedStatement ps,
                  int pos,
                  java.lang.Object value)
           throws java.sql.SQLException

Sets the query parameter value corresponding with pos.

Parameters:

ps - The prepared statement containing the parameterized query.

pos - The index of the parameter, beginning with 1.

value - The value of the parameter

Throws:

java.sql.SQLException

getParameterExpression

default java.lang.String getParameterExpression(java.sql.DatabaseMetaData metaData,
                                                java.lang.Object value,
                                                ColumnInfo ci)

Supply a parameter expression. Normally, this is just ?, however some JDBC drivers and database systems require explicit casts when using certain data types. For instance, Postgres requires casts for several types e.g., Boolean to bit; there is no other way to get a value from Java into a Postgres bit column.

getClassForColumnClassName

default java.lang.Class<?> getClassForColumnClassName(java.lang.String className,
                                                      java.lang.Class<?> defaultClass)

Use column class name