Home > Articles > Web Services > XML

  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

4.2 XPointer

XML schema documents use schemaLocation attributes to locate other schema documents and parts of schema documents. The value of a schemaLocation is always a URI, which may include an XPointer. The schemaLocation attribute type of schema, import, and include are examples of where an XPointer might locate a schema document location.

An XPointer is nominally an extension of an XPath. The XPointer Recommendation permits—even encourages—the use of the XPath id function. There are also several XPointer specific extensions to XPath.

The XPointer Recommendation specifies expressions for returning portions of an XML document. The expression may evaluate to a node, a set of nodes, a portion of a node, or a portion of an XML document that spans nodes. Just as XML Schema limits the use of XPath expressions, it also limits the use of XPointer expressions. In particular, an XML schema may only import individual components (nodes) or sets of components (node sets). Because a component corresponds to an entire XML element—as opposed to a portion thereof—this section covers only XPointer constructs pertinent to extracting complete nodes.

4.2.1 Location Sets

The previous section mentions that an XPointer expression may evaluate to a node, a set of nodes, a portion of a node, or a portion of an XML document that spans nodes. Unlike an XPath expression, which must evaluate to a node set, an XPointer expression may theoretically return results that do not conform to a node. Therefore, the XPointer infrastructure requires an XPointer to return a location set.

A location set is an extension of a node set that an XPath normally returns. Each location in a location set is either a point or a range. A point consists of a node and an index. The index is a character offset into the node. A range consists of two points. The concepts of both point and range exist because of the XPointer requirement that an expression might return a subset of a node or possibly a set of characters that spans nodes.

Because an XML schema can only make use of an entire node or set of nodes, the remainder of this chapter covers only the subset of location information (and location sets) specified by nodes (and node sets). The terms 'node set' and 'location set' have similar meanings in the context of XML Schema.

4.2.2 Namespaces

The XPointer notation permits the identification of one or more namespaces. An XPointer expression specifies a namespace with the xmlns function. The argument to this function resembles a namespace attribute applicable to any XML element:

xmlns(xsd="http://www.w3.org/2001/XMLSchema") 

The following XPointer locates the catalogEntryDescriptionType complex type by name. Namespace declarations always precede the locating expression:

http://www.XMLSchemaReference.com/theme/catalog.xsd# 
  xmlns(xsd="http://www.w3.org/2001/XMLSchema") xpointer( 
    xsd:schema/xsd:element[@name="catalogEntryDescriptionType"] 
          ) 

In general, an XPointer may specify any number of namespaces. The previous example suffices for locating most schema components. An XPointer reference in a schemaLocation may require multiple namespaces when an XML document that is not a schema document has embedded Schema elements.

4.2.3 Subelement Sequences

Subelement sequences are notations that provide a shortcut to elements in an XML document. A subelement sequence has the following grammar:

bareName? ('/' [1-9] [0-9]*)+ 

where the optional bareName is replaced by the ID name of an element, as discussed in Section 4.2.2. The numerals represent the Nth subelement (counting from 1) at each level.

WARNING

Subelement sequences provide an extremely compact and convenient short notation. Unfortunately, this supported notation is highly susceptible to failure. In particular, the structure of the expected XML document (in this case, most likely an XML schema document) must be extremely stable. Any change in the element structure of the document can provide surprising results.

The following example locates the fourth subelement of the third subelement of the document root:

../some.xsd#/1/3/4 

Similarly, the following example locates the fourth subelement of the third subelement of the element whose ID is 'yadayada':

../some.xsd#yadayada/3/4 

4.2.4 XPointer Extensions to XPath

This section covers only those XPointer extensions applicable to XML schemas. In fact, only one extension—the range-to function—has any applicability with respect to XML schemas. The use of this function is not common.

The XPointer Recommendation adds the range-to function as an option for an XPath step. A step is an axis and a node. A convenient use of the range-to function is to locate a set of nodes to incorporate into a schema. The range-to function is likely to appear in conjunction with the XPath id function. The following example locates four schema components that appear in sequence in pricing.xsd: fullPriceType, freePriceType, salePriceType, and clearancePriceType.

