Map XML nodes to object's properties easily

Question

Returning from the Ruby world with its XML-to-hash mapping easiness I am looking forward to see something similar in C#.

Here is the source XML:

<whois-resources xmlns:xlink="http://www.w3.org/1999/xlink">
    <service name="search"/>
    <parameters>
        <inverse-lookup/>
        <type-filters/>
        <flags/>
        <query-strings>
            <query-string value="....."/>
        </query-strings>
        <sources/>
    </parameters>
    <objects>
        <object type="inetnum">
            <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/inetnum/....."/>
            <source id="ripe"/>
            <primary-key>
                <attribute name="inetnum" value="....."/>
            </primary-key>
            <attributes>
                <attribute name="inetnum" value="....."/>
                <attribute name="netname" value="....."/>
                <attribute name="descr" value="....."/>
                <attribute name="descr" value="....."/>
                <attribute name="country" value="....."/>
                <attribute name="admin-c" value="....." referenced-type="person">
                    <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/person/....."/>
                </attribute>
                <attribute name="tech-c" value="....." referenced-type="person">
                    <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/person/....."/>
                </attribute>
                <attribute name="status" value="ASSIGNED PA"/>
                <attribute name="mnt-by" value="....." referenced-type="mntner">
                    <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/mntner/....."/>
                </attribute>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="source" value="....." comment="Filtered"/>
            </attributes>
            <tags>
                <tag id="RIPE-USER-RESOURCE"/>
            </tags>
        </object>
        <object type="person">
            <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/person/....."/>
            <source id="ripe"/>
            <primary-key>
                <attribute name="nic-hdl" value="....."/>
            </primary-key>
            <attributes>
                <attribute name="person" value="....."/>
                <attribute name="address" value="....."/>
                <attribute name="address" value="....."/>
                <attribute name="address" value="....."/>
                <attribute name="phone" value="....."/>
                <attribute name="fax-no" value="....."/>
                <attribute name="nic-hdl" value="....."/>
                <attribute name="mnt-by" value="....." referenced-type="mntner">
                    <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/mntner/....."/>
                </attribute>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="source" value="....." comment="Filtered"/>
            </attributes>
        </object>
        <object type="route">
            <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/route/....."/>
            <source id="ripe"/>
            <primary-key>
                <attribute name="route" value="....."/>
                <attribute name="origin" value="....."/>
            </primary-key>
            <attributes>
                <attribute name="route" value="....."/>
                <attribute name="descr" value="....."/>
                <attribute name="origin" value="....." referenced-type="aut-num">
                    <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/aut-num/....."/>
                </attribute>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="remarks" value="....."/>
                <attribute name="mnt-by" value="....." referenced-type="mntner">
                    <link xlink:type="locator" xlink:href="http://rest.db.ripe.net/ripe/mntner/....."/>
                </attribute>
                <attribute name="source" value="....." comment="Filtered"/>
            </attributes>
        </object>
    </objects>
    <terms-and-conditions xlink:type="locator" xlink:href="http://www.ripe.net/db/support/db-terms-conditions.pdf"/>
</whois-resources>

which I would like to remap to an object with following structure:

