// <fileinfo name="CustomersCollection_Base.cs">
// <copyright>
// All rights reserved.
// </copyright>
// <remarks>
// Do not change this source code manually. Changes to this file may
// cause incorrect behavior and will be lost if the code is regenerated.
// </remarks>
// <generator rewritefile="True" infourl="http://www.SharpPower.com">RapTier</generator>
// </fileinfo>
using System;
using System.Data;
namespace MyCompany.MyProject.Db
{
/// <summary>
/// The base class for <see cref="CustomersCollection"/>. Provides methods
/// for common database table operations.
/// </summary>
/// <remarks>
/// Do not change this source code. Update the <see cref="CustomersCollection"/>
/// class if you need to add or change some functionality.
/// </remarks>
public abstract class CustomersCollection_Base
{
// Constants
public const string CustomerIDColumnName = "CustomerID";
public const string CompanyNameColumnName = "CompanyName";
public const string ContactNameColumnName = "ContactName";
public const string ContactTitleColumnName = "ContactTitle";
public const string AddressColumnName = "Address";
public const string CityColumnName = "City";
public const string RegionColumnName = "Region";
public const string PostalCodeColumnName = "PostalCode";
public const string CountryColumnName = "Country";
public const string PhoneColumnName = "Phone";
public const string FaxColumnName = "Fax";
// Instance fields
private Northwind _db;
/// <summary>
/// Initializes a new instance of the <see cref="CustomersCollection_Base"/>
/// class with the specified <see cref="Northwind"/>.
/// </summary>
/// <param name="db">The <see cref="Northwind"/> object.</param>
public CustomersCollection_Base(Northwind db)
{
_db = db;
}
/// <summary>
/// Gets the database object that this table belongs to.
/// </summary>
/// <value>The <see cref="Northwind"/> object.</value>
protected Northwind Database
{
get { return _db; }
}
/// <summary>
/// Gets an array of all records from the <c>Customers</c> table.
/// </summary>
/// <returns>An array of <see cref="CustomersRow"/> objects.</returns>
public virtual CustomersRow[] GetAll()
{
return MapRecords(CreateGetAllCommand());
}
/// <summary>
/// Gets a <see cref="System.Data.DataTable"/> object that
/// includes all records from the <c>Customers</c> table.
/// </summary>
/// <returns>A reference to the <see cref="System.Data.DataTable"/> object.</returns>
public virtual DataTable GetAllAsDataTable()
{
return MapRecordsToDataTable(CreateGetAllCommand());
}
/// <summary>
/// Creates and returns an <see cref="System.Data.IDbCommand"/> object that is used
/// to retrieve all records from the <c>Customers</c> table.
/// </summary>
/// <returns>A reference to the <see cref="System.Data.IDbCommand"/> object.</returns>
protected virtual IDbCommand CreateGetAllCommand()
{
return CreateGetCommand(null, null);
}
/// <summary>
/// Gets the first <see cref="CustomersRow"/> objects that
/// match the search condition.
/// </summary>
/// <param name="whereSql">The SQL search condition. For example:
/// <c>"FirstName='Smith' AND Zip=75038"</c>.</param>
/// <returns>An instance of <see cref="CustomersRow"/> or null reference
/// (Nothing in Visual Basic) if the object was not found.</returns>
public CustomersRow GetRow(string whereSql)
{
int totalRecordCount = -1;
CustomersRow[] rows = GetAsArray(whereSql, null, 0, 1, ref totalRecordCount);
return 0 == rows.Length ? null : rows[0];
}
/// <summary>
/// Gets an array of <see cref="CustomersRow"/> objects that
/// match the search condition, in the the specified sort order.
/// </summary>
/// <param name="whereSql">The SQL search condition. For example:
/// <c>"FirstName='Smith' AND Zip=75038"</c>.</param>
/// <param name="orderBySql">The column name(s) followed by "ASC" (ascending) or "DESC" (descending).
/// Columns are sorted in ascending order by default. For example: <c>"LastName ASC, FirstName ASC"</c>.</param>
/// <returns>An array of <see cref="CustomersRow"/> objects.</returns>
public CustomersRow[] GetAsArray(string whereSql, string orderBySql)
{
int totalRecordCount = -1;
return GetAsArray(whereSql, orderBySql, 0, int.MaxValue, ref totalRecordCount);
}
/// <summary>
/// Gets an array of <see cref="CustomersRow"/> objects that
/// match the search condition, in the the specified sort order.
/// </summary>
/// <param name="whereSql">The SQL search condition. For example:
/// <c>"FirstName='Smith' AND Zip=75038"</c>.</param>
/// <param name="orderBySql">The column name(s) followed by "ASC" (ascending) or "DESC" (descending).
/// Columns are sorted in ascending order by default. For example: <c>"LastName ASC, FirstName ASC"</c>.</param>
/// <param name="startIndex">The index of the first record to return.</param>
/// <param name="length">The number of records to return.</param>
/// <param name="totalRecordCount">A reference parameter that returns the total number
/// of records in the reader object if 0 was passed into the method; otherwise it returns -1.</param>
/// <returns>An array of <see cref="CustomersRow"/> objects.</returns>
public virtual CustomersRow[] GetAsArray(string whereSql, string orderBySql,
int startIndex, int length, ref int totalRecordCount)
{
using(IDataReader reader = _db.ExecuteReader(CreateGetCommand(whereSql, orderBySql)))
{
return MapRecords(reader, startIndex, length, ref totalRecordCount);
}
}
/// <summary>
/// Gets a <see cref="System.Data.DataTable"/> object filled with data that
/// match the search condition, in the the specified sort order.
/// </summary>
/// <param name="whereSql">The SQL search condition. For example: "FirstName='Smith' AND Zip=75038".</param>
/// <param name="orderBySql">The column name(s) followed by "ASC" (ascending) or "DESC" (descending).
/// Columns are sorted in ascending order by default. For example: "LastName ASC, FirstName ASC".</param>
/// <returns>A reference to the <see cref="System.Data.DataTable"/> object.</returns>
public DataTable GetAsDataTable(string whereSql, string orderBySql)
{
int totalRecordCount = -1;
return GetAsDataTable(whereSql, orderBySql, 0, int.MaxValue, ref totalRecordCount);
}
/// <summary>
/// Gets a <see cref="System.Data.DataTable"/> object filled with data that
/// match the search condition, in the the specified sort order.
/// </summary>
/// <param name="whereSql">The SQL search condition. For example: "FirstName='Smith' AND Zip=75038".</param>
/// <param name="orderBySql">The column name(s) followed by "ASC" (ascending) or "DESC" (descending).
/// Columns are sorted in ascending order by default. For example: "LastName ASC, FirstName ASC".</param>
/// <param name="startIndex">The index of the first record to return.</param>
/// <param name="length">The number of records to return.</param>
/// <param name="totalRecordCount">A reference parameter that returns the total number
/// of records in the reader object if 0 was passed into the method; otherwise it returns -1.</param>
/// <returns>A reference to the <see cref="System.Data.DataTable"/> object.</returns>
public virtual DataTable GetAsDataTable(string whereSql, string orderBySql,
int startIndex, int length, ref int totalRecordCount)
{
using(IDataReader reader = _db.ExecuteReader(CreateGetCommand(whereSql, orderBySql)))
{
return MapRecordsToDataTable(reader, startIndex, length, ref totalRecordCount);
}
}
/// <summary>
/// Creates an <see cref="System.Data.IDbCommand"/> object for the specified search criteria.
/// </summary>
/// <param name="whereSql">The SQL search condition. For example: "FirstName='Smith' AND Zip=75038".</param>
/// <param name="orderBySql">The column name(s) followed by "ASC" (ascending) or "DESC" (descending).
/// Columns are sorted in ascending order by default. For example: "LastName ASC, FirstName ASC".</param>
/// <returns>A reference to the <see cref="System.Data.IDbCommand"/> object.</returns>
protected virtual IDbCommand CreateGetCommand(string whereSql, string orderBySql)
{
string sql = "SELECT * FROM [dbo].[Customers]";
if(null != whereSql && 0 < whereSql.Length)
sql += " WHERE " + whereSql;
if(null != orderBySql && 0 < orderBySql.Length)
sql += " ORDER BY " + orderBySql;
return _db.CreateCommand(sql);
}
/// <summary>
/// Gets <see cref="CustomersRow"/> by the primary key.
/// </summary>
/// <param name="customerID">The <c>CustomerID</c> column value.</param>
/// <returns>An instance of <see cref="CustomersRow"/> or null reference
/// (Nothing in Visual Basic) if the object was not found.</returns>
public virtual CustomersRow GetByPrimaryKey(string customerID)
{
string whereSql = "[CustomerID]=" + _db.CreateSqlParameterName("CustomerID");
IDbCommand cmd = CreateGetCommand(whereSql, null);
AddParameter(cmd, "CustomerID", customerID);
CustomersRow[] tempArray = MapRecords(cmd);
return 0 == tempArray.Length ? null : tempArray[0];
}
/// <summary>
/// Adds a new record into the <c>Customers</c> table.
/// </summary>
/// <param name="value">The <see cref="CustomersRow"/> object to be inserted.</param>
public virtual void Insert(CustomersRow value)
{
string sqlStr = "INSERT INTO [dbo].[Customers] (" +
"[CustomerID], " +
"[CompanyName], " +
"[ContactName], " +
"[ContactTitle], " +
"[Address], " +
"[City], " +
"[Region], " +
"[PostalCode], " +
"[Country], " +
"[Phone], " +
"[Fax]" +
") VALUES (" +
_db.CreateSqlParameterName("CustomerID") + ", " +
_db.CreateSqlParameterName("CompanyName") + ", " +
_db.CreateSqlParameterName("ContactName") + ", " +
_db.CreateSqlParameterName("ContactTitle") + ", " +
_db.CreateSqlParameterName("Address") + ", " +
_db.CreateSqlParameterName("City") + ", " +
_db.CreateSqlParameterName("Region") + ", " +
_db.CreateSqlParameterName("PostalCode") + ", " +
_db.CreateSqlParameterName("Country") + ", " +
_db.CreateSqlParameterName("Phone") + ", " +
_db.CreateSqlParameterName("Fax") + ")";
IDbCommand cmd = _db.CreateCommand(sqlStr);
AddParameter(cmd, "CustomerID", value.CustomerID);
AddParameter(cmd, "CompanyName", value.CompanyName);
AddParameter(cmd, "ContactName", value.ContactName);
AddParameter(cmd, "ContactTitle", value.ContactTitle);
AddParameter(cmd, "Address", value.Address);
AddParameter(cmd, "City", value.City);
AddParameter(cmd, "Region", value.Region);
AddParameter(cmd, "PostalCode", value.PostalCode);
AddParameter(cmd, "Country", value.Country);
AddParameter(cmd, "Phone", value.Phone);
AddParameter(cmd, "Fax", value.Fax);
cmd.ExecuteNonQuery();
}
/// <summary>
/// Updates a record in the <c>Customers</c> table.
/// </summary>
/// <param name="value">The <see cref="CustomersRow"/>
/// object used to update the table record.</param>
/// <returns>true if the record was updated; otherwise, false.</returns>
public virtual bool Update(CustomersRow value)
{
string sqlStr = "UPDATE [dbo].[Customers] SET " +
"[CompanyName]=" + _db.CreateSqlParameterName("CompanyName") + ", " +
"[ContactName]=" + _db.CreateSqlParameterName("ContactName") + ", " +
"[ContactTitle]=" + _db.CreateSqlParameterName("ContactTitle") + ", " +
"[Address]=" + _db.CreateSqlParameterName("Address") + ", " +
"[City]=" + _db.CreateSqlParameterName("City") + ", " +
"[Region]=" + _db.CreateSqlParameterName("Region") + ", " +
"[PostalCode]=" + _db.CreateSqlParameterName("PostalCode") + ", " +
"[Country]=" + _db.CreateSqlParameterName("Country") + ", " +
"[Phone]=" + _db.CreateSqlParameterName("Phone") + ", " +
"[Fax]=" + _db.CreateSqlParameterName("Fax") +
" WHERE " +
"[CustomerID]=" + _db.CreateSqlParameterName("CustomerID");
IDbCommand cmd = _db.CreateCommand(sqlStr);
AddParameter(cmd, "CompanyName", value.CompanyName);
AddParameter(cmd, "ContactName", value.ContactName);
AddParameter(cmd, "ContactTitle", value.ContactTitle);
AddParameter(cmd, "Address", value.Address);
AddParameter(cmd, "City", value.City);
AddParameter(cmd, "Region", value.Region);
AddParameter(cmd, "PostalCode", value.PostalCode);
AddParameter(cmd, "Country", value.Country);
AddParameter(cmd, "Phone", value.Phone);
AddParameter(cmd, "Fax", value.Fax);
AddParameter(cmd, "CustomerID", value.CustomerID);
return 0 != cmd.ExecuteNonQuery();
}
/// <summary>
/// Updates the <c>Customers</c> table and calls the <c>AcceptChanges</c> method
/// on the changed DataRow objects.
/// </summary>
/// <param name="table">The <see cref="System.Data.DataTable"/> used to update the data source.</param>
public void Update(DataTable table)
{
Update(table, true);
}
/// <summary>
/// Updates the <c>Customers</c> table. Pass <c>false</c> as the <c>acceptChanges</c>
/// argument when your code calls this method in an ADO.NET transaction context. Note that in
/// this case, after you call the Update method you need call either <c>AcceptChanges</c>
/// or <c>RejectChanges</c> method on the DataTable object.
/// <code>
/// MyDb db = new MyDb();
/// try
/// {
/// db.BeginTransaction();
/// db.MyCollection.Update(myDataTable, false);
/// db.CommitTransaction();
/// myDataTable.AcceptChanges();
/// }
/// catch(Exception)
/// {
/// db.RollbackTransaction();
/// myDataTable.RejectChanges();
/// }
/// </code>
/// </summary>
/// <param name="table">The <see cref="System.Data.DataTable"/> used to update the data source.</param>
/// <param name="acceptChanges">Specifies whether this method calls the <c>AcceptChanges</c>
/// method on the changed DataRow objects.</param>
public virtual void Update(DataTable table, bool acceptChanges)
{
DataRowCollection rows = table.Rows;
for(int i = rows.Count - 1; i >= 0; i--)
{
DataRow row = rows[i];
switch(row.RowState)
{
case DataRowState.Added:
Insert(MapRow(row));
if(acceptChanges)
row.AcceptChanges();
break;
case DataRowState.Deleted:
// Temporary reject changes to be able to access to the PK column(s)
row.RejectChanges();
try
{
DeleteByPrimaryKey((string)row["CustomerID"]);
}
finally
{
row.Delete();
}
if(acceptChanges)
row.AcceptChanges();
break;
case DataRowState.Modified:
Update(MapRow(row));
if(acceptChanges)
row.AcceptChanges();
break;
}
}
}
/// <summary>
/// Deletes the specified object from the <c>Customers</c> table.
/// </summary>
/// <param name="value">The <see cref="CustomersRow"/> object to delete.</param>
/// <returns>true if the record was deleted; otherwise, false.</returns>
public bool Delete(CustomersRow value)
{
return DeleteByPrimaryKey(value.CustomerID);
}
/// <summary>
/// Deletes a record from the <c>Customers</c> table using
/// the specified primary key.
/// </summary>
/// <param name="customerID">The <c>CustomerID</c> column value.</param>
/// <returns>true if the record was deleted; otherwise, false.</returns>
public virtual bool DeleteByPrimaryKey(string customerID)
{
string whereSql = "[CustomerID]=" + _db.CreateSqlParameterName("CustomerID");
IDbCommand cmd = CreateDeleteCommand(whereSql);
AddParameter(cmd, "CustomerID", customerID);
return 0 < cmd.ExecuteNonQuery();
}
/// <summary>
/// Deletes <c>Customers</c> records that match the specified criteria.
/// </summary>
/// <param name="whereSql">The SQL search condition.
/// For example: <c>"FirstName='Smith' AND Zip=75038"</c>.</param>
/// <returns>The number of deleted records.</returns>
public int Delete(string whereSql)
{
return CreateDeleteCommand(whereSql).ExecuteNonQuery();
}
/// <summary>
/// Creates an <see cref="System.Data.IDbCommand"/> object that can be used
/// to delete <c>Customers</c> records that match the specified criteria.
/// </summary>
/// <param name="whereSql">The SQL search condition.
/// For example: <c>"FirstName='Smith' AND Zip=75038"</c>.</param>
/// <returns>A reference to the <see cref="System.Data.IDbCommand"/> object.</returns>
protected virtual IDbCommand CreateDeleteCommand(string whereSql)
{
string sql = "DELETE FROM [dbo].[Customers]";
if(null != whereSql && 0 < whereSql.Length)
sql += " WHERE " + whereSql;
return _db.CreateCommand(sql);
}
/// <summary>
/// Deletes all records from the <c>Customers</c> table.
/// </summary>
/// <returns>The number of deleted records.</returns>
public int DeleteAll()
{
return Delete("");
}
/// <summary>
/// Reads data using the specified command and returns
/// an array of mapped objects.
/// </summary>
/// <param name="command">The <see cref="System.Data.IDbCommand"/> object.</param>
/// <returns>An array of <see cref="CustomersRow"/> objects.</returns>
protected CustomersRow[] MapRecords(IDbCommand command)
{
using(IDataReader reader = _db.ExecuteReader(command))
{
return MapRecords(reader);
}
}
/// <summary>
/// Reads data from the provided data reader and returns
/// an array of mapped objects.
/// </summary>
/// <param name="reader">The <see cref="System.Data.IDataReader"/> object to read data from the table.</param>
/// <returns>An array of <see cref="CustomersRow"/> objects.</returns>
protected CustomersRow[] MapRecords(IDataReader reader)
{
int totalRecordCount = -1;
return MapRecords(reader, 0, int.MaxValue, ref totalRecordCount);
}
/// <summary>
/// Reads data from the provided data reader and returns
/// an array of mapped objects.
/// </summary>
/// <param name="reader">The <see cref="System.Data.IDataReader"/> object to read data from the table.</param>
/// <param name="startIndex">The index of the first record to map.</param>
/// <param name="length">The number of records to map.</param>
/// <param name="totalRecordCount">A reference parameter that returns the total number
/// of records in the reader object if 0 was passed into the method; otherwise it returns -1.</param>
/// <returns>An array of <see cref="CustomersRow"/> objects.</returns>
protected virtual CustomersRow[] MapRecords(IDataReader reader,
int startIndex, int length, ref int totalRecordCount)
{
if(0 > startIndex)
throw new ArgumentOutOfRangeException("startIndex", startIndex, "StartIndex cannot be less than zero.");
if(0 > length)
throw new ArgumentOutOfRangeException("length", length, "Length cannot be less than zero.");
int customerIDColumnIndex = reader.GetOrdinal("CustomerID");
int companyNameColumnIndex = reader.GetOrdinal("CompanyName");
int contactNameColumnIndex = reader.GetOrdinal("ContactName");
int contactTitleColumnIndex = reader.GetOrdinal("ContactTitle");
int addressColumnIndex = reader.GetOrdinal("Address");
int cityColumnIndex = reader.GetOrdinal("City");
int regionColumnIndex = reader.GetOrdinal("Region");
int postalCodeColumnIndex = reader.GetOrdinal("PostalCode");
int countryColumnIndex = reader.GetOrdinal("Country");
int phoneColumnIndex = reader.GetOrdinal("Phone");
int faxColumnIndex = reader.GetOrdinal("Fax");
System.Collections.ArrayList recordList = new System.Collections.ArrayList();
int ri = -startIndex;
while(reader.Read())
{
ri++;
if(ri > 0 && ri <= length)
{
CustomersRow record = new CustomersRow();
recordList.Add(record);
record.CustomerID = Convert.ToString(reader.GetValue(customerIDColumnIndex));
record.CompanyName = Convert.ToString(reader.GetValue(companyNameColumnIndex));
if(!reader.IsDBNull(contactNameColumnIndex))
record.ContactName = Convert.ToString(reader.GetValue(contactNameColumnIndex));
if(!reader.IsDBNull(contactTitleColumnIndex))
record.ContactTitle = Convert.ToString(reader.GetValue(contactTitleColumnIndex));
if(!reader.IsDBNull(addressColumnIndex))
record.Address = Convert.ToString(reader.GetValue(addressColumnIndex));
if(!reader.IsDBNull(cityColumnIndex))
record.City = Convert.ToString(reader.GetValue(cityColumnIndex));
if(!reader.IsDBNull(regionColumnIndex))
record.Region = Convert.ToString(reader.GetValue(regionColumnIndex));
if(!reader.IsDBNull(postalCodeColumnIndex))
record.PostalCode = Convert.ToString(reader.GetValue(postalCodeColumnIndex));
if(!reader.IsDBNull(countryColumnIndex))
record.Country = Convert.ToString(reader.GetValue(countryColumnIndex));
if(!reader.IsDBNull(phoneColumnIndex))
record.Phone = Convert.ToString(reader.GetValue(phoneColumnIndex));
if(!reader.IsDBNull(faxColumnIndex))
record.Fax = Convert.ToString(reader.GetValue(faxColumnIndex));
if(ri == length && 0 != totalRecordCount)
break;
}
}
totalRecordCount = 0 == totalRecordCount ? ri + startIndex : -1;
return (CustomersRow[])(recordList.ToArray(typeof(CustomersRow)));
}
/// <summary>
/// Reads data using the specified command and returns
/// a filled <see cref="System.Data.DataTable"/> object.
/// </summary>
/// <param name="command">The <see cref="System.Data.IDbCommand"/> object.</param>
/// <returns>A reference to the <see cref="System.Data.DataTable"/> object.</returns>
protected DataTable MapRecordsToDataTable(IDbCommand command)
{
using(IDataReader reader = _db.ExecuteReader(command))
{
return MapRecordsToDataTable(reader);
}
}
/// <summary>
/// Reads data from the provided data reader and returns
/// a filled <see cref="System.Data.DataTable"/> object.
/// </summary>
/// <param name="reader">The <see cref="System.Data.IDataReader"/> object to