org.hibernate.type

Interface ProcedureParameterExtractionAware<T>

All Superinterfaces:

Serializable, Type

All Known Implementing Classes:

AbstractSingleColumnStandardBasicType, AbstractStandardBasicType, AdaptedImmutableType, BigDecimalType, BigIntegerType, BinaryType, BlobType, BooleanType, ByteType, CalendarDateType, CalendarType, CharacterArrayClobType, CharacterArrayNClobType, CharacterArrayType, CharacterNCharType, CharacterType, CharArrayType, CharBooleanType, ClassType, ClobType, ComponentType, CurrencyType, DateType, DbTimestampType, DoubleType, EmbeddedComponentType, FloatType, ImageType, IntegerType, LocaleType, LongType, MaterializedBlobType, MaterializedClobType, MaterializedNClobType, NClobType, NTextType, NumericBooleanType, PostgresUUIDType, PrimitiveCharacterArrayClobType, PrimitiveCharacterArrayNClobType, SerializableToBlobType, SerializableType, ShortType, StringNVarcharType, StringType, TextType, TimestampType, TimeType, TimeZoneType, TrueFalseType, UrlType, UUIDBinaryType, UUIDCharType, WrappedMaterializedBlobType, WrapperBinaryType, YesNoType

public interface ProcedureParameterExtractionAware<T>
extends Type

Optional Type contract for implementations that are aware of how to extract values from store procedure OUT/INOUT parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDoExtraction() Can the given instance of this type actually perform the parameter value extractions?
T	extract(CallableStatement statement, int startIndex, SessionImplementor session) Perform the extraction
T	extract(CallableStatement statement, String[] paramNames, SessionImplementor session) Perform the extraction

Methods inherited from interface org.hibernate.type.Type

assemble, beforeAssemble, compare, deepCopy, defaultSizes, dictatedSizes, disassemble, fromXMLNode, getColumnSpan, getHashCode, getHashCode, getName, getReturnedClass, getSemiResolvedType, hydrate, isAnyType, isAssociationType, isCollectionType, isComponentType, isDirty, isDirty, isEntityType, isEqual, isEqual, isModified, isMutable, isSame, isXMLElement, nullSafeGet, nullSafeGet, nullSafeSet, nullSafeSet, replace, replace, resolve, semiResolve, setToXMLNode, sqlTypes, toColumnNullness, toLoggableString

Method Detail

canDoExtraction

boolean canDoExtraction()

Can the given instance of this type actually perform the parameter value extractions?

Returns:

true indicates that @{link #extract} calls will not fail due to IllegalStateException.

extract

T extract(CallableStatement statement,
        int startIndex,
        SessionImplementor session)
          throws SQLException

Perform the extraction

Parameters:

statement - The CallableStatement from which to extract the parameter value(s).

startIndex - The parameter index from which to start extracting; assumes the values (if multiple) are contiguous

session - The originating session

Returns:

The extracted value.

Throws:

SQLException - Indicates an issue calling into the CallableStatement

IllegalStateException - Thrown if this method is called on instances that return false for canDoExtraction()

extract

T extract(CallableStatement statement,
        String[] paramNames,
        SessionImplementor session)
          throws SQLException

Perform the extraction

Parameters:

statement - The CallableStatement from which to extract the parameter value(s).

paramNames - The parameter names.

session - The originating session

Returns:

The extracted value.

Throws:

SQLException - Indicates an issue calling into the CallableStatement

IllegalStateException - Thrown if this method is called on instances that return false for canDoExtraction()