|Home >> All >> com >> ibatis >> sqlmap >> [ client Javadoc ]|
|||com.ibatis.sqlmap.client.event.* (1)||||com.ibatis.sqlmap.client.extensions.* (3)|
com.ibatis.sqlmap.client: Javadoc index of package com.ibatis.sqlmap.client.
SqlMapClient: A thread safe client for working with your SQL Maps (Start Here). This interface inherits transaction control and execution methods from the SqlMapTransactionManager and SqlMapExecutor interfaces. The SqlMapClient is the central class for working with SQL Maps. This class will allow you to run mapped statements (select, insert, update, delete etc.), and also demarcate transactions and work with batches. Once you have an SqlMapClient instance, everything you need to work with SQL Maps is easily available. The SqlMapClient can either be worked with directly as a multi-threaded client (internal session ...
TypeHandlerCallback: A simple interface for implementing custom type handlers. Using this interface, you can implement a type handler that will perform customized processing before parameters are set on a PreparedStatement and after values are retrieved from a ResultSet. Using a custom type handler you can extend the framework to handle types that are not supported, or handle supported types in a different way. For example, you might use a custom type handler to implement proprietary BLOB support (e.g. Oracle), or you might use it to handle booleans using "Y" and "N" instead of the more typical 0/1. EXAMPLE Here's ...
SqlMapClientBuilder: Builds SqlMapClient instances from a supplied resource (e.g. XML configuration file) The SqlMapClientBuilder class is responsible for parsing configuration documents and building the SqlMapClient instance. Its current implementation works with XML configuration files (e.g. sql-map-config.xml). Example: Reader reader = Resources.getResourceAsReader("properties/sql-map-config.xml"); SqlMapClient client = SqlMapClientBuilder.buildSqlMapClient (reader); Examples of the XML document structure used by SqlMapClientBuilder can be found at the links below. Note: They might look big, but they're mostly comments! ...
ResultGetter: Allows values to be retrieved from the underlying result set. TypeHandlerCallback implementations use this interface to get values that they can subsequently manipulate before having them returned. Each of these methods has a corresponding method on the ResultSet (or CallableStatement) class, the only difference being that there is no need to specify the column name or index with these methods. NOTE: There is no need to implement this. The implementation will be passed into the TypeHandlerCallback automatically.
ParameterSetter: Allows parameters to be set on the underlying prepared statement. TypeHandlerCallback implementations use this interface to process values before they are set on the prepared statement. Each of these methods has a corresponding method on the PreparedStatement class, the only difference being that there is no need to specify the parameter index with these methods. NOTE: There is no need to implement this. The implementation will be passed into the TypeHandlerCallback automatically.
RowHandler: Event handler for row by row processing. The RowHandler interface is used by the SqlMapSession.queryWithRowHandler() method. Generally a RowHandler implementation will perform some row-by-row processing logic in cases where there are too many rows to efficiently load into memory. Example: sqlMap.queryWithRowHandler ("findAllEmployees", null, new MyRowHandler()));
SqlMapException: Thrown to indicate a problem with SQL Map configuration or state. Generally if an SqlMapException is thrown, something is critically wronge and cannot be corrected until a change to the configuration or the environment is made. Note: Generally this wouldn't be used to indicate that an SQL execution error occurred (that's what SQLException is for).
SqlMapSession: A single threaded session for working with your SQL Maps. This interface inherits transaction control and execution methods from the SqlMapTransactionManager and SqlMapExecutor interfaces.
SqlMapExecutor: This interface declares all methods involved with executing statements and batches for an SQL Map.
SqlMapTransactionManager: This interface declares methods for demarcating SQL Map transactions.