Alphabetical sorting of the XmlNodes : XML Node « XML « C# / C Sharp






Alphabetical sorting of the XmlNodes

  
#region License and Copyright
/*
 * Dotnet Commons Xml
 *
 *
 * This library is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published by 
 * the Free Software Foundation; either version 2.1 of the License, or 
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 
 * for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public License 
 * along with this library; if not, write to the 
 * Free Software Foundation, Inc., 
 * 59 Temple Place, 
 * Suite 330, 
 * Boston, 
 * MA 02111-1307 
 * USA 
 * 
 */
#endregion

using System;
using System.Collections;
using System.Collections.Specialized;
using System.Diagnostics;
using System.IO;
using System.Reflection;
using System.Text;
using System.Text.RegularExpressions;
using System.Xml;
using System.Xml.Xsl;
using System.Xml.Serialization;

//using Dotnet.Commons.Reflection;

namespace Dotnet.Commons.Xml
{
  
  ///  
  /// <summary>
  /// This utility class contains wrapper functions that help to ease the handling and 
    /// manipulation of Xml documents, such as adding an element, adding an attribute
    /// to an element, copying and cloning of nodes, etc.
  ///
  /// </summary>
  /// 
    
  public abstract class XmlUtils
  {
        // #################################################################### //
        // These code is derived from Mainsoft.com                              //
        // http://www.koders.com/csharp/fid439BB5BEF93D1AEFAF0B9206236AB0ECE49BC229.aspx
        // #################################################################### //


        /// -----------------------------------------------------------
        /// <summary>
        /// Alphabetical sorting of the XmlNodes 
        /// and their  attributes in the <see cref="System.Xml.XmlDocument"/>.
        /// </summary>
        /// <param name="document"><see cref="System.Xml.XmlDocument"/> to be sorted</param>
        /// -----------------------------------------------------------
        public static void SortXml(XmlDocument document)
        {
            SortXml(document.DocumentElement);
        }


        /// -----------------------------------------------------------
        /// <summary>
        /// Inplace pre-order recursive alphabetical sorting of the XmlNodes child 
        /// elements and <see cref="System.Xml.XmlAttributeCollection" />.
        /// </summary>
        /// <param name="rootNode">The root to be sorted.</param>
        /// -----------------------------------------------------------
        public static void SortXml(XmlNode rootNode)
        {
            SortAttributes(rootNode.Attributes);
            SortElements(rootNode);
            foreach (XmlNode childNode in rootNode.ChildNodes)
            {
                SortXml(childNode);
            }
        }

        /// -----------------------------------------------------------
        /// <summary>
        /// Sorts an attributes collection alphabetically.
        /// It uses the bubble sort algorithm.
        /// </summary>
        /// <param name="attribCol">The attribute collection to be sorted.</param>
        /// -----------------------------------------------------------
        public static void SortAttributes(XmlAttributeCollection attribCol)
        {
            if (attribCol == null) 
                return;            

            bool hasChanged = true;
            while (hasChanged)
            {
                hasChanged = false;
                for (int i = 1; i < attribCol.Count; i++)
                {
                    if (String.Compare(attribCol[i].Name, attribCol[i-1].Name, true) < 0)
                    {
                        //Replace
                        attribCol.InsertBefore(attribCol[i], attribCol[i - 1]);
                        hasChanged = true;
                    }
                }
            }

        }

        /// -----------------------------------------------------------
        /// <summary>
        /// Sorts a <see cref="XmlNodeList" /> alphabetically, by the names of the elements.
        /// It uses the bubble sort algorithm.
        /// </summary>
        /// <param name="node">The node in which its childNodes are to be sorted.</param>
        /// -----------------------------------------------------------
        public static void SortElements(XmlNode node)
        {
            bool changed = true;
            while (changed)
            {
                changed = false;
                for (int i = 1; i < node.ChildNodes.Count; i++)
                {
                    if (String.Compare(node.ChildNodes[i].Name, node.ChildNodes[i-1].Name, true) < 0)
                    {
                        //Replace:
                        node.InsertBefore(node.ChildNodes[i], node.ChildNodes[i-1]);
                        changed = true;
                    }
                }
            }
        }
   }
}

   
    
  








Related examples in the same category

1.Create an element type XmlNode like text value
2.Get the Xml Text node value
3.Set the value to the Element
4.Convert an XmlNode to an object
5.Adds the specified node to the end of the list of child nodes, of this node.
6.Gets an XmlAttributeCollection containing the attributes of this node.
7.Gets all the child nodes of the node.
8.Creates a duplicate of this node.
9.Creates an XPathNavigator for navigating this object.
10.Gets the first child of the node.
11.For each style iteration over the nodes in the XmlNode.
12.Looks up the closest xmlns declaration for the given namespace URI
13.Gets or sets the concatenated values of the node and all its child nodes.Gets or sets the concatenated values of the node and all its child nodes.
14.Inserts the specified node immediately after the specified reference node.
15.Inserts the specified node immediately before the specified reference node.
16.Gets the first child element with the specified Name.
17.Gets the last child of the node.
18.Gets the node immediately following this node.
19.Gets the markup representing this node and all its child nodes.
20.Adds node to the beginning of the list of child nodes
21.Gets the node immediately preceding this node.
22.Removes all the child nodes and/or attributes of the current node.
23.Removes specified child node.
24.Replaces the child node oldChild with newChild node.
25.Selects a list of nodes matching the XPath expression.
26.Select and display the value of all the ISBN attributes
27.Selects the first XmlNode that matches the XPath expression.
28.When overridden in a derived class, saves all the child nodes of the node to the specified XmlWriter.
29.Save the current node to the specified XmlWriter.