com.goldencode.p2j.persist.orm

Interface ParameterSetter

All Known Subinterfaces:

DataHandler

All Known Implementing Classes:

BlobType, CharacterType, ClobType, ComhandleType, DatetimeType, DatetimetzType, DateType, DecimalType, HandleType, Int64Type, IntegerType, LogicalType, NumericType, ObjectType, RawType, RecidType, RowidType

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ParameterSetter

This functional interface exposes a method for setting a parameter in a prepared query. If needed, the value is converted first to Java a native value of other type supported by set parameter API of PreparedStatement.

Method Summary

Modifier and Type	Method and Description
int	setParameter(java.sql.PreparedStatement stmt, int index, java.lang.Object val, boolean forUpdate) Converts/extract a value to a type supported by Java SQL toolkit and set it to as the specified parameter in the PreparedStatement.

Method Detail

setParameter

int setParameter(java.sql.PreparedStatement stmt,
                 int index,
                 java.lang.Object val,
                 boolean forUpdate)
          throws java.sql.SQLException

Converts/extract a value to a type supported by Java SQL toolkit and set it to as the specified parameter in the PreparedStatement. For example, if a native integer value is provided, the setInt(int, int x) method should be used.

Parameters:

stmt - The prepared statement whose parameter is to be set.

index - The index/position of the parameter or of the first one, if the property needs multiple consecutive parameters in order to be fully stored to persistence. To see how many positions the property needs, see PropertyMeta.columnCount.

val - The value of the parameter.

forUpdate - true if the parameter in the statement is used to update a field and false if it is used as part of the where predicate.

Returns:

the number of position used by this value.

Throws:

java.sql.SQLException - when an error is encountered while setting the value.