com.ibatis.sqlmap.client
Class SqlMapClientBuilder

java.lang.Object
  com.ibatis.sqlmap.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).

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!

• The SQL Map Config File
• An SQL Map File

  Constructor Summary

  protected

  SqlMapClientBuilder() No instantiation allowed.

  Method Summary

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

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  SqlMapClientBuilder

  protected SqlMapClientBuilder()

  No instantiation allowed.

  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,
                                               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(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,
                                               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.