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

This interface performs the following:
- provides Java types to be used for JDBC columns and parameters in Manifold's schema and SQL APIs - sets query parameter values to JDBC
- gets query result values from JDBC

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) Provides the Java type to be used for JDBC columns and parameters in the Manifold SQL APIs.
int	getJdbcType() Indicates the JDBC type handled by this implementation.
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 an elem from result set, 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()

Indicates the JDBC type handled by this implementation.

Returns:

The Types id this accessor handles. This type must be unique among other ValueAccessor instances returned from ValueAccessorProvider.get(int).

getJavaType

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

Provides the Java type to be used for JDBC columns and parameters in the Manifold SQL APIs.

Parameters:

elem - A schema column, query column, parameter, or other value bearing element.

Returns:

The Java type to use for elem in the Manifold SQL APIs.

getRowValue

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

Returns a query result value corresponding with an elem from result set, rs.

Parameters:

rs - The result set containing rows of column values

elem - The query column containing the value

Returns:

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

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