XML matching

The Scala XML support includes the ability to match on XML elements. Here are several examples. One of the most important parts to remember is to not miss the '{' and '}'.

1. scala> <document>
2.      |  <child1/>
3.      |  <child2/>
4.      | </document>
5. res0: scala.xml.Elem =
6. <document>
7.         <child1></child1>
8.         <child2></child2>
9.        </document>
11. scala> res0 match {
12.        // match the document tag
13.        // the {_*} is critical
14.      | case <document>{_*}</document> => println("found document element")
15.      | case _ => println("Found another element")
16.      | }
17. found document element
19. scala> res0 match {
20.        // assign the document element to e
21.      | case e @ <document>{_*}</document> => println(e)
22.      | case _ => println("Found another element")
23.      | }
24. <document>
25.         <child1></child1>
26.         <child2></child2>
27.        </document>
29. scala> res0 match {
30.        // assign the children of document to children
31.        // notice that there are Text elements that are part of children
32.      | case <document>{children @ _*}</document> => println(children)
33.      | case _ => println("Found another element")
34.      | }
35. ArrayBuffer(
36.         , <child1></child1>,
37.         , <child2></child2>,
38.        )
40. // the '\' is xpath like but only returns elements and attributes
41. // in this case the \ "_" returns all element children of res0.  It
42. // will not return the Text elements.
43. scala> res0 \ "_" foreach {
44.      | case <child1>{_*}</child1> => println("child1 found")
45.      | case <child2>{_*}</child2> => println("child2 found")
46.      | case e => println("found another element")
47.      | }
48. child1 found
49. child2 found
51. // another example of how \ does not return any text elements.  This returns
52. // no elements
53. scala> <doc>Hello</doc> \ "_" foreach { case scala.xml.Text(t) => println("a text element found: "+t) }
55. // the .child returns all children of an Elem
56. scala> <doc>Hello</doc>.child foreach { case scala.xml.Text(t) => println("a text element found: "+t) }
57. a text element found: Hello
59. // This example throws a match error because there are whitespace text elements
60. // that cause the match to fail.
61. scala> res0 match {                                                                                    
62.      | case <document><child1/><child2/></document> => println("found the fragment")
63.      | }
64. scala.MatchError: <document>
65.         <child1></child1>
66.         <child2></child2>
67.        </document>
68.        at .< init>(< console>:6)
69.        at .< clinit>(< console>)
70.        at RequestResult$.< init>(< console>:3)
71.        at RequestResult$.< clinit>(< console>)
72.        at RequestResult$result(< console>)
73.        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
74.        at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMetho...
76. // The trim method removes the whitespace nodes so now the 
77. // match will work
78. scala> scala.xml.Utility.trim(res0) match {                                                            
79.      | case <document><child1/><child2/></document> => println("found the fragment")
80.      | }
81. found the fragment
83. // you can select part of the tree using matching
84. // child2 is assigned to 3 in this example.
85. scala> scala.xml.Utility.trim(res0) match {                                           
86.      | case <document><child1/>{e @ _*}</document> => println("found the fragment:"+e)
87.      | }
88. found the fragment:RandomAccessSeq(<child2></child2>)