Click here to Skip to main content
Click here to Skip to main content
Go to top

Tier Generator 1.0

, 26 Jul 2008
Rate this:
Please Sign up or sign in to vote.
A powerful tool for rapid application development.

Setup

Introduction

Tier Generator is a powerful tool for generating business and data layers in C#. It is a code generation tool that helps users to rapidly generate and deploy business and data layers for their applications. The idea behind this is to provide a utility (tool) to the developer that has the capabilities of quickly generating consistent and tested source code that will help to get projects started sooner and finished faster.

Tier Generator connects to a Microsoft SQL Server database server and generates business and data layers in C#. It also generates Stored Procedures for DML operations.

Business layer

Tier Generator generates code in two layers (business and data). It generates some classes for the each table in the database in the business layer. E.g., our database contains the table Employee. Tier Generator will generate the following files:

  • Employee
  • EmployeeKeys
  • EmployeeFactory

The Employee (business object) class contains the declaration of all instance fields along with properties. It also overrides the AddValidationRules method to associate the validation rules to the properties of the business object. It also contains an enum of all the fields.

public class Employee: BusinessObjectBase
{
   #region InnerClass

   public enum EmployeeFields
   {
     EmployeeID, Name, Password, Email, TeamID,DepartmentID, IsAdmin    
   }
    
   #endregion

   #region Data Members

   int _employeeID;
   string _name;
   string _password;
   string _email;
   int _teamID;
   int _departmentID;
   bool _isAdmin;

   #endregion

   #region Properties

   public int  EmployeeID
   {
     get { return _employeeID; }
     set
     {
        if (_employeeID != value)
        {
           _employeeID = value;
           PropertyHasChanged("EmployeeID");
        }
     }
   }

   public string  Name
   {
     get { return _name; }
     set
     {
       if (_name != value)
       {
         _name = value;
         PropertyHasChanged("Name");
       }
     }
   }
    .
    .
    .
    
   #endregion

   #region Validation

   internal override void AddValidationRules()
   {
     ValidationRules.AddRules(new Validation.ValidateRuleNotNull("EmployeeID", 
                                                                 "EmployeeID"));
     ValidationRules.AddRules(new Validation.ValidateRuleNotNull("Name", 
                                                                 "Name"));
     ValidationRules.AddRules(new Validation.ValidateRuleStringMaxLength("Name", 
                                                                    "Name",50));
     ValidationRules.AddRules(new Validation.ValidateRuleStringMaxLength("Password", 
                                                                         "Password",50));
     ValidationRules.AddRules(new Validation.ValidateRuleStringMaxLength("Email", 
                                                                         "Email",100));
     ValidationRules.AddRules(new Validation.ValidateRuleNotNull("TeamID", 
                                                                 "TeamID"));
     ValidationRules.AddRules(new Validation.ValidateRuleNotNull("DepartmentID", 
                                                                 "DepartmentID"));
     ValidationRules.AddRules(new Validation.ValidateRuleNotNull("IsAdmin", 
                                                                 "IsAdmin"));
   }

   #endregion
}

The EmpolyeesKeys (business object keys) class contains the list of primary keys of the table.

public class EmployeeKeys
{
    #region Data Members

    int _employeeID;

    #endregion

    #region Constructor

    public EmployeeKeys(int employeeID)
    {
      _employeeID = employeeID; 
    }

    #endregion

    #region Properties

    public int  EmployeeID
    {
      get { return _employeeID; }
    }

    #endregion

}

The EmployeeFactory (business factory) class contains the methods for the Insert, Delete, Update, and Select operations. It provides the following methods for the DML operations:

  • public bool Insert(Employee businessObject)
  • public bool Update(Employee businessObject)
  • public Employee GetByPrimaryKey(EmployeeKeys keys)
  • public List<Employee> GetAll()
  • public List<Employee> GetAllBy(Employee.EmployeeFields fieldName, object value)
  • public bool Delete(EmployeeKeys keys)
  • public bool Delete(Employee.EmployeeFields fieldName, object value)

