Spring/spring-net
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Initial import!

Browse Source
This commit is contained in:
markpollack
2008-05-30 22:55:02 +00:00
commit c478a783c0
2978 changed files with 510966 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
doc/reference/src/data-quickstart.xml Normal file
View File

@@ -0,0 +1,172 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="data-quickstart">
<title>Data Access QuickStart</title>
<section>
<title>Introduction</title>
<para>The data access quick start demonstrates the API usage of
AdoTemplate (both generic and non-generic versions) as well as the use of
the object based data access classes contained in Spring.Data.Objects. It
uses the Northwind database and is located under the directory
examples/DataAccessQuickStart.</para>
<para>The quick start contains pseudo DAO objects and a collection of
NUnit tests to exercise them rather than a full blown application. To run
the tests from within VS.NET install <ulink
url="http://www.testdriven.net/"><link
linkend="???">TestDriven.NET</link></ulink>, <ulink
url="http://www.jetbrains.com/resharper/">ReSharper</ulink>, or an
equivalent . The listing of DAO classes and the parts of Spring.Data that
they demonstrate is shown below.</para>
<itemizedlist>
<listitem>
<para><classname>CommandCallbackDao</classname> - Use of the
ICommandCallback and CommandCallbackDelegate</para>
</listitem>
<listitem>
<para><classname>ResultSetExtractorDao</classname> - Use of
IResultSetExtractor and ResultSetExtractorDelegate</para>
</listitem>
<listitem>
<para><classname>RowCallbackDao</classname> - Use of IRowCallback and
RowCallbackDelegate</para>
</listitem>
<listitem>
<para><classname>RowMapperDao</classname> - Use of IRowMapper and
RowMapperDelegate</para>
</listitem>
<listitem>
<para><classname>QueryForObject</classname> - Use of QueryForObject
method.</para>
</listitem>
<listitem>
<para><classname>StoredProcDao</classname> - Use of
Spring.Data.Objects.StoredProcedure</para>
</listitem>
</itemizedlist>
<para>The are simple domain objects in the Spring.DataQuickStart.Domain
namespace, collections of which are generally returned from the DAO
methods.</para>
<section>
<title>Database configuration</title>
<para>To get started running the 'unit test' you should configure the
database connection string. The listing in
DataQuickStart.GenericTemplate.ExampleTests.xml is shown below</para>
<programlisting>&lt;objects xmlns="http://www.springframework.net"
xmlns:db="http://www.springframework.net/database"&gt;
&lt;db:provider id="dbProvider"
provider="SqlServer-1.1"
connectionString="Data Source=(local);Database=Northwind;User ID=springqa;Password=springqa;Trusted_Connection=False"/&gt;
&lt;! -- other definitions not shown
&lt;/objects&gt;</programlisting>
<para>You should change the value of the provider element to correspond
to you database and the connection string as appropriate. Please refer
to the documentation on the <link linkend="dbprovider">DbProvider</link>
abstraction for details particular to your database configuration. You
should also install the Northwind database, which is available for
SqlServer 2005 from this <ulink
url="http://www.microsoft.com/downloads/details.aspx?FamilyID=06616212-0356-46a0-8da2-eebc53a68034&amp;DisplayLang=en">download
location</ulink>. The minimal schema to support other database providers
may be supported in the future.</para>
<section>
<title>AdoTemplate Configuration</title>
<para>The various DAO objects refer to an instance of AdoTemplate
which is responsible for performing data access operations. This is
declared in ExampleTest.xml as shown below</para>
<programlisting> &lt;object id="adoTemplate" type="Spring.Data.Generic.AdoTemplate, Spring.Data"&gt;
&lt;property name="DbProvider" ref="dbProvider"/&gt;
&lt;property name="DataReaderWrapperType" value="Spring.Data.Support.NullMappingDataReader, Spring.Data"/&gt;
&lt;/object&gt;
</programlisting>
<para>The property DbProvider refers to the database configuration you
previously defined. Also the property DataReaderWrapper is set to the
NullMappingDataReader that ships with Spring. This provides convenient
default values for null values returned from the database. To read
more about AdoTemplate, refer to the chapter, <link linkend="???">Data
access using ADO.NET</link>.</para>
</section>
</section>
<section>
<title>CommandCallback</title>
<para>The code that exercises the use of a CommandCallback is shown
below</para>
<programlisting> [Test]
public void CallbackDaoTest()
{
CommandCallbackDao commandCallbackDao = ctx["commandCallbackDao"] as CommandCallbackDao;
int count = commandCallbackDao.FindCountWithPostalCode("1010");
Assert.AreEqual(3, count);
}</programlisting>
<para>The configuration of the CommandCallbackDao is shown below</para>
<programlisting> &lt;object id="commandCallbackDao" type="Spring.DataQuickStart.Dao.GenericTemplate.CommandCallbackDao, Spring.DataQuickStart"&gt;
&lt;property name="AdoTemplate" ref="adoTemplate"/&gt;
&lt;/object&gt;</programlisting>
<para>This the minimal configuration required for a DAO object,
typically DAO objects in your application will include other
configuraiton information, for example properties to specify the maximum
size of the result set returned etc. The implementation of the
FindCountWithPostalCode is shown below</para>
<programlisting> public virtual int FindCountWithPostalCodeWithDelegate(string postalCode)
{
// Using anonymous delegates allows you to easily reference the
// surrounding parameters for use with the DbCommand processing.
return AdoTemplate.Execute&lt;int&gt;(delegate(DbCommand command)
{
// Do whatever you like with the DbCommand... downcast to get
// provider specific funtionality if necesary.
command.CommandText = cmdText;
DbParameter p = command.CreateParameter();
p.ParameterName = "@PostalCode";
p.Value = postalCode;
command.Parameters.Add(p);
return (int)command.ExecuteScalar();
});
}</programlisting>
<para>Anonymous delegates are used to specify the implementation of the
callback function that passes in a DbCommand object. You can then use
the DbCommand object as you see fit to access the database. If you are
using Spring's delcarative transaction management features then this
DbCommand would have its transaction and connection properties based on
the context of the surrounding transaction. All resource management for
the DbCommand are handled for you by the framework, as well as error
reporting on error etc. If you execute the test, it will pass, assuming
you haven't modified any data in the Northwind database from its raw
installation.</para>
</section>
</section>
</chapter>