XML ドキュメントの構造とは、XML ドキュメントの要素名、属性名、およびその階層の特性を表すものです。
XML ドキュメントの構造を変更しなければならない場合があります。 たとえば、既存の XML ドキュメントを、異なる要素名と属性名を必要とする別のシステムに送信するとします。 ドキュメント全体を調べ、必要に応じて要素の削除や要素名の変更を行うことも可能ですが、関数型構築を使用する方が、読みやすく保守しやすいコードを生成できます。 関数型構築の詳細については、「関数型構築 (LINQ to XML)」を参照してください。
最初の例では、XML ドキュメントの編成を変更します。 ここでは、複合要素をツリー内で移動します。
このトピックの 2 番目の例では、ソース ドキュメントと異なる構造を持つ XML ドキュメントを作成します。 要素名の大文字小文字の区別を変更し、一部の要素名を変更し、ソース ツリーの一部の要素を変換後のツリーに含めないようにします。
使用例
次のコードでは、組み込まれたクエリ式を使用して、XML ファイルの構造を変更します。
この例のソース XML ドキュメントでは、Root 要素の下にある Customers 要素に、すべての顧客が含まれています。 また、Root 要素の下には Orders 要素もあり、すべての注文が含まれています。 この例では、各顧客の注文が Customer 要素内の Orders 要素に含まれるような、新しい XML ツリーを作成します。 元のドキュメントでは、Order 要素内に CustomerID 要素も含まれています。構造変更後のドキュメントからは、この要素が削除されます。
この例では、「サンプル XML ファイル : 顧客と注文 (LINQ to XML)」の XML ドキュメントを使用しています。
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)
このコードによって、次の出力が生成されます。
<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>
. . .
この例では、一部の要素の名前を変更し、一部の属性を要素に変換します。
コードで ConvertAddress を呼び出すと、XElement オブジェクトの一覧が返されます。 メソッドの引数は、Type 属性の値が "Shipping" である Address 複合要素を特定するクエリです。
この例では、「サンプル XML ファイル : 一般的な購買発注書 (LINQ to XML)」の XML ドキュメントを使用しています。
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
このコードによって、次の出力が生成されます。
<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>