org.hibernate.type.descriptor.sql.BasicExtractor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
JPMS Module-Info's for a few of the Jakarta Libraries just until they add them in themselves
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.type.descriptor.sql;
import java.sql.CallableStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import org.hibernate.internal.CoreLogging;
import org.hibernate.type.descriptor.JdbcTypeNameMapper;
import org.hibernate.type.descriptor.ValueExtractor;
import org.hibernate.type.descriptor.WrapperOptions;
import org.hibernate.type.descriptor.java.JavaTypeDescriptor;
import org.jboss.logging.Logger;
/**
* Convenience base implementation of {@link org.hibernate.type.descriptor.ValueExtractor}
*
* @author Steve Ebersole
*/
public abstract class BasicExtractor implements ValueExtractor {
private static final Logger log = CoreLogging.logger( BasicExtractor.class );
private final JavaTypeDescriptor javaDescriptor;
private final SqlTypeDescriptor sqlDescriptor;
public BasicExtractor(JavaTypeDescriptor javaDescriptor, SqlTypeDescriptor sqlDescriptor) {
this.javaDescriptor = javaDescriptor;
this.sqlDescriptor = sqlDescriptor;
}
public JavaTypeDescriptor getJavaDescriptor() {
return javaDescriptor;
}
public SqlTypeDescriptor getSqlDescriptor() {
return sqlDescriptor;
}
@Override
public J extract(ResultSet rs, String name, WrapperOptions options) throws SQLException {
final J value = doExtract( rs, name, options );
if ( value == null || rs.wasNull() ) {
if ( log.isTraceEnabled() ) {
log.tracef(
"extracted value ([%s] : [%s]) - [null]",
name,
JdbcTypeNameMapper.getTypeName( getSqlDescriptor().getSqlType() )
);
}
return null;
}
else {
if ( log.isTraceEnabled() ) {
log.tracef(
"extracted value ([%s] : [%s]) - [%s]",
name,
JdbcTypeNameMapper.getTypeName( getSqlDescriptor().getSqlType() ),
getJavaDescriptor().extractLoggableRepresentation( value )
);
}
return value;
}
}
/**
* Perform the extraction.
*
* Called from {@link #extract}. Null checking of the value (as well as consulting {@link ResultSet#wasNull}) is
* done there.
*
* @param rs The result set
* @param name The value name in the result set
* @param options The binding options
*
* @return The extracted value.
*
* @throws SQLException Indicates a problem access the result set
*/
protected abstract J doExtract(ResultSet rs, String name, WrapperOptions options) throws SQLException;
@Override
public J extract(CallableStatement statement, int index, WrapperOptions options) throws SQLException {
final J value = doExtract( statement, index, options );
if ( value == null || statement.wasNull() ) {
if ( log.isTraceEnabled() ) {
log.tracef(
"extracted procedure output parameter ([%s] : [%s]) - [null]",
index,
JdbcTypeNameMapper.getTypeName( getSqlDescriptor().getSqlType() )
);
}
return null;
}
else {
if ( log.isTraceEnabled() ) {
log.tracef(
"extracted procedure output parameter ([%s] : [%s]) - [%s]",
index,
JdbcTypeNameMapper.getTypeName( getSqlDescriptor().getSqlType() ),
getJavaDescriptor().extractLoggableRepresentation( value )
);
}
return value;
}
}
/**
* Perform the extraction.
*
* Called from {@link #extract}. Null checking of the value (as well as consulting {@link ResultSet#wasNull}) is
* done there.
*
* @param statement The callable statement containing the output parameter
* @param index The index (position) of the output parameter
* @param options The binding options
*
* @return The extracted value.
*
* @throws SQLException Indicates a problem accessing the parameter value
*/
protected abstract J doExtract(CallableStatement statement, int index, WrapperOptions options) throws SQLException;
@Override
public J extract(CallableStatement statement, String[] paramNames, WrapperOptions options) throws SQLException {
if ( paramNames.length > 1 ) {
throw new IllegalArgumentException( "Basic value extraction cannot handle multiple output parameters" );
}
final String paramName = paramNames[0];
final J value = doExtract( statement, paramName, options );
if ( value == null || statement.wasNull() ) {
if ( log.isTraceEnabled() ) {
log.tracef(
"extracted named procedure output parameter ([%s] : [%s]) - [null]",
paramName,
JdbcTypeNameMapper.getTypeName( getSqlDescriptor().getSqlType() )
);
}
return null;
}
else {
if ( log.isTraceEnabled() ) {
log.tracef(
"extracted named procedure output parameter ([%s] : [%s]) - [%s]",
paramName,
JdbcTypeNameMapper.getTypeName( getSqlDescriptor().getSqlType() ),
getJavaDescriptor().extractLoggableRepresentation( value )
);
}
return value;
}
}
/**
* Perform the extraction.
*
* Called from {@link #extract}. Null checking of the value (as well as consulting {@link ResultSet#wasNull}) is
* done there.
*
* @param statement The callable statement containing the output parameter
* @param name The output parameter name
* @param options The binding options
*
* @return The extracted value.
*
* @throws SQLException Indicates a problem accessing the parameter value
*/
protected abstract J doExtract(CallableStatement statement, String name, WrapperOptions options) throws SQLException;
}