The factory class performs the DML operations with the help of the data layer.

public class EmployeeFactory
{
    #region data Members

    EmployeeSql _dataObject = null;

    #endregion

    #region Constructor

    public EmployeeFactory()
    {
      _dataObject = new EmployeeSql();
    }

    #endregion

    #region Public Methods

    public bool Insert(Employee businessObject)
    {
       if (!businessObject.IsValid)
       {
          throw new InvalidBusinessObjectException(
                           businessObject.BrokenRulesList.ToString());
       }

        return _dataObject.Insert(businessObject);

    }

    
    public bool Update(Employee businessObject)
    {
      if (!businessObject.IsValid)
      {
        throw new InvalidBusinessObjectException(
                         businessObject.BrokenRulesList.ToString());
      }
      
      return _dataObject.Update(businessObject);
    }

    public Employee GetByPrimaryKey(EmployeeKeys keys)
    {
       return _dataObject.SelectByPrimaryKey(keys); 
    }

     
    public List<Employee> GetAll()
    {
       return _dataObject.SelectAll(); 
    }

    public List<Employee> GetAllBy(Employee.EmployeeFields fieldName, 
                                         object value)
    {
      return _dataObject.SelectByField(fieldName.ToString(), value);  
    }

    public bool Delete(EmployeeKeys keys)
    {
       return _dataObject.Delete(keys); 
    }

    public bool Delete(Employee.EmployeeFields fieldName, object value)
    {
       return _dataObject.DeleteByField(fieldName.ToString(), value); 
    }

    #endregion

}

Data Layer

The data access file generated by the Tier Generator contains the methods for DML operations. It uses Stored Procedures for DML operations. The factory class methods call the data layer methods for insertion and deletion.

class EmployeeSql : DataLayerBase 
{
  
   #region Public Methods

   /// <span class="code-SummaryComment"><summary></span>
   /// insert new row in the table
   /// <span class="code-SummaryComment"></summary></span>
   /// <span class="code-SummaryComment"><param name="businessObject">business object</param></span>
   /// <span class="code-SummaryComment"><returns>true of successfully insert</returns></span>
   public bool Insert(Employee businessObject)
   {
     SqlCommand    sqlCommand = new SqlCommand();
       sqlCommand.CommandText = "dbo.[sp_Employee_Insert]";
       sqlCommand.CommandType = CommandType.StoredProcedure;

     // Use base class' connection object
     sqlCommand.Connection = MainConnection;

     try
     {                
       sqlCommand.Parameters.Add(new SqlParameter("@EmployeeID", SqlDbType.Int, 4, 
                                                  ParameterDirection.Output, 
                                                  false, 0, 0, "", 
                                                  DataRowVersion.Proposed, 
                                                  businessObject.EmployeeID));
       sqlCommand.Parameters.Add(new SqlParameter("@Name", SqlDbType.NVarChar, 
                                                  50, ParameterDirection.Input, 
                                                  false, 0, 0, "", 
                                                  DataRowVersion.Proposed, 
                                                  businessObject.Name));
       sqlCommand.Parameters.Add(new SqlParameter("@password", SqlDbType.NVarChar, 
                                                  50, ParameterDirection.Input, 
                                                  false, 0, 0, "", 
                                                  DataRowVersion.Proposed, 
                                                  businessObject.Password));
       sqlCommand.Parameters.Add(new SqlParameter("@Email", SqlDbType.NVarChar, 
                                                  100, ParameterDirection.Input, 
                                                  false, 0, 0, "", 
                                                  DataRowVersion.Proposed, 
                                                  businessObject.Email));
       sqlCommand.Parameters.Add(new SqlParameter("@TeamID", SqlDbType.Int, 
                                                  4, ParameterDirection.Input, 
                                                  false, 0, 0, "", 
                                                  DataRowVersion.Proposed, 
                                                  businessObject.TeamID));
       sqlCommand.Parameters.Add(new SqlParameter("@DepartmentID", SqlDbType.Int, 
                                                  4, ParameterDirection.Input, 
                                                  false, 0, 0, "", 
                                                  DataRowVersion.Proposed, 
                                                  businessObject.DepartmentID));
       sqlCommand.Parameters.Add(new SqlParameter("@IsAdmin", SqlDbType.Bit, 
                                                  1, ParameterDirection.Input, 
                                                  false, 0, 0, "", 
                                                  DataRowVersion.Proposed, 
                                                  businessObject.IsAdmin));
       MainConnection.Open();
       
       sqlCommand.ExecuteNonQuery();
       businessObject.EmployeeID = 
         (int)sqlCommand.Parameters["@EmployeeID"].Value;

       return true;
     }
     catch(Exception ex)
     {
       throw new Exception("Employee::Insert::Error occured.", ex);
     }
     finally
     {
       MainConnection.Close();
       sqlCommand.Dispose();
     }
  }

