Blue Theme Orange Theme Green Theme Red Theme
 
Home | Forums | Videos | Photos | Blogs | Beginners
 | Consulting  
Submit an Article Submit a Blog 
 Jump to
Skip Navigation Links
TechnologyExpand Technology
WebsiteExpand Website
 Resources  
Close
 Our Network  
Close
Search :       Advanced Search »
Home » VB.NET » Sorting Collection of Custom Type using Generic

Sorting Collection of Custom Type using Generic


This article shows a simple and easy way to sort the business object collection using generic.

Total page views :  7479
Total downloads :  50
   Print Read/Post comments Post a comment  Similar Articles  
   Email to a friend  Bookmark  Author's other articles  
Download Files:
GenericSortingSample.zip
 
Become a Sponsor

Introduction:

This article describes the sorting techinque using Generic that can be implemented in any custom type collection based on the selected property.

For sorting any custom type the class must implement the System.IComparable interface which allow the object to be sorted based on some specified key.

Here is the definition:

Public Interface IComparable

 

    Function CompareTo(ByVal o As Object) As Integer

End Interface

Now let us assume we have a Car class and if we want to sort the collection of car objects then we must implement IComparable interface and put the logic of how our car object is to be sorted in the CompareTo method

Public Class Car

    Implements IComparable

 

    Function IComparable.CompareTo(ByVal obj As Object) As Integer

        Dim temp As Car = CType(obj, Car)

        If Me.carID > temp.carID Then

            Return 1

        End If

        If Me.carID < temp.carID Then

            Return -1

        Else

            Return 0

        End If

    End Function

End Class

 

As you can see, the logic behind CompareTo() is to test the incoming type against the current instance based on a specific point of data. The return value of CompareTo() is used to discover if this type is less than, greater than, or equal to the object it is being compared with (see below).

CompareTo() Return Value Meaning
Any number less than zero This instance comes before the specified object in the sort order.
Zero This instance is equal to the specified object.
Any number greater than zero This instance comes after the specified object in the sort order.

Now if suppose we have more object in our application for example bus, two wheeler etc. then for each object we have to implement the IComparable interface in all the classes and implement the CompareTo() method.

The ideal solution is to take advantage of the Generic and developed a Generic Comparable class which can be used by any of the business object in our system.

Here is the code for doing it.

#Region "directives" 

Imports Microsoft.VisualBasic

Imports System

Imports System.Collections.Generic

Imports System.Collections

Imports System.Text

Imports System.Reflection

#End Region

 

Namespace GenericSortComponent

 

    ''' <summary>

    ''' This class is used to compare any

    ''' type(property) of a class for sorting.

    ''' This class automatically fetches the

    ''' type of the property and compares.

    ''' </summary>

    Public NotInheritable Class GenericComparer(Of T)

          Implements IComparer(Of T)

              Public Enum SortOrder

                  Ascending

                  Descending

              End Enum

 

              #Region "member variables"

              Private sortColumn_Renamed As String

              Private sortingOrder_Renamed As SortOrder

              #End Region

 

              #Region "constructor"

              Public Sub New(ByVal sortColumn_Renamed As String, ByVal sortingOrder_Renamed As SortOrder)

                  Me.sortColumn_Renamed = sortColumn_Renamed

                  Me.sortingOrder_Renamed = sortingOrder_Renamed

              End Sub

              #End Region

 

              #Region "public property"

              ''' <summary>

              ''' Column Name(public property of the class) to be sorted.

              ''' </summary>

              Public ReadOnly Property SortColumn() As String

                  Get

                      Return sortColumn_Renamed

                  End Get

              End Property

 

              ''' <summary>

              ''' Sorting order.

              ''' </summary>

              Public ReadOnly Property SortingOrder() As SortOrder

                  Get

                      Return sortingOrder_Renamed

                  End Get

              End Property

              #End Region

 

              #Region "public methods"

              ''' <summary>

              ''' Compare interface implementation

              ''' </summary>

              ''' <param name="x">First Object</param>

              ''' <param name="y">Second Object</param>

              ''' <returns>Result of comparison</returns>

              Public Function Compare(ByVal x As T, ByVal y As T) As Integer Implements IComparer(Of T).Compare

                  Dim propertyInfo As PropertyInfo = GetType(T).GetProperty(sortColumn_Renamed)

                  Dim obj1 As IComparable = CType(propertyInfo.GetValue(x, Nothing), IComparable)

                  Dim obj2 As IComparable = CType(propertyInfo.GetValue(y, Nothing), IComparable)

                  If sortingOrder_Renamed = SortOrder.Ascending Then

                      Return (obj1.CompareTo(obj2))

                  Else

                      Return (obj2.CompareTo(obj1))

                  End If

              End Function

              #End Region

 

    End Class

End Namespace

 

Now suppose we have a Car class with property CarID and CarName then the below code demonstrate the sorting using GenericComparer class describe above.

Shared Sub Main(ByVal args As String())

    Dim cars As List(Of Car) = New List(Of Car)()

    cars.Add(New Car(1, "Maruti 800"))

    cars.Add(New Car(2, "Honda City"))
    .....

    .....

    cars.Sort(New GenericComparer(Of Car)("CarName", GenericComparer(Of Car).SortOrder.Ascending))

    .....

    .....
    'display here                         
End Sub

 

Here in the above main method the cars contains a collection of Car object.

Now we pass the instance of GenericComparer class in the cars.Sort() method with the Sort Field and Sort Order passed in the constructor of the GenericComparer.
 