{
    Service: {
        Name: "....."
    },
    Parameters: {
        QueryStrings: [".....", "....."]
    },
    Inetnum: {
        Link: {
            Type: ".....",
            Href: "....."
        },
        Source: {
            id: "....."
        },
        PrimaryKey: {
            Inetnum: "....."
        },
        Attr: {
            Inetnum: ".....",
            Netname: ".....",
            Descr: ".....",
            Country: ".....",
            AdminC: {
                Value: ".....",
                ReferencedType: ".....",
                Link: {
                    Type: ".....",
                    Href: "....."
                }
            },
            TechC: {
                Value: ".....",
                ReferencedType: ".....",
                Link: {
                    Type: ".....",
                    Href: "....."
                }
            },
            Status: ".....",
            MntBy: {
                Value: ".....",
                ReferencedType: ".....",
                Link: {
                    Type: ".....",
                    Href: "....."
                }
            }
            Remarks: ".....", #a concatenation of all remarks nodes
            Source: {
                Value: ".....",
                Comment: "....."
            }
        },
        Tags: [
            { id: "....." }
        ]
    },
    Person {
        Link: {
            Type: ".....",
            Href: "....."
        },
        Source: {
            id: "....."
        }
        PrimaryKey: {
            NicHdl: "....."
        },
        Attr: {
            Person: ".....",
            Address: ".....", #a concatenation of all address nodes
            Phone: ".....",
            FaxNo: ".....",
            NicHdl: ".....",
            MntBy: {
                Value: ".....",
                ReferencedType: ".....",
                Link: {
                    Type: ".....",
                    Href: "....."
                }
            }
            Remarks: ".....", #a concatenation of all remarks nodes
            Source: {
                Value: ".....",
                Comment: "....."
            }
        }
    },  
    Route: {
        Link: {
            Type: ".....",
            Href: "....."
        },
        Source: {
            id: "....."
        },
        PrimaryKey: {
            Route: ".....",
            Origin: "....."
        },
        Attr: {
            Route: ".....",
            Descr: ".....",
            Origin: {
                Value: ".....",
                ReferencedType: ".....",
                Link: {
                    Type: ".....",
                    Href: "....."
                }
            },
            Remarks: ".....", #a concatenation of all remarks nodes
            MntBy: {
                Value: ".....",
                ReferencedType: ".....",
                Link: {
                    Type: ".....",
                    Href: "....."
                }
            },
            Source: {
                Value: ".....",
                Comment: "....."
            }
        }
    },
    TermsAndConditions: {
        Type: ".....",
        Href: "....."
    }
}

to be able to call properties like:

whois.Inetnum.Attr.Netname

I completely dislike an idea to retrieve each node by calling SelectSingleNode("xpath");

The desired process is:

Define receiver object and all its subobjects
Define mapping rules
Parse XML string with a single method call

Why not just define the appropriate c# classes then deserialize to them with [`XmlSerializer`](https://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer%28v=vs.110%29.aspx)? — dbc, Mar 31 '15 at 18:50

score 3 · Answer 1 · answered Mar 31 '15 at 21:12

Here's a way of doing it.

You'll need to add the relevant references first (here's a few):

using System.Linq;

using System.Xml.Linq;

using System.Text;

using System.Xml;

using System.Xml.Serialization;

Create a wrapper class that will hold the deserialized data.

[XmlRoot("root")]
public class root
{
    [XmlElement("MyObject")]
    public List<MyObject> A_Object
    {
        get;
        set;
    }
}

Then the class that will hold the deserialized data, for example here it's MyObject:

public class MyObject {

[XmlElement("type")] //from your sample code route,person all go here
public string objType
{
    get;
    set;
}
[XmlElement("address")]
public string personAddr
{
    get;
    set;
}
[XmlElement("phone")]
public string personPhone
{
    get;
    set;
}

}

*Note: if you have properties you want to keep track of, but not be deserialized you can have properites that do not have the [XmlElement] there.

Finally deserialize your XML into the list of objects:

public List<myObject> DeserializeXML(string xmlPath) { XmlSerializer deserializer = new XmlSerializer(typeof(root)); List<myObject> objectList = new List<myObject>(); try { using (TextReader textReader = new StreamReader(xmlPath)) { root setOfObjects; setOfObjects = (root)deserializer.Deserialize(textReader); } objectList = setOfObjects.A_Object; } catch(FileNotFoundException a) { } return objectList; } 5. Then you can go ahead and manipulate it to whichever form you like, maybe serialize it differently again.

related tutorial: http://stackoverflow.com/questions/364253/how-to-deserialize-xml-document also don't forget to add serializable in the MyObject and root classes. :) — matrixanomaly, Mar 31 '15 at 21:14

Map XML nodes to object's properties easily

1 Answers1