// <fileinfo name="CategoriesCollection_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="CategoriesCollection"/>. Provides methods
/// for common database table operations.
/// </summary>
/// <remarks>
/// Do not change this source code. Update the <see cref="CategoriesCollection"/>
/// class if you need to add or change some functionality.
/// </remarks>
public abstract class CategoriesCollection_Base
{
// Constants
public const string CategoryIDColumnName = "CategoryID";
public const string CategoryNameColumnName = "CategoryName";
public const string DescriptionColumnName = "Description";
public const string PictureColumnName = "Picture";
// Instance fields
private Northwind _db;
/// <summary>
/// Initializes a new instance of the <see cref="CategoriesCollection_Base"/>
/// class with the specified <see cref="Northwind"/>.
/// </summary>
/// <param name="db">The <see cref="Northwind"/> object.</param>
public CategoriesCollection_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>Categories</c> table.
/// </summary>
/// <returns>An array of <see cref="CategoriesRow"/> objects.</returns>
public virtual CategoriesRow[] GetAll()
{
return MapRecords(CreateGetAllCommand());
}
/// <summary>
/// Gets a <see cref="System.Data.DataTable"/> object that
/// includes all records from the <c>Categories</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>Categories</c> table.
/// </summary>
/// <returns>A reference to the <see cref="System.Data.IDbCommand"/> object.</returns>
protected virtual IDbCommand CreateGetAllCommand()
{
return _db.CreateCommand("dbo._Categories_GetAll", true);
}
/// <summary>
/// Gets the first <see cref="CategoriesRow"/> 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="CategoriesRow"/> or null reference
/// (Nothing in Visual Basic) if the object was not found.</returns>
public CategoriesRow GetRow(string whereSql)
{
int totalRecordCount = -1;
CategoriesRow[] rows = GetAsArray(whereSql, null, 0, 1, ref totalRecordCount);
return 0 == rows.Length ? null : rows[0];
}
/// <summary>
/// Gets an array of <see cref="CategoriesRow"/> 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="CategoriesRow"/> objects.</returns>
public CategoriesRow[] GetAsArray(string whereSql, string orderBySql)
{
int totalRecordCount = -1;
return GetAsArray(whereSql, orderBySql, 0, int.MaxValue, ref totalRecordCount);
}
/// <summary>
/// Gets an array of <see cref="CategoriesRow"/> 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="CategoriesRow"/> objects.</returns>
public virtual CategoriesRow[] 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].[Categories]";
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="CategoriesRow"/> by the primary key.
/// </summary>
/// <param name="categoryID">The <c>CategoryID</c> column value.</param>
/// <returns>An instance of <see cref="CategoriesRow"/> or null reference
/// (Nothing in Visual Basic) if the object was not found.</returns>
public virtual CategoriesRow GetByPrimaryKey(int categoryID)
{
IDbCommand cmd = _db.CreateCommand("dbo._Categories_GetByPrimaryKey", true);
AddParameter(cmd, "CategoryID", categoryID);
CategoriesRow[] tempArray = MapRecords(cmd);
return 0 == tempArray.Length ? null : tempArray[0];
}
/// <summary>
/// Adds a new record into the <c>Categories</c> table.
/// </summary>
/// <param name="value">The <see cref="CategoriesRow"/> object to be inserted.</param>
public virtual void Insert(CategoriesRow value)
{
IDbCommand cmd = _db.CreateCommand("dbo._Categories_Insert", true);
AddParameter(cmd, "CategoryName", value.CategoryName);
AddParameter(cmd, "Description", value.Description);
AddParameter(cmd, "Picture", value.Picture);
value.CategoryID = Convert.ToInt32(cmd.ExecuteScalar());
}
/// <summary>
/// Updates a record in the <c>Categories</c> table.
/// </summary>
/// <param name="value">The <see cref="CategoriesRow"/>
/// object used to update the table record.</param>
/// <returns>true if the record was updated; otherwise, false.</returns>
public virtual bool Update(CategoriesRow value)
{
IDbCommand cmd = _db.CreateCommand("dbo._Categories_Update", true);
AddParameter(cmd, "CategoryName", value.CategoryName);
AddParameter(cmd, "Description", value.Description);
AddParameter(cmd, "Picture", value.Picture);
AddParameter(cmd, "CategoryID", value.CategoryID);
return 0 != cmd.ExecuteNonQuery();
}
/// <summary>
/// Updates the <c>Categories</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>Categories</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((int)row["CategoryID"]);
}
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>Categories</c> table.
/// </summary>
/// <param name="value">The <see cref="CategoriesRow"/> object to delete.</param>
/// <returns>true if the record was deleted; otherwise, false.</returns>
public bool Delete(CategoriesRow value)
{
return DeleteByPrimaryKey(value.CategoryID);
}
/// <summary>
/// Deletes a record from the <c>Categories</c> table using
/// the specified primary key.
/// </summary>
/// <param name="categoryID">The <c>CategoryID</c> column value.</param>
/// <returns>true if the record was deleted; otherwise, false.</returns>
public virtual bool DeleteByPrimaryKey(int categoryID)
{
IDbCommand cmd = _db.CreateCommand("dbo._Categories_DeleteByPrimaryKey", true);
AddParameter(cmd, "CategoryID", categoryID);
return 0 < cmd.ExecuteNonQuery();
}
/// <summary>
/// Deletes <c>Categories</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>Categories</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].[Categories]";
if(null != whereSql && 0 < whereSql.Length)
sql += " WHERE " + whereSql;
return _db.CreateCommand(sql);
}
/// <summary>
/// Deletes all records from the <c>Categories</c> table.
/// </summary>
/// <returns>The number of deleted records.</returns>
public int DeleteAll()
{
return _db.CreateCommand("dbo._Categories_DeleteAll", true).ExecuteNonQuery();
}
/// <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="CategoriesRow"/> objects.</returns>
protected CategoriesRow[] 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="CategoriesRow"/> objects.</returns>
protected CategoriesRow[] 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="CategoriesRow"/> objects.</returns>
protected virtual CategoriesRow[] 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 categoryIDColumnIndex = reader.GetOrdinal("CategoryID");
int categoryNameColumnIndex = reader.GetOrdinal("CategoryName");
int descriptionColumnIndex = reader.GetOrdinal("Description");
int pictureColumnIndex = reader.GetOrdinal("Picture");
System.Collections.ArrayList recordList = new System.Collections.ArrayList();
int ri = -startIndex;
while(reader.Read())
{
ri++;
if(ri > 0 && ri <= length)
{
CategoriesRow record = new CategoriesRow();
recordList.Add(record);
record.CategoryID = Convert.ToInt32(reader.GetValue(categoryIDColumnIndex));
record.CategoryName = Convert.ToString(reader.GetValue(categoryNameColumnIndex));
if(!reader.IsDBNull(descriptionColumnIndex))
record.Description = Convert.ToString(reader.GetValue(descriptionColumnIndex));
if(!reader.IsDBNull(pictureColumnIndex))
record.Picture = (byte[])reader.GetValue(pictureColumnIndex);
if(ri == length && 0 != totalRecordCount)
break;
}
}
totalRecordCount = 0 == totalRecordCount ? ri + startIndex : -1;
return (CategoriesRow[])(recordList.ToArray(typeof(CategoriesRow)));
}
/// <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 read data from the table.</param>
/// <returns>A reference to the <see cref="System.Data.DataTable"/> object.</returns>
protected DataTable MapRecordsToDataTable(IDataReader reader)
{
int totalRecordCount = 0;
return MapRecordsToDataTable(reader, 0, int.MaxValue, ref totalRecordCount);
}
/// <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 read data from the table.</param>
/// <param name="startIndex">The index of the first record to read.</param>
/// <param name="length">The number of records to read.</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>
protected virtual DataTable MapRecordsToDataTable(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 columnCount = reader.FieldCount;
int ri = -startIndex;
DataTable dataTable = CreateDataTable();
dataTable.BeginLoadData();
object[] values = new object[columnCount];
while(reader.Read())
{
ri++;
if(ri > 0 && ri <= length)
{
reader.GetValues(values);
dataTable.LoadDataRow(values, true);
if(ri == length && 0 != totalRecordCount)
break;
}
}
dataTable.EndLoadData();
totalRecordCount = 0 == totalRecordCount ? ri + startIndex : -1;
return dataTable;
}
/// <summary>
/// Converts <see cref="System.Data.DataRow"/> to <see cref="CategoriesRow"/>.
/// </summary>
/// <param name="row">The <see cref="System.Data.DataRow"/> object to be mapped.</param>
/// <returns>A reference to the <see cref="CategoriesRow"/> object.</returns>
protected virtual CategoriesRow MapRow(DataRow row)
{
CategoriesRow mappedObject = new CategoriesRow();
DataTable dataTable = row.Table;
DataColumn dataColumn;
// Column "CategoryID"
dataColumn = dataTable.Columns["CategoryID"];
if(!row.IsNull(dataColumn))
mappedObject.CategoryID = (int)row[dataColumn];
// Column "CategoryName"
dataColumn = dataTable.Columns["CategoryName"];
if(!row.IsNull(dataColumn))
mappedObject.CategoryName = (string)row[dataColumn];
// Column "Description"
dataColumn = dataTable.Columns["Description"];
if(!row.IsNull(dataColumn))
mappedObject.Description = (string)row[dataColumn];
// Column "Picture"
dataColumn = dataTable.Columns["Picture"];
if(!row.IsNull(dataColumn))
mappedObject.Picture = (byte[])row[dataColumn];
return mappedObject;
}
/// <summary>
/// Creates a <see cref="System.Data.DataTable"/> object for
/// the <c>Categories</c> table.
/// </summary>
/// <returns>A reference to the <see cref="System.Data.DataTable"/> object.</returns>
protected virtual DataTable CreateDataTable()
{
DataTable dataTable = new DataTable();
dataTable.TableName = "Categories";
DataColumn dataColumn;
dataColumn = dataTable.Columns.Add("CategoryID", typeof(int));
dataColumn.AllowDBNull = false;
dataColumn.ReadOnly = true;
dataColumn.Unique = true;
dataColumn.AutoIncrement = true;
dataColumn = dataTable.Columns.Add("CategoryName", typeof(string));
dataColumn.MaxLength = 15;
dataColumn.AllowDBNull = false;
dataColumn = dataTable.Columns.Add("Description", typeof(string));
dataColumn.MaxLength = 1073741823;
dataColumn = dataTable.Columns.Add("Picture", typeof(byte[]));
return dataTable;
}
/// <summary>
/// Adds a new parameter to the specified command.
/// </summary>
/// <param name="cmd">The <see cref="System.Data.IDbCommand"/> object to add the parameter to.</param>
/// <param name="paramName">The name of the parameter.</param>
/// <param name="value">The value of the parameter.</param>
/// <returns>A reference to the added parameter.</returns>
protected virtual IDbDataParameter AddParameter(IDbCommand cmd, string paramName, object value)
{
IDbDataParameter parameter;
switch(paramName)
{
case "CategoryID":
parameter = _db.AddParameter(cmd, paramName, DbType.Int32, value);
break;
case "CategoryName":
parameter = _db.AddParameter(cmd, paramName, DbType.String, value);
break;
case "Description":
parameter = _db.AddParameter(cmd, paramName, DbType.String, value);
break;
case "Picture":
parameter = _db.