NOTE: THIS ARTICLE IS CONVERTED FROM C# TO VB.NET USING A CONVERSION TOOL. ORIGINAL ARTICLE CAN BE FOUND ON C# CORNER (http://www.c-sharpcorner.com/).


Login to add your contents and source code to this article
 About the author
 
Dipen Lama
Dipen is a .Net Developer and has arround 5yrs of experience building application in .Net 1.x/2.0/3.0.
Looking for C# Consulting?
C# Consulting is founded in 2002 by the founders of C# Corner. Unlike a traditional consulting company, our consultants are well-known experts in .NET and many of them are MVPs, authors, and trainers. We specialize in Microsoft .NET development and utilize Agile Development and Extreme Programming practices to provide fast pace quick turnaround results. Our software development model is a mix of Agile Development, traditional SDLC, and Waterfall models.
Click here to learn more about C# Consulting.
 
Introducing MaxV - one click. infinite control. Hyper-V Hosting from MaximumASP.
Finally – a virtual platform that delivers next-generation Windows Server 2008 Hyper-V virtualization technology from a managed hosting partner you can truly depend on. Visit www.maximumasp.com/max for a FREE 30 day trial. Hurry offer ends soon. Climb aboard the MaxV platform and take advantage of High Availability, Intelligent Monitoring, Recurrent Backups, and Scalability – with no hassle or hidden fees. As a managed hosting partner focused solely on Microsoft technologies since 2000, MaximumASP is uniquely qualified to provide the superior support that our business is built on. Unparalleled expertise with Microsoft technologies lead to working directly with Microsoft as first to offer IIS 7 and SQL 2008 betas in a hosted environment; partnering in the Go Live Program for Hyper-V; and product co-launches built on WS 2008 with Hyper-V technology.
Dynamic PDF
ceTE software specializes in components for dynamic PDF generation and manipulation. The DynamicPDF™ product line allows you to dynamically generate PDF documents, merge PDF documents and new content to existing PDF documents from within your applications.
SQL and .NET performance profiling in one place
Investigate SQL and .NET code side-by-side with ANTS Performance Profiler 6, so you can see which is causing the problem without switching tools.
Go.NET
Build custom interactive diagrams, network, workflow editors, flowcharts, or software design tools. Includes many predefined kinds of nodes, links, and basic shapes. Supports layers, scrolling, zooming, selection, drag-and-drop, clipboard, in-place editing, tooltips, grids, printing, overview window, palette. 100% implemented in C# as a managed .NET Control. Document/View/Tool architecture with many properties&events. Optional automatic layout.
Dundas Software
Dundas Chart for .NET is the most advanced .NET charting package available today.  With an extremely complete feature set, elegant architecture and easy implementation, Dundas Chart can quickly add advanced Charting functionality to enhance and transform ASP.NET and Windows Forms applications.  Whether you are implementing charting into internal projects, or building applications for clients, Dundas Chart offers advanced technology and advanced results to get the most out of data.
60 FREE UI Controls from DevExpress
Register for your FREE copy on over 60 free presentation controls from DevExpress - Absolutely Free-of-Charge without any royalties or distribution costs. Visit Devexpress.com/60 today. Free controls include advanced lists box, dropdown calendar, rich text edit, spin edit, tab control and so much more!

DevExpress engineers feature rich presentation controls and reporting tools for WinForms, ASP.NET, WPF, and Silverlight. Our technologies help you build your best, see complex software with greater clarity and deliver compelling business solutions for Windows and the web in the shortest possible time.
Clickatell's SMS Gateway
Clickatell's Developer Solutions allow you to SMS enable any website or application via a range of API's. Learn More about our API connections.
Free access to .NET Memory Management video
Everything you need to know about Garbage Collection, Temporary Objects, Fragmentation, Finalization and common causes of memory leaks in .NET. Watch the video here.
Microsoft Visual Studio 2010
Visualize your workspace with new multiple monitor support, powerful Web development, new SharePoint support with tons of templates and Web parts, and more accurate targeting of any version of the .NET Framework. Get set to unleash your creativity.
Nevron Chart for .NET 2010.1 Now Available
The leading .NET charting control now features PDF, Flash and Silverlight export, visualization of large datasets and more. Deliver true charting functionality to your BI, Scorecard, Presentation or Scientific apps. Download evaluation now.
Developer-Ready ASP.NET 2.0 Web Hosting with 3 MONTHS FREE
Now supporting .NET 3.0 Framework with Windows Workflow Foundation, Windows Communication Foundation (WCF), Windows Presentation Foundation (WPF), windows CardSpace (WCS)! Providing more flexibility for Developers with Web Services Support and a User/Permission Manger. Also supporting MS SQL 2005/2000 with Real-Time Backups, FREE Automated Attach .MDF Tool, FREE SQL Restore and Shrink SQL DB Tools, and SQL
Read the Top 10 Books for Microsoft Developers, 15 Days FREE
Read the Top 10 Books for Microsoft Developers, 15 Days FREE
Try Safari Books Online - 15 Days FREE + 15% Off for 1 Year
Try Safari Books Online - 15 Days FREE + 15% Off for 1 Year
 
 Post a Feedback, Comment, or Question about this article
Subject:
Comment:
ASP.Net 4 Hosting is here
Become a Sponsor
 Comments

 Hosted by MaximumASP  |  Found a broken link?  |  Contact Us  |  Terms & conditions  |  Privacy Policy  |  Site Map  |  Suggest an Idea  |  Media Kit
Current Version: 5.2010.8.14
 © 2010  contents copyright of their authors. Rest everything copyright Mindcracker. All rights reserved.