  #endregion
}

How to use

The code generated by the Tier Generator is easy to use. Open the generated project in Visual Studio 2005 and compile it. Run the Stored Procedures script in the the database which is generated by the Tier Generator. You can find the SQL script file in the generated folder.

Add a new Windows/web project in the existing project and add the DLL of the generated code to it. Add app.config for Windows applications and web.config for web applications. Get the connection string from the generated app.config file. You will get this file in the generated folder.

  <appSettings>
     <add key="Main.ConnectionString" 
             value="Data Source=localhost;Initial Catalog=School;
                    User Id=sa;Password=sa" />
  </appSettings>

Here is the code sample for inserting a new record:

public void AddNewRecord()
{
    Employee emp = new Employee();
    emp.EmployeeID = 1;
    emp.FirstName = "Shakeel";
    emp.LastName = "Iqbal";
    .
    .
    .
    .
    
    EmployeeFactory empFact = new EmployeeFactory();
    empFact.Insert(emp);
}

The code sample for selecting all the records:

public void SelectAll()
{
     EmployeeFactory empFact = new EmployeeFactory();
     List<Employee> list = empFact.GetAll();   
    
    dataGrid1.DataSource = list;
}

Future enhancements

I have some future enhancements planned for the Tier Generator, and I have plans to launch the next version of the Tier generator. In this version, I will improve my business and data layers, and I will also provide the following features:

  • Generate Windows application.
  • Generate Web application.
  • Generate Web Services.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Shakeel Iqbal
Software Developer (Senior) TEO
Pakistan Pakistan
Passion and positive dedication is essential part of success. I believe on hardworking and sharing knowledge with others. I always try to be a better than I am and think positive for positive result.
 
My Blogs
Follow on   Twitter   Google+

