Home > Articles > Web Services > XML

Navigation in XQuery

This chapter is from the book

This chapter is from the book

3.5 Navigation Examples

To illustrate the navigation concepts introduced in this chapter, let's consider a variety of different navigation tasks over the sample XML document, team.xml, from Chapter 1. For convenience, it's repeated in Listing 3.6.

This document contains employee information from a fictitious organization. The data consists primarily of Employee elements, in which parent/child relationships in the XML correspond to manager/employee relationships in the organization. Just to spice things up a bit, the document also contains a few comments and processing instructions.

Listing 3.6. The team.xml document

<?xml version='1.0'?>
<Team name="Project 42" xmlns:a="urn:annotations">
  <Employee id="E6" years="4.3">
    <Name>Chaz Hoover</Name>
    <Title>Architect</Title>
    <Expertise>Puzzles</Expertise>
    <Expertise>Games</Expertise>
    <Employee id="E2" years="6.1" a:assigned-to="Jade Studios">
      <Name>Carl Yates</Name>
      <Title>Dev Lead</Title>
      <Expertise>Video Games</Expertise>
      <Employee id="E4" years="1.2" a:assigned-to="PVR">
        <Name>Panda Serai</Name>
        <Title>Developer</Title>
        <Expertise>Hardware</Expertise>
        <Expertise>Entertainment</Expertise>
      </Employee>
      <Employee id="E5" years="0.6">
        <?Follow-up?>
        <Name>Jason Abedora</Name>
        <Title>Developer</Title>
        <Expertise>Puzzles</Expertise>
      </Employee>
    </Employee>
    <Employee id="E1" years="8.2">
      <!-- new hire 13 May -->
      <Name>Kandy Konrad</Name>
      <Title>QA Lead</Title>
      <Expertise>Movies</Expertise>
      <Expertise>Sports</Expertise>
      <Employee id="E0" years="8.5" a:status="on leave">
        <Name>Wanda Wilson</Name>
        <Title>QA Engineer</Title>
        <Expertise>Home Theater</Expertise>
        <Expertise>Board Games</Expertise>
        <Expertise>Puzzles</Expertise>
      </Employee>
    </Employee>
    <Employee id="E3" years="2.8">
      <Name>Jim Barry</Name>
      <Title>QA Engineer</Title>
      <Expertise>Video Games</Expertise>
    </Employee>
  </Employee>
</Team>

Each Employee has an id attribute that we will assume has been typed as xs:ID with a DTD or XML Schema so that it can be looked up by the id() lookup function. And finally, the team.xml document contains some “annotations” in another namespace ("urn:annotations"). These attributes describe additional information about the employees and are used here to demonstrate navigation using qualified names and the other wildcard node tests.

For the first example, the team.xml document is loaded using the doc() function. For the remaining examples, we will assume that this document is already the input sequence, so that all paths are resolved relative to it without loading it explicitly.

As our first task, consider finding the names of all employees. Because Employee elements occur at many different levels in the XML, use the descendant navigation shortcut // to match every Employee element descendant of the root document node. Finally, select their child elements named Name. The result is a list of the names of all employees in the document (returned in document order), as shown in Listing 3.7.

Listing 3.7. Find the names of all employees

doc("team.xml")//Employee/Name
=>
<Name>Chaz Hoover</Name>
<Name>Carl Yates</Name>
<Name>Panda Serai</Name>
<Name>Jason Abedora</Name>
<Name>Kandy Konrad</Name>
<Name>Wanda Wilson</Name>
<Name>Jim Barry</Name>

Suppose instead we want to select only some of the employees, subject to some condition as in Listing 3.8.

Listing 3.8. Name all employees who have been at the company less than two years

//Employee[@years < 2]/Name
=>
<Name>Panda Serai</Name>
<Name>Jason Abedora</Name>

This path is the same as the previous one, except that a predicate has been added to the Employee step. We want to filter the Employee elements so that we select only those whose years attribute has a value less than 2. So we use the attribute axis @ and the less-than comparison operator < to compare the years attribute against 2. Then from these filtered employees, their names are selected as in the previous example.

We can also search for attributes in another namespace. For example, we could search for all employees currently assigned, as shown in Listing 3.9.

Listing 3.9. Find all employees currently assigned

declare namespace ann = "urn:annotations";
//Employee[@ann:assigned]/Name
=>
<Name>Carl Yates</Name>
<Name>Panda Serai</Name>

In this query, we have used the query prolog to declare a namespace prefix, and then used this prefix in the attribute name test @ann:assigned to match attributes with the local name equal to assigned and namespace equal to urn:annotations. Note that the prefix used in the query can be (and in this case is) different from the one used in the original document.

