Packages:
default
System
System.Caching
System.Collections
System.Data
System.Data.ActiveRecord
System.Data.ActiveRecord.Relations
System.Data.ActiveRecord.Scaffold
System.Data.ActiveReecord.Scaffold.InputBuilder
System.Data.Commom.Sqlite
System.Data.Common
System.Data.Common.Mssql
System.Data.Common.Mysql
System.Data.Common.Oracle
System.Data.Common.Pgsql
System.Data.Common.Sqlite
System.Data.DataGateway
System.Data.SqlMap
System.Data.SqlMap.Configuration
System.Data.SqlMap.Statements
System.Exceptions
System.I18N
System.IO
System.Security
System.Util
System.Web
System.Web.Services
System.Web.UI
System.Web.UI.ActiveControls
System.Web.UI.WebControls
System.Web.UI.WebControls.assets
System.Xml


Classes:
Keyword

Interface IMappedStatement


Interface for all mapping statements.

Since: 3.1
Author: Wei Zhuo <weizho[at]gmail[dot]com>

Method Summary
TList
executeQueryForList ( IDbConnection $connection, mixed $parameter, TList $result, integer $skip, integer $max)
Executes the SQL and retuns a subset of the rows selected.
TMap
executeQueryForMap ( IDbConnection $connection, mixed $parameter, string $keyProperty, string $valueProperty)
Executes the SQL and retuns all rows selected in a map that is keyed on
object result.
executeQueryForObject ( IDbConnection $connection, mixed $parameter, object The $result)
Executes an SQL statement that returns a single row as an object of the type of the <tt>$result</tt> passed in as a parameter.
integer
executeUpdate ( IDbConnection $connection, mixed $parameter)
Execute an update statement. Also used for delete statement. Return the number of row effected.
string
getID ()
TSqlMap
TSqlMapStatement

Method Details

executeQueryForList

public TList executeQueryForList (IDbConnection $connection , mixed $parameter , TList $result , integer $skip , integer $max )

Executes the SQL and retuns a subset of the rows selected.

Input
IDbConnection$connectiondatabase connection to execute the query
mixed$parameterThe object used to set the parameters in the SQL.
TList$resultA list to populate the result with.
integer$skipThe number of rows to skip over.
integer$maxThe maximum number of rows to return.
Output
TList A TList of result objects.
Exception

executeQueryForMap

public TMap executeQueryForMap (IDbConnection $connection , mixed $parameter , string $keyProperty , string $valueProperty )

Executes the SQL and retuns all rows selected in a map that is keyed on

the property named in the <tt>$keyProperty</tt> parameter. The value at each key will be the value of the property specified in the <tt>$valueProperty</tt> parameter. If <tt>$valueProperty</tt> is <tt>null</tt>, the entire result object will be entered.

Input
IDbConnection$connectiondatabase connection to execute the query
mixed$parameterThe object used to set the parameters in the SQL.
string$keyPropertyThe property of the result object to be used as the key.
string$valuePropertyThe property of the result object to be used as the value (or null)
Output
TMap A map of object containing the rows keyed by <tt>$keyProperty</tt>.
Exception

executeQueryForObject

public object result. executeQueryForObject (IDbConnection $connection , mixed $parameter , object The $result )

Executes an SQL statement that returns a single row as an object of the type of the <tt>$result</tt> passed in as a parameter.

Input
IDbConnection$connectiondatabase connection to execute the query
mixed$parameterThe object used to set the parameters in the SQL.
object The$resultresult object.
Output
Exception

executeUpdate

public integer executeUpdate (IDbConnection $connection , mixed $parameter )

Execute an update statement. Also used for delete statement. Return the number of row effected.

Input
IDbConnection$connectiondatabase connection to execute the query
mixed$parameterThe object used to set the parameters in the SQL.
Output
integer The number of row effected.
Exception

getID

public string getID ()

Output
string Name used to identify the MappedStatement amongst the others.
Exception

getManager

public TSqlMap getManager ()

Output
TSqlMap The TSqlMap used by this TMappedStatement
Exception

getStatement

public TSqlMapStatement getStatement ()

Output
TSqlMapStatement The SQL statment used by this TMappedStatement.
Exception