Learn More





DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact .

The use of the Community Blog is covered by our Community Blog Guidelines - please read before commenting or posting.

4.6.0 A Sneak Peek (3) - IHydratable part 1

This blog is the third in a series looking at the new features in the next release of DotNetNuke, and focusses on the new IHydratable interface.  There are two pieces to this interface, which is designed to make it easier to hydrate your business objects but still take advantage of some of the performance strategies introduced recently (4.4).

Prior to 4.4 most business objects were hydrated by passing a DataReader to the CBO class's FillObject or FillCollection methods.  These methods use reflection to set the various properties of a business object and while this is convenient it is not neccesasrily the fastest way to hydrate business objects.

In 4.4 we focussed on performance improvements and a number of the core business controller classes were modifed to use custom hydrators to fill the business objects in order to improve the performance of DotNetNuke.  You can see examples of this in TabController, PortalController and ModuleController.  The problem with this approach is that the developer has to manage the DataReader - it is critical that the DataReader gets closed when it is finished with or the underlying connection to the database remains open.  By comparison, the CBO class manages these connections and ensures they are closed correctly.

Enter IHydratable.  This interface provides a property - KeyID (more in a later Blog) and a method - Fill.  If a business entity class implements this interface, then the developer can take advantage of both the performance gain of custom hydration AND the ease-of-use of the CBO class's DataReader management (You can have your cake and eat it too).

How is this achieved?  The CBO method that hydrates the object (CreateObject) first checks if the object implements the IHydratable interface.  If it does it calls the Fill method in the business object - if it doesn't then it uses refection as before.

            Dim objObject As Object = Activator.CreateInstance(objType)

            If TypeOf objObject Is IHydratable Then
                'Create Object and Use IHydratable's Fill
                Dim objHydratable As IHydratable = TryCast(objObject, IHydratable)
                If objHydratable IsNot Nothing Then
                End If
                    .... Previous code that uses reflection is here
            End If

As an example here is the Fill method for Announcements:

        Public Sub Fill(ByVal dr As IDataReader) Implements IHydratable.Fill

            ItemId = Convert.ToInt32(Null.SetNull(dr.Item("ItemID"), ItemId))
            ModuleId = Convert.ToInt32(Null.SetNull(dr.Item("ModuleID"), ModuleId))
            Title = Convert.ToString(Null.SetNull(dr.Item("Title"), Title))
            Url = Convert.ToString(Null.SetNull(dr.Item("Url"), Url))
            ViewOrder = Convert.ToInt32(Null.SetNull(dr.Item("ViewOrder"), ViewOrder))
            Description = Convert.ToString(Null.SetNull(dr.Item("Description"), Description))
            ImageSource = Convert.ToString(Null.SetNull(dr.Item("ImageSource"), ImageSource))
            CreatedByUser = Convert.ToInt32(Null.SetNull(dr.Item("CreatedByUser"), CreatedByUser))
            CreatedDate = Convert.ToDateTime(Null.SetNull(dr.Item("CreatedDate"), CreatedDate))
            TrackClicks = Convert.ToBoolean(Null.SetNull(dr.Item("TrackClicks"), TrackClicks))
            NewWindow = Convert.ToBoolean(Null.SetNull(dr.Item("NewWindow"), NewWindow))
            PublishDate = Convert.ToDateTime(Null.SetNull(dr.Item("PublishDate"), PublishDate))
            ExpireDate = Convert.ToDateTime(Null.SetNull(dr.Item("ExpireDate"), ExpireDate))

        End Sub


Comment Form

Only registered users may post comments.


2sic Daniel Mettler (124)
Aderson Oliveira (15)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (21)
Ben Schmidt (1)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (12)
Bill Walker (36)
Bob Kruger (5)
Brian Dukes (2)
Brice Snow (1)
Bruce Chapman (20)
Bryan Andrews (1)
cathal connolly (55)
Charles Nurse (163)
Chris Hammond (203)
Chris Paterra (55)
Clinton Patterson (28)
Cuong Dang (21)
Daniel Bartholomew (2)
Dave Buckner (2)
David Poindexter (3)
David Rodriguez (2)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (74)
Geoff Barlow (6)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (3)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (269)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (4)
Jordan Coopersmith (1)
Joseph Craig (2)
Kan Ma (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Malik Khan (1)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (3)
Michael Washington (202)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Peter Donker (52)
Philip Beadle (135)
Philipp Becker (4)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Wilkinson (3)
Scott Willhite (97)
Sebastian Leupold (80)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Tony Henrich (3)
Torsten Weggen (2)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (37)
Will Strohl (163)
William Severance (5)
Try Evoq
For Free
Start Free Trial
a Demo
See Evoq Live
Need More Information?