Vorgehensweise: Transformieren der Form einer XML-Struktur (LINQ to XML)

Die Form eines XML-Dokuments wird von dessen Elementnamen, Attributnamen und den Merkmalen seiner Hierarchie bestimmt.

Es kann passieren, dass Sie die Form eines XML-Dokuments ändern müssen. Dies kann z. B. der Fall sein, wenn Sie ein vorhandenes XML-Dokument an ein anderes System senden müssen, das andere Element- und Attributnamen verlangt. Sie können das Dokument zwar selbst durchgehen und die Elemente nach Bedarf löschen und umbenennen, bei Verwendung der funktionalen Konstruktion erhalten Sie aber besser lesbaren und verwaltbaren Code. Weitere Informationen zu funktionalen Konstruktionen finden Sie unter Funktionale Konstruktion.

Im ersten Beispiel in diesem Artikel wird die Organisation eines XML-Dokuments geändert. Dabei werden komplexe Elemente von einer Position in der Struktur an eine andere verschoben.

Im zweiten Beispiel wird ein XML-Dokument erstellt, dessen Form sich von der des Quelldokuments unterscheidet. Einige Elemente werden weggelassen, andere umbenannt, und die Groß-/Kleinschreibung der Elementnamen wird geändert.

Beispiel: Verwenden von eingebetteten Abfrageausdrücken zum Ändern der Form einer XML-Struktur

Im folgenden Beispiel wird die Form einer XML-Datei geändert, die eingebettete Abfrageausdrücke verwendet.

Das XML-Quelldokument in diesem Beispiel, Beispiel-XML-Datei: Kunden und Bestellungen, enthält unter dem Customers-Element ein Root-Element, das alle Kunden enthält. Außerdem enthält es unter dem Orders-Element ein Root-Element, das alle Aufträge enthält. Das Beispiel erstellt eine neue XML-Struktur, in der die Aufträge der einzelnen Kunden in einem Orders-Element innerhalb des Customer-Elements enthalten sind. Das ursprüngliche Element enthält auch ein CustomerID-Element im Order-Element; dieses Element wird in der neuen Struktur ausgelassen.

XElement co = XElement.Load("CustomersOrders.xml");
XElement newCustOrd =
    new XElement("Root",
        from cust in co.Element("Customers").Elements("Customer")
        select new XElement("Customer",
            cust.Attributes(),
            cust.Elements(),
            new XElement("Orders",
                from ord in co.Element("Orders").Elements("Order")
                where (string)ord.Element("CustomerID") == (string)cust.Attribute("CustomerID")
                select new XElement("Order",
                    ord.Attributes(),
                    ord.Element("EmployeeID"),
                    ord.Element("OrderDate"),
                    ord.Element("RequiredDate"),
                    ord.Element("ShipInfo")
                )
            )
        )
    );
Console.WriteLine(newCustOrd);
Dim co As XElement = XElement.Load("CustomersOrders.xml")
Dim newCustOrd = _
   <Root>
       <%= From cust In co.<Customers>.<Customer> _
           Select _
           <Customer>
               <%= cust.Attributes() %>
               <%= cust.Elements() %>
               <Orders>
                   <%= From ord In co.<Orders>.<Order> _
                       Where ord.<CustomerID>.Value = cust.@CustomerID _
                       Select _
                       <Order>
                           <%= ord.Attributes() %>
                           <%= ord.<EmployeeID> %>
                           <%= ord.<OrderDate> %>
                           <%= ord.<RequiredDate> %>
                           <%= ord.<ShipInfo> %>
                       </Order> _
                   %>
               </Orders>
           </Customer> _
       %>
   </Root>
Console.WriteLine(newCustOrd)

Dieses Beispiel erzeugt die folgende Ausgabe:

<Root>
  <Customer CustomerID="GREAL">
    <CompanyName>Great Lakes Food Market</CompanyName>
    <ContactName>Howard Snyder</ContactName>
    <ContactTitle>Marketing Manager</ContactTitle>
    <Phone>(503) 555-7555</Phone>
    <FullAddress>
      <Address>2732 Baker Blvd.</Address>
      <City>Eugene</City>
      <Region>OR</Region>
      <PostalCode>97403</PostalCode>
      <Country>USA</Country>
    </FullAddress>
    <Orders />
  </Customer>
  <Customer CustomerID="HUNGC">
    <CompanyName>Hungry Coyote Import Store</CompanyName>
    <ContactName>Yoshi Latimer</ContactName>
    <ContactTitle>Sales Representative</ContactTitle>
    <Phone>(503) 555-6874</Phone>
    <Fax>(503) 555-2376</Fax>
    <FullAddress>
      <Address>City Center Plaza 516 Main St.</Address>
      <City>Elgin</City>
      <Region>OR</Region>
      <PostalCode>97827</PostalCode>
      <Country>USA</Country>
    </FullAddress>
    <Orders />
  </Customer>
  ...
</Root>

Beispiel: Erstellen eines Dokuments, dessen Form sich von der des Quelldokuments unterscheidet

Dieses Beispiel benennt einige Elemente um und wandelt einige Attribute in Elemente um. Es wird ConvertAddress aufgerufen, wodurch eine Liste von XElement-Objekten zurückgegeben wird. Das Argument für die Methode ist eine Abfrage, die das komplexe Address-Element bestimmt, wobei das Type-Attribut den Wert "Shipping" hat. Im Beispiel wird das XML-Dokument XML-Beispieldatei: Typische Bestellung verwendet.

static IEnumerable<XElement> ConvertAddress(XElement add)
{
    List<XElement> fragment = new List<XElement>() {
        new XElement("NAME", (string)add.Element("Name")),
        new XElement("STREET", (string)add.Element("Street")),
        new XElement("CITY", (string)add.Element("City")),
        new XElement("ST", (string)add.Element("State")),
        new XElement("POSTALCODE", (string)add.Element("Zip")),
        new XElement("COUNTRY", (string)add.Element("Country"))
    };
    return fragment;
}

static void Main(string[] args)
{
    XElement po = XElement.Load("PurchaseOrder.xml");
    XElement newPo = new XElement("PO",
        new XElement("ID", (string)po.Attribute("PurchaseOrderNumber")),
        new XElement("DATE", (DateTime)po.Attribute("OrderDate")),
        ConvertAddress(
            (from el in po.Elements("Address")
            where (string)el.Attribute("Type") == "Shipping"
            select el)
            .First()
        )
    );
    Console.WriteLine(newPo);
}
Function ConvertAddress(ByVal add As XElement) As IEnumerable(Of XElement)
    Dim fragment = New List(Of XElement)
    fragment.Add(<NAME><%= add.<Name>.Value %></NAME>)
    fragment.Add(<STREET><%= add.<Street>.Value %></STREET>)
    fragment.Add(<CITY><%= add.<City>.Value %></CITY>)
    fragment.Add(<ST><%= add.<State>.Value %></ST>)
    fragment.Add(<POSTALCODE><%= add.<Zip>.Value %></POSTALCODE>)
    fragment.Add(<COUNTRY><%= add.<Country>.Value %></COUNTRY>)
    Return fragment
End Function

Sub Main()
    Dim po As XElement = XElement.Load("PurchaseOrder.xml")
    Dim newPo As XElement = _
        <PO>
            <ID><%= po.@PurchaseOrderNumber %></ID>
            <DATE><%= CDate(po.@OrderDate) %></DATE>
            <%= _
                ConvertAddress( _
                (From el In po.<Address> _
                Where el.@Type = "Shipping" _
                Select el) _
                .First() _
                ) _
            %>
        </PO>
    Console.WriteLine(newPo)
End Sub

Dieses Beispiel erzeugt die folgende Ausgabe:

<PO>
  <ID>99503</ID>
  <DATE>1999-10-20T00:00:00</DATE>
  <NAME>Ellen Adams</NAME>
  <STREET>123 Maple Street</STREET>
  <CITY>Mill Valley</CITY>
  <ST>CA</ST>
  <POSTALCODE>10999</POSTALCODE>
  <COUNTRY>USA</COUNTRY>
</PO>

Siehe auch