org.ibatis.client

Class SqlMapClientBuilder

java.lang.Object

org.ibatis.client.SqlMapClientBuilder

public class SqlMapClientBuilder
extends Object

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).

Date: 2008-10-7

Version:

1.0

Author:

Song Sun

Constructor Summary

Constructors

Constructor and Description
SqlMapClientBuilder()

Method Summary

Modifier and Type	Method and Description
static SqlMapClient	buildSqlMapClient(InputStream inputStream) Builds an SqlMapClient using the specified input stream.
static SqlMapClient	buildSqlMapClient(InputStream inputStream, Properties props) Builds an SqlMapClient using the specified input stream and properties file.
static SqlMapClient	buildSqlMapClient(InputStream inputStream, Properties props, String dialect) Builds an SqlMapClient using the specified input stream, properties file and database dialect.
static SqlMapClient	buildSqlMapClient(InputStream inputStream, String dialect) Builds an SqlMapClient using the specified input stream and database dialect.
static SqlMapClient	buildSqlMapClient(Reader reader) Builds an SqlMapClient using the specified reader.
static SqlMapClient	buildSqlMapClient(Reader reader, Properties props) Builds an SqlMapClient using the specified reader and properties file.
static SqlMapClient	buildSqlMapClient(Reader reader, Properties props, String dialect) Builds an SqlMapClient using the specified reader, properties file and database dialect.
static SqlMapClient	buildSqlMapClient(Reader reader, String dialect) Builds an SqlMapClient using the specified reader and database dialect.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SqlMapClientBuilder

public SqlMapClientBuilder()

Method Detail

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(Reader reader)

Builds an SqlMapClient using the specified reader.

Parameters:

reader - A Reader instance that reads an sql-map-config.xml file. The reader should read an well formed sql-map-config.xml file.

Returns:

An SqlMapClient instance.

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(Reader reader,
                                             String dialect)

Builds an SqlMapClient using the specified reader and database dialect.

Parameters:

reader - A Reader instance that reads an sql-map-config.xml file. The reader should read an well formed sql-map-config.xml file.

dialect - the database dialect

Returns:

An SqlMapClient instance.

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(Reader reader,
                                             Properties props)

Builds an SqlMapClient using the specified reader and properties file.

Parameters:

reader - A Reader instance that reads an sql-map-config.xml file. The reader should read an well formed sql-map-config.xml file.

props - Properties to be used to provide values to dynamic property tokens in the sql-map-config.xml configuration file. This provides an easy way to achieve some level of programmatic configuration.

Returns:

An SqlMapClient instance.

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(Reader reader,
                                             Properties props,
                                             String dialect)

Builds an SqlMapClient using the specified reader, properties file and database dialect.

Parameters:

reader - A Reader instance that reads an sql-map-config.xml file. The reader should read an well formed sql-map-config.xml file.

props - Properties to be used to provide values to dynamic property tokens in the sql-map-config.xml configuration file. This provides an easy way to achieve some level of programmatic configuration.

dialect - the database dialect

Returns:

An SqlMapClient instance.

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(InputStream inputStream)

Builds an SqlMapClient using the specified input stream.

Parameters:

inputStream - An InputStream instance that reads an sql-map-config.xml file. The stream should read a well formed sql-map-config.xml file.

Returns:

An SqlMapClient instance.

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(InputStream inputStream,
                                             String dialect)

Builds an SqlMapClient using the specified input stream and database dialect.

Parameters:

inputStream - An InputStream instance that reads an sql-map-config.xml file. The stream should read a well formed sql-map-config.xml file.

dialect - the database dialect

Returns:

An SqlMapClient instance.

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(InputStream inputStream,
                                             Properties props)

Builds an SqlMapClient using the specified input stream and properties file.

Parameters:

inputStream - An InputStream instance that reads an sql-map-config.xml file. The stream should read an well formed sql-map-config.xml file.

props - Properties to be used to provide values to dynamic property tokens in the sql-map-config.xml configuration file. This provides an easy way to achieve some level of programmatic configuration.

Returns:

An SqlMapClient instance.

buildSqlMapClient

public static SqlMapClient buildSqlMapClient(InputStream inputStream,
                                             Properties props,
                                             String dialect)

Builds an SqlMapClient using the specified input stream, properties file and database dialect.

Parameters:

inputStream - An InputStream instance that reads an sql-map-config.xml file. The stream should read an well formed sql-map-config.xml file.

props - Properties to be used to provide values to dynamic property tokens in the sql-map-config.xml configuration file. This provides an easy way to achieve some level of programmatic configuration.

dialect - the database dialect

Returns:

An SqlMapClient instance.