http://www.XMLSchemaReference.com/theme/pricing.xsd#
  xpointer(id("fullPriceType.pricing.cType")/
      range-to(id("clearancePriceType.pricing.cType")))

4.2.5 Using XPointer and XPath to Locate Schemas

This section describes the portions of the XPath Recommendation that apply to XPointers. An XPointer may reference any of the XPath axes touched on in Section 4.1.1. Table 4.3 lists all the axes supported by the XPath Recommendation and notes where each axis applies with respect to schema document locations. Such an XPointer might contain a reference to any axis; however, validations of many of these axes are likely to fail. Table 4.3 duly notes these likely failures in the Caveats column. A '3' indicates that an XPointer can reference the corresponding axis and expect positive results.

An XPath expression, in general, can return any node set, a Boolean value, a string, or a floating-point number. In an XML schema, the results of an XPath expression (in an identity constraint), as well as the results of an XPointer expression (in a schemaLocation value), must result in a node set. Because both expressions return a node set, this chapter does not go into detail describing the other result types (Boolean, string, and number). However, a predicate can refine a node set in an XPointer expression. Therefore, Table 4.4 provides a few examples of XPointers that contain predicates, which return values that are not node sets. This chapter does not provide a comprehensive tutorial on the full XPath expression options that may appear in a predicate. Note that each example is only the XPointer part of a URI. An entire URI that includes an XPointer has the following form:

http://www.example.com/some.xml#xpointer(exampleXPointer)

See Sections 4.1.3 or 4.2.4 for examples of complete URIs. The cells in the Example column of Table 4.4 provide a substitution for exampleXPointer in the previous code excerpt.

Table 4.4 provides a nice illustration of the power of XPointer expressions enhanced by XPath predicates. For a complete tutorial on predicates, refer to the XPath Recommendation.

TABLE 4.3 XPath Axes Potentially Used in schemaDocument References

Axis

Meaning

Caveats

child

All subelements of the context node

descendant

Element descendants of the context node

parent

The parent of the context node

ancestor

Element ancestors of the context node

An XPointer referencing this axis is technically okay, but the schema is probably bizarre at best

following-sibling

All siblings of the context node that appear after the context node

Not recommended, as this will include attribute and name-space nodes (that is, undesirable nodes that are just portions of an element). Use the following axis instead.

preceding-sibling

All siblings of the context node that appear before the context node

Not recommended, as this will include attribute and name-space nodes (that is, undesirable nodes that are just portions of an element). Use the preceding axis instead.

following

Element siblings of the context node that appear after the context node

preceding

Element siblings of the context node that appear before the context node

attribute

Attributes of the context node

Not recommended: If the XPointer returns anything, the validation will fail

namespace

Namespace nodes of the context node

Not recommended: If the XPointer returns anything, the validation will fail.

self

The context node

Why bother in an XPointer?

descendant-or-self

Descendant or self axes

ancestor-or-self

Ancestor or self axes


TABLE 4.4 XPointer Examples

Example

Meaning

id("foo")

The element whose ID is 'foo' (see Section 4.1.3 for a detailed example).

id("foo")/range-to(id("bar"))

The elements whose IDs are 'foo' and 'bar', as well as all elements in between.

X[position()=1]

or

x[1]

The first x.

 

 

X[position()>1]

All x elements except the first one.

X[5]

The fifth x.

X[last()]

The last x.

./x

The x elements that are subelements of the parent of the current context.

X[y="hello"]

The x elements that have a subelement y whose value is 'hello'.

X[@y and @z]

The x elements that have both y and z attributes.

X[@y or @z]

The x elements that have either a y or z attribute.

X[@y < "10"]

The x elements that have a y attribute whose value is less than '10'. Note that XPath supports '=', '!=', '<', '<=', '>', and '>='. Escape these as necessary with the standard XML entity reference, such as '&lt;' for the less-than character.

X[starts_with(y,"abc")]

The x elements that contain a y subelement whose value starts with 'abc'.

X[sum(y) &gt; 50]

The x elements that contain one or more y subelements, the sum of whose values is greater than 50.


  • + Share This
  • 🔖 Save To Your Account

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