Comments and Discussions

 
GeneralRe: Have you abandoned this project PinmemberShakeel Iqbal2-Jan-10 5:50 
GeneralRe: Have you abandoned this project Pinmembergravbox8-Jan-10 16:37 
GeneralAdapted for SQL Compact PinmemberAtlas20024-Dec-09 4:34 
GeneralImpressive PinmemberVenerableBede25-Nov-09 2:28 
GeneralPlease Include BugList too PinmemberMember 159112717-Aug-09 1:14 
GeneralGreat Solution but few bugs and enhancements required PinmemberMember 159112717-Aug-09 1:08 
GeneralSQL 2005 Pinmembermtone15-Jul-09 9:21 
GeneralRe: SQL 2005 PinmemberShakeel Iqbal16-Jul-09 18:50 
Generalclosing Datareader Pinmemberflyingbaobao14-May-09 17:07 
GeneralWell done! PinmemberMember 27491296-Apr-09 7:52 
GeneralMulti Table PinmemberDawit Kiros1-Apr-09 20:02 
GeneralRe: Multi Table PinmemberShakeel Iqbal2-Apr-09 20:13 
GeneralRe: Multi Table PinmemberDawit Kiros4-Apr-09 8:31 
Question[Message Deleted] PinmemberDawit Kiros17-Mar-09 8:46 
AnswerRe: Badley need the Enhancement.......... PinmemberShakeel Iqbal17-Mar-09 8:59 
QuestionHow can I use Transactions with this tier? PinmemberMember 21090139-Mar-09 14:48 
AnswerRe: How can I use Transactions with this tier? PinmemberShakeel Iqbal10-Mar-09 5:49 
GeneralRe: How can I use Transactions with this tier? PinmemberMember 210901310-Mar-09 18:32 
GeneralExcellent work Pinmemberipadilla21-Jan-09 21:38 
GeneralNice Work PinmemberArpitDubey14-Nov-08 6:12 
Generalmulti database Pinmemberzhaojicheng2-Nov-08 17:14 
GeneralRe: multi database PinmemberShakeel Iqbal2-Nov-08 21:15 
GeneralRe: multi database Pinmemberzhaojicheng3-Nov-08 3:01 
GeneralMYSQL Databases PinmemberGokhan Mamaci30-Oct-08 8:59 
GeneralRe: MYSQL Databases PinmemberShakeel Iqbal31-Oct-08 8:18 
General[Message Removed] PinmemberKatekortez25-Oct-08 9:29 
GeneralPartial classes and a few other enhancements PinmemberKarijn22-Oct-08 22:57 
QuestionIs there anyone to address my problems? Pinmemberbilal haider9-Oct-08 23:49 
QuestionNice work and 2 questions? Pinmemberbilal haider8-Oct-08 2:49 
AnswerRe: Nice work and 2 questions? PinmemberShakeel Iqbal10-Oct-08 4:39 
GeneralShould ignore timestamp field Pinmembermac Moraleja23-Sep-08 22:27 
GeneralRe: Should ignore timestamp field PinmemberShakeel Iqbal24-Sep-08 0:13 
GeneralDatabase Case Sensitivity Issue PinmemberDave Herron8-Sep-08 8:01 
GeneralExcellent! Pinmemberloploplop8-Sep-08 4:18 
GeneralNice work ;-) PinmemberAsif Qadri3-Sep-08 17:24 
GeneralNice! PinmemberSpiff Dog2-Sep-08 21:48 
Generalyou got my 5 Pinmemberblack_zero27-Aug-08 19:29 
GeneralRe: you got my 5 PinmemberShakeel Iqbal28-Aug-08 0:53 
GeneralVery nice tool , But Pinmemberblack_zero27-Aug-08 19:28 
GeneralGreat Work n Congrats on winning prize PinmemberAftab Zaheer Satti26-Aug-08 19:58 
QuestionSchema bug [modified] Pinmembermm-2k31-Jul-08 23:11 
QuestionVery nice, but I have a request Pinmembertvlep30-Jul-08 10:52 
AnswerRe: Very nice, but I have a request PinmemberShakeel Iqbal30-Jul-08 20:46 
GeneralRe: Very nice, but I have a request Pinmembertvlep31-Jul-08 6:07 
GeneralRe: Very nice, but I have a request PinmemberShakeel Iqbal31-Jul-08 7:35 
GeneralFabulous Work PinmemberAfaak30-Jul-08 6:46 
GeneralRe: Fabulous Work PinmemberShakeel Iqbal30-Jul-08 6:48 
Generalterrific PinmemberMember 182785530-Jul-08 5:07 
GeneralNice Work buddy Pinmembernomiikram30-Jul-08 1:16 
Generalre: Pinmembergodself_zhang28-Jul-08 15:03 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.140916.1 | Last Updated 26 Jul 2008
Article Copyright 2008 by Shakeel Iqbal
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid