Click here to Skip to main content
15,884,176 members
Articles / Programming Languages / C#
Tip/Trick

Object Relational Mapping via Reflection

Rate me:
Please Sign up or sign in to vote.
4.50/5 (4 votes)
14 Jun 2011CPOL 24.5K   7   4
Illustrates how to quickly and dynamically populate an object from a data-row
Before I learned about reflection, performing object-relational mapping was a painful and slow task.

You would design your Data-Object with attributes similar to the database table it would accept data from, then there would be the long and painful process of initializing the object from the data row.

This would lead to lots of code that looked like this:

// load customer details from row:
this.customerid = (int)customerRow["customerid"];
this.namefirst  = (string)customerRow["namefirst"];
this.namelast   = (string)customerRow["namelast"];


Which is just painful.

But, with one simple extension method, this code could be replaced by:

this.SetPropertiesFrom(customerRow);


Regardless of the number of fields, for any object...

How does it work?

Reflection allows you to examine any object's properties, methods, fields etc at run-time.

the SetPropertiesFrom method simply enumerates the object's public properties, and sets the value for each one that has a matching column in the data-row.

The only restriction is that the pubic properties of the object being populated must match the column names of the table. However this could be overcome by adding custom attribute decorations to the properties to indicate the source field, but that is a topic for a full article.

Here is the method in full, as an extension method for Object. Anywhere this class is in scope, each object will gain the SetPropertiesFrom method.

C#
/// <summary>
/// extension methods that allow dynamic population of data objects through reflection
/// </summary>
public static class DynamicDataExtensions
{
    /// <summary>
    /// populate the public properties of this object from a data-row;
    /// </summary>
    /// <param name="obj"></param>
    /// <param name="row"></param>
    public static void SetPropertiesFrom(this Object obj, DataRow row)
    {
        // enumerate the public properties of the object:
        foreach (PropertyInfo property in obj.GetType().GetProperties())
        {
            // does the property name appear as a column in the table?
            if (row.Table.Columns.Contains(property.Name))
            {
                // get the data-column:
                DataColumn column = row.Table.Columns[property.Name];

                // get the value of the column from the row:
                object value = row[column];

                // set the value on the property:
                if (!(value is DBNull))
                    property.SetValue(obj, Convert.ChangeType(value, property.PropertyType), null);

            }
        }
    }
}

License

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


Written By
Software Developer (Senior) Decipha
Australia Australia
Wrote his first computer game in Microsoft Basic, on a Dragon 32 at age 7. It wasn't very good.
Has been working as a consultant and developer for the last 15 years,
Discovered C# shortly after it was created, and hasn't looked back.
Feels weird talking about himself in the third person.

Comments and Discussions

 
Generalentity framework? Pin
johannesnestler26-Jun-11 10:06
johannesnestler26-Jun-11 10:06 
GeneralReason for my vote of 3 Such reflection is much slower then ... Pin
Kelqualyn23-Jun-11 8:44
Kelqualyn23-Jun-11 8:44 
GeneralRe: I am very interested in how you would re-write this to be a... Pin
Simon Bridge14-Jul-11 19:52
Simon Bridge14-Jul-11 19:52 
GeneralReason for my vote of 5 This is going to come in very useful... Pin
Just Russell20-Jun-11 21:09
professionalJust Russell20-Jun-11 21:09 

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

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