By putting the attribute test in the predicate with no comparison, we test for its existence. The predicate is converted using the Effective Boolean Value rule, which tests whether the sequence is non-empty. Consequently, this XPath finds all employees with an assignment, regardless of what that assignment actually is. Similarly, we could find all employees who lack an assignment by applying the not() function, as shown in Listing 3.10.

Listing 3.10. Find all unassigned employees

declare namespace ann = "urn:annotations";
//Employee[not(@ann:assigned)]/Name
=>
<Name>Chaz Hoover</Name>
<Name>Jason Abedora</Name>
<Name>Kandy Konrad</Name>
<Name>Wanda Wilson</Name>
<Name>Jim Barry</Name>

The query to find all employees with an expertise in puzzles is superficially similar to the previous query. The previous query needed to compare attribute values; this query (see Listing 3.11) needs to compare child element values.

Listing 3.11. Find all employees skilled in puzzles

//Employee[Expertise = "Puzzles"]/Name
=>
<Name>Chaz Hoover</Name>
<Name>Jason Abedora</Name>
<Name>Wanda Wilson</Name>

This case is made somewhat more difficult by the fact that employees may have more than one expertise. Consequently, we must test whether there exists any child expertise element with the desired value. Fortunately, the general comparison operators like < and = are defined so that they already do this existence test implicitly (see Chapter 5). Thus, the predicate Expertise = "Puzzles" tests whether there exists a child element named Expertise whose string value is "Puzzles".

Navigation can also be used to compute other values. For example, Listing 3.12 counts the number of employees in one division.

Listing 3.12. Count the number of people in Chaz Hoover's organization

count(//Employee[Name="Chaz Hoover"]/descendant-or-self::Employee)
=>
7

The count() function computes the number of items in a sequence (see Chapter 5). First we must locate the employee named Chaz Hoover, which can be done using a query like the ones used previously. But then we must count all the employees contained in the sub-tree rooted at Chaz Hoover—in other words, all the descendant Employee elements. By using the descendant-or-self axis, we have included Chaz Hoover himself in this count. We could exclude him by instead using the descendant axis as in the path count(//Employee[Name="Chaz Hoover"]/descendant::Employee).

Instead of counting the entire organization, we could instead count only those employee elements directly under Chaz Hoover, as shown in Listing 3.13.

Listing 3.13. Count the number of Chaz Hoover's direct reports

count(//Employee[Name="Chaz Hoover"]/Employee)
=>
3

Instead of performing a descendant query with //, we have used ordinary child navigation / to select only those employees who report directly to Chaz Hoover. This task could also be accomplished in another way, using the parent axis, as shown in Listing 3.14.

Listing 3.14. Use the parent axis to count Chaz Hoover's employees

count(//Employee[../Name="Chaz Hoover"])
=>
3

Here we first find every Employee in the document. Then, we check to see if the parent element has the name Chaz Hoover. We use the .. abbreviation to navigate to the parent, and then compare its child Name element. This query is usually much slower than the previous one, although some implementations can optimize it so that both perform identically.

We can also find other kinds of elements in the tree. For example, we could extract all comment and processing-instruction nodes by using node kind tests, as illustrated in Listing 3.15.

Listing 3.15. Find all comments and processing instructions

//comment() | //processing-instruction()
=>
<?Follow up?>
<!-- new hire 13 May -->

In this query, we used the union operator | to combine the results of both paths. We could have also written //(comment() | processing-instruction()) to achieve the same effect. (See Chapter 5 for more information about the union operator.)

Notice that the XML declaration <?xml version='1.0'?> at the top of the document did not match. Although it looks like a processing instruction, XML doesn't treat it as part of the data model, so XQuery doesn't either. Finally, Listing 3.16 demonstrates looking up elements by their IDs.

Listing 3.16. Find all employees with the same job function as employee E0

//Employee[Title = id("E0")/Title]/Name
=>
<Name>Wanda Wilson</Name>
<Name>Jim Barry</Name>

Because we wish to find all employee names satisfying some condition, we know that the path will consist of //Employee/Name and use a predicate to limit which employees are matched. This predicate should select all employees with the same title as that of employee E0. Employee E0 can be found using the id() navigation function: id("E0"). Then all that remains is to compare the current employee's title against that of E0.

Notice that instead of using id(), we could use an absolute path inside the predicate to search from the root of the document to find the employee with id E0: //Employee[Title = //Employee[@id="E0"]/Title]/Name. This path has the advantage that it doesn't require a DTD or schema to type the id attribute. However, it is more complex to write and usually will perform worse than the id lookup (which most implementations optimize into an index or table lookup). This path essentially performs a join of the document with itself. Joins like this are often expressed using FLWOR expressions (described in Chapter 6).

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020