// <fileinfo name="QuarterlyOrdersCollection_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="QuarterlyOrdersCollection"/>. Provides methods
/// for common database view operations.
/// </summary>
/// <remarks>
/// Do not change this source code. Update the <see cref="QuarterlyOrdersCollection"/>
/// class if you need to add or change some functionality.
/// </remarks>
public abstract class QuarterlyOrdersCollection_Base
{
// Constants
public const string CustomerIDColumnName = "CustomerID";
public const string CompanyNameColumnName = "CompanyName";
public const string CityColumnName = "City";
public const string CountryColumnName = "Country";
// Instance fields
private Northwind _db;
/// <summary>
/// Initializes a new instance of the <see cref="QuarterlyOrdersCollection_Base"/>
/// class with the specified <see cref="Northwind"/>.
/// </summary>
/// <param name="db">The <see cref="Northwind"/> object.</param>
public QuarterlyOrdersCollection_Base(Northwind db)
{
_db = db;
}
/// <summary>
/// Gets the database object that this view 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>Quarterly Orders</c> view.
/// </summary>
/// <returns>An array of <see cref="QuarterlyOrdersRow"/> objects.</returns>
public virtual QuarterlyOrdersRow[] GetAll()
{
return MapRecords(CreateGetAllCommand());
}
/// <summary>
/// Gets a <see cref="System.Data.DataTable"/> object that
/// includes all records from the <c>Quarterly Orders</c> view.
/// </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>Quarterly Orders</c> view.
/// </summary>
/// <returns>A reference to the <see cref="System.Data.IDbCommand"/> object.</returns>
protected virtual IDbCommand CreateGetAllCommand()
{
return _db.CreateCommand("dbo._QuarterlyOrders_GetAll", true);
}
/// <summary>
/// Gets the first <see cref="QuarterlyOrdersRow"/> 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="QuarterlyOrdersRow"/> or null reference
/// (Nothing in Visual Basic) if the object was not found.</returns>
public QuarterlyOrdersRow GetRow(string whereSql)
{
int totalRecordCount = -1;
QuarterlyOrdersRow[] rows = GetAsArray(whereSql, null, 0, 1, ref totalRecordCount);
return 0 == rows.Length ? null : rows[0];
}
/// <summary>
/// Gets an array of <see cref="QuarterlyOrdersRow"/> 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="QuarterlyOrdersRow"/> objects.</returns>
public QuarterlyOrdersRow[] GetAsArray(string whereSql, string orderBySql)
{
int totalRecordCount = -1;
return GetAsArray(whereSql, orderBySql, 0, int.MaxValue, ref totalRecordCount);
}
/// <summary>
/// Gets an array of <see cref="QuarterlyOrdersRow"/> 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="QuarterlyOrdersRow"/> objects.</returns>
public virtual QuarterlyOrdersRow[] 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].[Quarterly Orders]";
if(null != whereSql && 0 < whereSql.Length)
sql += " WHERE " + whereSql;
if(null != orderBySql && 0 < orderBySql.Length)
sql += " ORDER BY " + orderBySql;
return _db.CreateCommand(sql);
}
/// <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="QuarterlyOrdersRow"/> objects.</returns>
protected QuarterlyOrdersRow[] 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 view.</param>
/// <returns>An array of <see cref="QuarterlyOrdersRow"/> objects.</returns>
protected QuarterlyOrdersRow[] 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 view.</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="QuarterlyOrdersRow"/> objects.</returns>
protected virtual QuarterlyOrdersRow[] 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 cityColumnIndex = reader.GetOrdinal("City");
int countryColumnIndex = reader.GetOrdinal("Country");
System.Collections.ArrayList recordList = new System.Collections.ArrayList();
int ri = -startIndex;
while(reader.Read())
{
ri++;
if(ri > 0 && ri <= length)
{
QuarterlyOrdersRow record = new QuarterlyOrdersRow();
recordList.Add(record);
if(!reader.IsDBNull(customerIDColumnIndex))
record.CustomerID = Convert.ToString(reader.GetValue(customerIDColumnIndex));
if(!reader.IsDBNull(companyNameColumnIndex))
record.CompanyName = Convert.ToString(reader.GetValue(companyNameColumnIndex));
if(!reader.IsDBNull(cityColumnIndex))
record.City = Convert.ToString(reader.GetValue(cityColumnIndex));
if(!reader.IsDBNull(countryColumnIndex))
record.Country = Convert.ToString(reader.GetValue(countryColumnIndex));
if(ri == length && 0 != totalRecordCount)
break;
}
}
totalRecordCount = 0 == totalRecordCount ? ri + startIndex : -1;
return (QuarterlyOrdersRow[])(recordList.ToArray(typeof(QuarterlyOrdersRow)));
}
/// <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 view.</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 view.</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="QuarterlyOrdersRow"/>.
/// </summary>
/// <param name="row">The <see cref="System.Data.DataRow"/> object to be mapped.</param>
/// <returns>A reference to the <see cref="QuarterlyOrdersRow"/> object.</returns>
protected virtual QuarterlyOrdersRow MapRow(DataRow row)
{
QuarterlyOrdersRow mappedObject = new QuarterlyOrdersRow();
DataTable dataTable = row.Table;
DataColumn dataColumn;
// Column "CustomerID"
dataColumn = dataTable.Columns["CustomerID"];
if(!row.IsNull(dataColumn))
mappedObject.CustomerID = (string)row[dataColumn];
// Column "CompanyName"
dataColumn = dataTable.Columns["CompanyName"];
if(!row.IsNull(dataColumn))
mappedObject.CompanyName = (string)row[dataColumn];
// Column "City"
dataColumn = dataTable.Columns["City"];
if(!row.IsNull(dataColumn))
mappedObject.City = (string)row[dataColumn];
// Column "Country"
dataColumn = dataTable.Columns["Country"];
if(!row.IsNull(dataColumn))
mappedObject.Country = (string)row[dataColumn];
return mappedObject;
}
/// <summary>
/// Creates a <see cref="System.Data.DataTable"/> object for
/// the <c>Quarterly Orders</c> view.
/// </summary>
/// <returns>A reference to the <see cref="System.Data.DataTable"/> object.</returns>
protected virtual DataTable CreateDataTable()
{
DataTable dataTable = new DataTable();
dataTable.TableName = "QuarterlyOrders";
DataColumn dataColumn;
dataColumn = dataTable.Columns.Add("CustomerID", typeof(string));
dataColumn.MaxLength = 5;
dataColumn.ReadOnly = true;
dataColumn = dataTable.Columns.Add("CompanyName", typeof(string));
dataColumn.MaxLength = 40;
dataColumn.ReadOnly = true;
dataColumn = dataTable.Columns.Add("City", typeof(string));
dataColumn.MaxLength = 15;
dataColumn.ReadOnly = true;
dataColumn = dataTable.Columns.Add("Country", typeof(string));
dataColumn.MaxLength = 15;
dataColumn.ReadOnly = true;
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 "CustomerID":
parameter = _db.AddParameter(cmd, paramName, DbType.StringFixedLength, value);
break;
case "CompanyName":
parameter = _db.AddParameter(cmd, paramName, DbType.String, value);
break;
case "City":
parameter = _db.AddParameter(cmd, paramName, DbType.String, value);
break;
case "Country":
parameter = _db.AddParameter(cmd, paramName, DbType.String, value);
break;
default:
throw new ArgumentException("Unknown parameter name (" + paramName + ").");
}
return parameter;
}
} // End of QuarterlyOrdersCollection_Base class
} // End of namespace