org.sqlproc.engine.type

Interface SqlMetaType

All Known Subinterfaces:

SqlTaggedMetaType

All Known Implementing Classes:

JdbcBigDecimalType, JdbcBigIntegerType, JdbcBlobType, JdbcBooleanType, JdbcByteArrayType, JdbcByteArrayWrapperType, JdbcByteType, JdbcCharType, JdbcClobType, JdbcDateTimeType, JdbcDateType, JdbcDefaultType, JdbcDoubleType, JdbcEnumIntegerType, JdbcEnumStringType, JdbcFloatType, JdbcFromDateType, JdbcIntegerType, JdbcLongType, JdbcOracleCursorType, JdbcOtherType, JdbcShortType, JdbcStringType, JdbcTextType, JdbcTimestampType, JdbcTimeType, JdbcToDateType, SqlBigDecimalType, SqlBigIntegerType, SqlBlobType, SqlBooleanType, SqlByteArrayType, SqlByteType, SqlCharType, SqlClobType, SqlDateTimeType, SqlDateType, SqlDefaultType, SqlDoubleType, SqlEnumIntegerType, SqlEnumStringType, SqlFloatType, SqlFromDateType, SqlIdentityType, SqlIntegerType, SqlLongType, SqlOutValueType, SqlShortType, SqlStringType, SqlTextType, SqlTimestampType, SqlTimeType, SqlToDateType

public interface SqlMetaType

The common ancestor of all META types. These internal types are devoted for the special processing of the input/output values.

Author:

Vladimir Hudec

Method Summary

Methods

Modifier and Type	Method and Description
void	addScalar(SqlTypeFactory typeFactory, SqlQuery query, String dbName, Class<?>... attributeTypes) Declares a scalar query result, which is an SQL query execution output value.
Object	getProviderSqlType() Returns the type provided by the stack on top of which the SQL Processor works.
void	setParameter(SqlRuntimeContext runtimeCtx, SqlQuery query, String paramName, Object inputValue, boolean ingoreError, Class<?>... inputTypes) Binds an input value to a named query parameter.
void	setResult(SqlRuntimeContext runtimeCtx, Object resultInstance, String attributeName, Object resultValue, boolean ingoreError) Initializes the attribute of the result class with output value from the SQL query execution.

Method Detail

getProviderSqlType

Object getProviderSqlType()

Returns the type provided by the stack on top of which the SQL Processor works.

Returns:

the provided type

addScalar

void addScalar(SqlTypeFactory typeFactory,
             SqlQuery query,
             String dbName,
             Class<?>... attributeTypes)

Declares a scalar query result, which is an SQL query execution output value.

Parameters:

typeFactory - the SQL Type factory

query - the SQL Engine query, an adapter or proxy to the internal JDBC or ORM staff

dbName - the name of a database query output, it can be the column name or the alias name

attributeTypes - the Java types of of the attribute in the result class

setResult

void setResult(SqlRuntimeContext runtimeCtx,
             Object resultInstance,
             String attributeName,
             Object resultValue,
             boolean ingoreError)
               throws SqlRuntimeException

Initializes the attribute of the result class with output value from the SQL query execution.

Parameters:

runtimeCtx - the public runtimeCtx context

resultInstance - the instance of the result class

attributeName - the name of the attribute in the result class

resultValue - the query execution output value

ingoreError - ignore improper output value handling

Throws:

SqlRuntimeException - in the case of any problem with the output values handling

setParameter

void setParameter(SqlRuntimeContext runtimeCtx,
                SqlQuery query,
                String paramName,
                Object inputValue,
                boolean ingoreError,
                Class<?>... inputTypes)
                  throws SqlRuntimeException

Binds an input value to a named query parameter.

Parameters:

runtimeCtx - the public runtimeCtx context

query - the SQL Engine query, an adapter or proxy to the internal JDBC or ORM staff

paramName - the name of the parameter

ingoreError - ignore improper input value handling

inputTypes - the Java types of the attribute in the input POJO

Throws:

SqlRuntimeException - in the case of any problem with the input values handling