#region Using directives
using System;
using System.Data;
using System.Collections;
using System.Diagnostics;
using SmartInstitute;
#endregion
namespace SmartInstitute.DataAccessLayer.Factories
{
///<summary>
/// This class is an helper Repository that exposes CRUD methods for Admin objects as static methods.
/// It forward the process to the concrete IAdminRepository that is defined in the configuration file.
///</summary>
public class AdminRepository : IAdminRepository
{
private static volatile AdminRepository current;
private static object syncRoot = new Object();
private IAdminRepository repository;
#region "Constructors"
///<summary>
/// Creates a new <see cref="AdminRepository"/> instance.
///</summary>
private AdminRepository()
{
this.repository = new DataAccessLayer.SqlClient.AdminRepository(string.Empty);
}
///<summary>
/// The current <see href="AdminRepository"/> instance.
///</summary>
///<value></value>
public static AdminRepository Current
{
get
{
if (current == null)
{
lock (syncRoot)
{
if (current == null)
{
current = new AdminRepository();
}
}
}
return current;
}
}
#endregion "Constructors"
#region Public Properties
///<summary>
/// The current IAdminRepository instance, as configured in the DataAccessLayer/ClientType configuration section.
///</summary>
private IAdminRepository Repository
{
get
{
return this.repository;
}
}
#endregion
#region "Get from Many To Many Relationship Functions"
#endregion
#region "Delete Functions"
/// <summary>
/// Deletes rows from the DataSource.
/// </summary>
/// <param name="entityCollection">AdminCollection containing data.</param>
/// <remarks>Deletes Admins only when IsDeleted equals true.</remarks>
/// <returns>Returns the number of successful delete.</returns>
public int Delete(AdminCollection entityCollection)
{
int number = 0;
foreach (Admin entity in entityCollection)
{
if( Delete(entity) )
{
number++;
}
}
return number;
}
/// <summary>
/// Deletes a row from the DataSource.
/// </summary>
/// <param name="entity">Admin object containing data.</param>
/// <remarks>Deletes based on primary key(s).</remarks>
/// <returns>Returns true if operation suceeded.</returns>
public bool Delete(Admin entity)
{
return Delete(entity.OriginalID, entity.ChangeStamp);
}
/// <summary>
/// Deletes a row from the DataSource.
/// </summary>
/// <param name="ID">. Primary Key.</param>
/// <remarks>Deletes based on primary key(s).</remarks>
/// <returns>Returns true if operation suceeded.</returns>
public bool Delete(System.Int32 ID, DateTime ChangeStamp)
{
return Repository.Delete(ID, ChangeStamp);
}//end Delete
/// <summary>
/// Throws the delete concurrency exception.
/// </summary>
/// <param name="ID">. Primary Key.</param>
protected static void ThrowDeleteConcurrencyException(System.Int32 ID, DateTime ChangeStamp)
{
DBConcurrencyException conflict = new DBConcurrencyException("Concurrency exception: Cannot delete entity as it does not exist.");
//conflict.ModifiedRecord = entity;
throw conflict;
}
#endregion
#region "GetList Functions"
/// <summary>
/// Gets All rows from the DataSource.
/// </summary>
/// <returns>Returns a typed collection of Admin objects.</returns>
public AdminCollection GetAll()
{
return GetAll(0, int.MaxValue);
}
/// <summary>
/// Gets All rows from the DataSource.
/// </summary>
/// <param name="start">Row number at which to start reading.</param>
/// <param name="pageLength">Number of rows to return.</param>
/// <remarks></remarks>
/// <returns>Returns a typed collection of Admin objects.</returns>
public AdminCollection GetAll(int start, int pageLength)
{
return Repository.GetAll(start, pageLength);
}
#endregion
#region Paged Recordset
/// <summary>
/// Gets a page of rows from the DataSource.
/// </summary>
/// <param name="start">Row number at which to start reading.</param>
/// <param name="pageLength">Number of rows to return.</param>
/// <param name="count">Number of rows in the DataSource.</param>
/// <remarks></remarks>
/// <returns>Returns a typed collection of Admin objects.</returns>
public AdminCollection GetPaged(int start, int pageLength, out int count)
{
return Repository.GetPaged(null, null, start, pageLength, out count);
}
/// <summary>
/// Gets a page of rows from the DataSource.
/// </summary>
/// <param name="start">Row number at which to start reading.</param>
/// <param name="pageLength">Number of rows to return.</param>
/// <param name="count">Number of rows in the DataSource.</param>
/// <param name="whereClause">Specifies the condition for the rows returned by a query (Name='John Doe', Name='John Doe' AND Id='1', Name='John Doe' OR Id='1').</param>
/// <param name="orderBy">Specifies the sort criteria for the rows in the DataSource (Name ASC; BirthDay DESC, Name ASC);</param>
/// <remarks></remarks>
/// <returns>Returns a typed collection of Admin objects.</returns>
public AdminCollection GetPaged(string whereClause, string orderBy, int start, int pageLength, out int count)
{
return Repository.GetPaged(whereClause, orderBy, start, pageLength, out count);
}
#endregion
#region "Get By Foreign Key Functions"
/// <summary>
/// Gets rows from the datasource based on the FK_Admin_Users key.
/// FK_Admin_Users Description:
/// </summary>
/// <param name="ID"></param>
/// <returns>Returns a typed collection of Admin objects.</returns>
public AdminCollection GetByID(System.Int32 ID)
{
return GetByID(ID, 0,int.MaxValue);
}
/// <summary>
/// Gets rows from the datasource based on the FK_Admin_Users key.
/// FK_Admin_Users Description:
/// </summary>
/// <param name="start">Row number at which to start reading.</param>
/// <param name="pageLength">Number of rows to return.</param>
/// <param name="ID"></param>
/// <returns>Returns a typed collection of Admin objects.</returns>
public AdminCollection GetByID(System.Int32 ID, int start, int pageLength)
{
return Repository.GetByID(ID, start, pageLength);
}
#endregion
#region "Get By Index Functions"
#endregion "Get By Index Functions"
#region "Insert Functions"
/// <summary>
/// Insert rows in the datasource.
/// </summary>
/// <param name="entityCollection"><c>Admin</c> objects in a <c>AdminCollection</c> object to insert.</param>
/// <remarks>
/// This function will only insert entity objects marked as dirty
/// and have an identity field equal to zero.
/// Upon inserting the objects, each dirty object will have the public
/// method <c>Object.AcceptChanges()</c> called to make it clean.
/// After inserting into the datasource, the <c>Admin</c> objects will be updated
/// to refelect any changes made by the datasource. (ie: identity columns)</remarks>
/// <returns>Returns the number of successful insert.</returns>
public int Insert(AdminCollection entityCollection)
{
int number = 0;
//Extract only dirty objects to save time and bandwidth
foreach (Admin entity in entityCollection)
{
if (entity.IsNew)
{
if ( Insert(entity) )
{
number++;
}
}
}
return number;
}
/// <summary>
/// Inserts a Admin object into the datasource using a transaction.
/// </summary>
/// <param name="entity">Admin object to insert.</param>
/// <remarks>After inserting into the datasource, the Admin object will be updated
/// to refelect any changes made by the datasource. (ie: identity columns)</remarks>
/// <returns>Returns true if operation is successful.</returns>
public bool Insert(Admin entity)
{
return Repository.Insert(entity);
}
#endregion
#region "Update Functions"
/// <summary>
/// Update existing rows in the datasource.
/// </summary>
/// <param name="entityCollection"><c>Admin</c> objects in a <c>AdminCollection</c> object to update.</param>
/// <remarks>
/// This function will only update entity objects marked as dirty
/// and do not have an primary key value of 0.
/// Upon updating the objects, each dirty object will have the public
/// method <c>Object.AcceptChanges()</c> called to make it clean.
/// After updating the datasource, the <c>Admin</c> objects will be updated
/// to refelect any changes made by the datasource. (ie: identity columns)</remarks>
/// <returns>Returns the number of successful update.</returns>
public int Update(AdminCollection entityCollection)
{
int number = 0;
foreach (Admin entity in entityCollection)
{
if ((entity.IsDirty) && !(entity.IsNew))
{
if ( Update(entity) )
{
number++;
}
}
}
return number;
}
/// <summary>
/// Update an existing row in the datasource.
/// </summary>
/// <param name="entity">Admin object to update.</param>
/// <remarks>After updating the datasource, the Admin object will be updated
/// to refelect any changes made by the datasource. (ie: identity columns)</remarks>
/// <returns>Returns true if operation is successful.</returns>
public bool Update(Admin entity)
{
return Repository.Update(entity);
}
#endregion
#region "Save Functions"
/// <summary>
/// Save rows changes in the datasource (insert, update ,delete).
/// </summary>
/// <param name="entity">Admin object to update.</param>
/// <remarks>
/// After updating the datasource, the <c>Admin</c> objects will be updated or inserted
/// to refelect any changes made by the datasource. (ie: identity columns)</remarks>
/// <returns>Returns true if operation is successful.</returns>
public void Save(Admin entity)
{
if (entity.IsDeleted)
Delete(entity);
else if ((entity.IsDirty) && !(entity.IsNew))
Update(entity);
else if (entity.IsNew)
Insert(entity);
}
/// <summary>
/// Save rows changes in the datasource (insert, update ,delete).
/// </summary>
/// <param name="entityCollection"><c>Admin</c> objects in a <c>AdminCollection</c> object to save.</param>
/// <remarks>
/// After updating the datasource, the <c>Admin</c> objects will be updated or inserted
/// to refelect any changes made by the datasource. (ie: identity columns)</remarks>
/// <returns>Returns true if operation is successful.</returns>
public void Save(AdminCollection entityCollection)
{
foreach (Admin entity in entityCollection)
{
Save(entity);
}
}
#endregion
#region "Helper Functions"
///<summary>
/// Fill an AdminCollection From a DataSet
///</summary>
/// <param name="dataSet">the DataSet</param>
/// <param name="rows">The collection to fill</param>
/// <param name="start">Start row</param>
/// <param name="pageLength">number of row.</param>
///<returns><see chref="AdminCollection"/></returns>
protected static AdminCollection Fill(DataSet dataSet, AdminCollection rows, int start, int pageLength)
{
int recordnum = 0;
System.Collections.IEnumerator dataRows = dataSet.Tables[0].Rows.GetEnumerator();
while (dataRows.MoveNext() && (pageLength != 0))
{
if(recordnum >= start)
{
DataRow row = (DataRow)dataRows.Current;
Admin c = new Admin();
c.ID = (Convert.IsDBNull(row["ID"]))?(int)0:(System.Int32)row["ID"];
c.OriginalID = (Convert.IsDBNull(row["ID"]))?(int)0:(System.Int32)row["ID"];
c.AdminID = (Convert.IsDBNull(row["AdminID"]))?string.Empty:(System.String)row["AdminID"];
c.ChangeStamp = (Convert.IsDBNull(row["ChangeStamp"]))?DateTime.MinValue:(System.DateTime)row["ChangeStamp"];
c.AcceptChanges();
rows.Add(c);
pageLength -= 1;
}
recordnum += 1;
}
return rows;
}
/// <summary>
/// Refreshes the <see cref="Admin"/> object from the <see cref="DataSet"/>.
/// </summary>
/// <param name="dataSet">The <see cref="DataSet"/> to read from.</param>
/// <param name="entity">The <see cref="Admin"/> object.</param>
protected static void RefreshEntity(DataSet dataSet, Admin entity)
{
DataRow dataRow = dataSet.Tables[0].Rows[0];
entity.ID = (Convert.IsDBNull(dataRow["ID"]))?(int)0:(System.Int32)dataRow["ID"];
entity.OriginalID = (Convert.IsDBNull(dataRow["ID"]))?(int)0:(System.Int32)dataRow["ID"];
entity.AdminID = (Convert.IsDBNull(dataRow["AdminID"]))?string.Empty:(System.String)dataRow["AdminID"];
entity.ChangeStamp = (Convert.IsDBNull(dataRow["ChangeStamp"]))?DateTime.MinValue:(System.DateTime)dataRow["ChangeStamp"];
entity.AcceptChanges();
}
#region DeepLoad
#region Deep Load By Entity
/// <summary>
/// Deep Load the IEntity object with all of the child
/// property collections only 1 Level Deep.
/// </summary>
/// <remarks>
/// <seealso cref="DeepLoad"/> overloaded methods for a recursive N Level deep loading method.
/// </remarks>
/// <param name="entity">Admin Object</param>
public void DeepLoad(Admin entity)
{
DeepLoad(entity, false, DeepLoadType.ExcludeChildren, new Type[] {});
}
/// <summary>
/// Deep Load the IEntity object with all of the child
/// property collections only 1 Level Deep.
/// </summary>
/// <remarks>
/// <seealso cref="DeepLoad"/> overloaded methods for a recursive N Level deep loading method.
/// </remarks>
/// <param name="entity">Admin Object</param>
/// <param name="deep">Boolean. A flag that indicates whether to recursively save all Property Collection that are descendants of this instance. If True, saves the complete object graph below this object. If False, saves this object only. </param>
public void DeepLoad(Admin entity, bool deep)
{
DeepLoad(entity, deep, DeepLoadType.ExcludeChildren, new Type[] {});
}
/// <summary>
/// Deep Loads the <see cref="IEntity"/> object with criteria based of the child
/// property collections only N Levels Deep based on the <see cref="DeepLoadType"/>.
/// </summary>
/// <remarks>
/// Use this method with caution as it is possible to DeepLoad with Recursion and traverse an entire object graph.
/// </remarks>
/// <param name="entity">The <see cref="Admin"/> object to load.</param>
/// <param name="deep">Boolean. A flag that indicates whether to recursively save all Property Collection that are descendants of this instance. If True, saves the complete object graph below this object. If False, saves this object only. </param>
/// <param name="deepLoadType">DeepLoadType Enumeration to Include/Exclude object property collections from Load.</param>
/// <param name="childTypes">Admin Property Collection Type Array To Include or Exclude from Load</param>
public void DeepLoad(Admin entity, bool deep, DeepLoadType deepLoadType, System.Type[] childTypes)
{
#region Argument Validation
//Argument checks
if (entity == null)
{
throw new ArgumentNullException("The argument Admin, can not be null.");
}
if (!Enum.IsDefined(typeof(DeepLoadType), deepLoadType))
{
throw new ArgumentNullException("A valid DeepLoadType option is not present.");
}
if (childTypes == null)
{
throw new ArgumentNullException("A valid Type[] array is not present.");
}
#endregion
//In case an event can trigger the disabling of the deep load
if (deepLoadType == DeepLoadType.Ignore)
{
return;
}
//Create a HashTable list of types for easy access
Hashtable innerList = new Hashtable(childTypes.Length);
for(int i=0; i < childTypes.Length; i++)
{
innerList.Add(childTypes[i], childTypes[i].ToString());
}
Debug.Indent();
Debug.WriteLine("DeepLoad object 'Admin'");
Debug.Indent();
// Load Entity through Provider
Debug.Unindent();
Debug.Unindent();
Debug.WriteLine("");
return;
}
#endregion
#region Deep Load By Entity Collection
/// <summary>
/// Deep Loads the <see cref="AdminCollection"/> object with all of the child
/// property collections only 1 Level Deep.
/// </summary>
/// <remarks>
/// <seealso cref="DeepLoad"/> overloaded methods for a recursive N Level deep loading method.
/// </remarks>
/// <param name="entityCollection">the <see cref="AdminCollection"/> Object to deep loads.</param>
public void DeepLoad(AdminCollection entityCollection)
{
DeepLoad(entityCollection, false, DeepLoadType.ExcludeChildren, new Type[] {});
}
/// <summary>
/// Deep Loads the <see cref="AdminCollection"/> object.
/// </summary>
/// <remarks>
/// <seealso cref="DeepLoad"/> overloaded methods for a recursive N Level deep loading method.
/// </remarks>
/// <param name="entityCollection">the <see cref="AdminCollection"/> Object to deep loads.</param>
/// <param name="deep">Boolean. A flag that indicates whether to recursively save all Property Collection that are descendants of this instance. If True, saves the complete object graph below this object. If False, saves this object only. </param>
public void DeepLoad(AdminCollection entityCollection, bool deep)
{
DeepLoad(entityCollection, deep, DeepLoadType.ExcludeChildren, new Type[] {});
}
/// <summary>
/// Deep Loads the entire <see cref="AdminCollection"/> object with criteria based of the child
/// property collections only N Levels Deep based on the DeepLoadType.
/// </summary>
/// <remarks>
/// Use this method with caution as it is possible to DeepLoad with Recursion and traverse an entire collection's object graph.
/// </remarks>
/// <param name="entityCollection">The <see cref="AdminCollection"/> instance to load.</param>
/// <param name="deep">Boolean. A flag that indicates whether to recursively save all Property Collection that are descendants of this instance. If True, saves the complete object graph below this object. If False, saves this object only. </param>
/// <param name="deepLoadType"><see cref="DeepLoadType"/> Enumeration to Include/Exclude object property collections from Load.
/// Use DeepLoadType.[IncludeChildren/ExcludeChildren]WithRecursion to traverse the entire object graph.
/// </param>
/// <param name="childTypes"><see cref="Admin"/> Property Collection Type Array To Include or Exclude from Load</param>
public void DeepLoad(AdminCollection entityCollection, bool deep, DeepLoadType deepLoadType, System.Type[] childTypes)
{
#region Argument Validation
//Argument checks
if (entityCollection == null)
{
throw new ArgumentNullException("A valid non-null, AdminCollection object is not present.");
}
if (!Enum.IsDefined(typeof(DeepLoadType), deepLoadType))
{
throw new ArgumentNullException("A valid DeepLoadType option is not present.");
}
if (childTypes == null)
{
throw new ArgumentNullException("A valid Type[] array is not present.");
}
#endregion
//In case an event can trigger the disabling of the deepload
if (deepLoadType == DeepLoadType.Ignore)
{
return;
}
foreach (Admin entity in entityCollection)
{
DeepLoad(entity, deep, deepLoadType, childTypes);
}
return;
}
#endregion
#endregion
#region DeepSave
#region Deep Save By Entity
/// <summary>
/// Deep Save the <see cref="Admin"/> object with all of the child
/// property collections N Levels Deep.
/// </summary>
/// <param name="entity">Admin Object</param>
public bool DeepSave(Admin entity)
{
return DeepSave(entity, DeepSaveType.ExcludeChildren, new Type[] {} );
}
/// <summary>
/// Deep Save the entire object graph of the Admin object with criteria based of the child
/// Type property array and DeepSaveType.
/// </summary>
/// <param name="entity">Admin Object</param>
/// <param name="deepSaveType">DeepSaveType Enumeration to Include/Exclude object property collections from Save.
/// </param>
/// <param name="childTypes">Admin Property Collection Type Array To Include or Exclude from Save</param>
public bool DeepSave(Admin entity, DeepSaveType deepSaveType, System.Type[] childTypes)
{
#region Argument Validation
//Argument checks
if (entity == null)
{
throw new ArgumentNullException("The argument Admin, can not be null.");
}
if (!Enum.IsDefined(typeof(DeepSaveType), deepSaveType))
{
throw new ArgumentNullException("A valid DeepSaveType option is not present.");
}
if (childTypes == null)
{
throw new ArgumentNullException("A valid Type[] array is not present.");
}
#endregion
//In case an event can trigger the disabling of the deepsave
if (deepSaveType == DeepSaveType.Ignore)
{
return true;
}
//Create a HashTable list of types for easy access
Hashtable innerList = new Hashtable(childTypes.Length);
for(int i=0; i < childTypes.Length; i++)
{
innerList.Add(childTypes[i], childTypes[i].ToString());
}
// Save Root Entity through Provider
AdminRepository rep = new AdminRepository();
rep.Save(entity);
return true;
}
#endregion
#region Deep Save By Entity Collection
/// <summary>
/// Deep Save the entire AdminCollection object with all of the child
/// property collections.
/// </summary>
/// <param name="entityCollection">AdminCollection Object</param>
public bool DeepSave(AdminCollection entityCollection)
{
return DeepSave(entityCollection, DeepSaveType.ExcludeChildren, new Type[] {});
}
/// <summary>
/// Deep Save the entire object graph of the AdminCollection object with criteria based of the child
/// property collections.
/// </summary>
/// <param name="entityCollection">AdminCollection Object</param>
/// <param name="deepSaveType">DeepSaveType Enumeration to Include/Exclude object property collections from Save.</param>
/// <param name="childTypes">Admin Property Collection Type Array To Include or Exclude from Save</param>
public bool DeepSave(AdminCollection entityCollection, DeepSaveType deepSaveType, System.Type[] childTypes)
{
#region Argument Validation
//Argument checks
if (entityCollection == null)
{
throw new ArgumentNullException("A valid non-null, AdminCollection object is not present.");
}
if (!Enum.IsDefined(typeof(DeepSaveType), deepSaveType))
{
throw new ArgumentNullException("A valid DeepSaveType option is not present.");
}
if (childTypes == null)
{
throw new ArgumentNullException("A valid Type[] array is not present.");
}
#endregion
//In case an event can trigger the disabling of the deepsave
if (deepSaveType == DeepSaveType.Ignore)
{
return true;
}
bool deepSaveResult = true;
bool result;
foreach (Admin entity in entityCollection)
{
result = DeepSave(entity, deepSaveType, childTypes);
if (!result){
deepSaveResult = false;
}
}
return deepSaveResult;
}
#endregion
#endregion
#endregion "Helper Functions"
}//end class
} // end namespace