Home > Articles

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

This chapter is from the book

Defining Functions

XPath has a fairly comprehensive set of functions for doing everything from performing date calculations to evaluating regular expressions. However, sometimes it's useful to be able to build more sophisticated functions out of this core set of basic functions for doing business logic-types of evaluations.

XQuery consequently also supports the capability to create user-definable functions. These functions are XQuery/XPath in origin, and are called in the same context as XPath expressions. For instance, suppose you want to take a date in the standard XSD notation (YYYY-MM-DD) and convert it into the American standard notation MM/DD/YYYY, and you want to do it for several different instances of data that have the following structure (directory.xml):

<directory>
   <file name="chapter3.xml" dateCreated="2002-11-25" dateModified=
"2002-11-28"/>
   <file name="chapter3app1.xml" dateCreated="2002-11-25" dateModified=
"2002-11-29"/>
   <file name="chapter3.toc" dateCreated="2002-11-25" dateModified=
"2002-11-30"/>
   <file name="chapter2.xml" dateCreated="2002-11-18" dateModified=
"2002-11-21"/>
</directory>

You can create an XQuery to provide a report:

<html>
   <body>
   <h1>File Report</h1>
   <table>
      <tr>
         <th>File Name</th>
         <th>Date Created</th>
         <th>Date Last Modified</th>
      </tr>
{for $file in document('directory.xml')//file
return
   <tr>
      <td>{$file/@name}</td>
      <td>{let $refDateStr := string($file/@dateCreated)
   let $year := substring($refDateStr,1,4)
   let $month := substring($refDateStr,6,2)
   let $day := substring($refDateStr,9,2)
   return concat($month,'/',$day,'/',$year)}</td>
   <td>{let $refDateStr := string($file/@dateModified)
   let $year := substring($refDateStr,1,4)
   let $month := substring($refDateStr,6,2)
   let $day := substring($refDateStr,9,2)
   return concat($month,'/',$day,'/',$year)}</td></tr>
}
      </table>
   </body>
</html>

However, there are two difficulties. First, you have a certain degree of code duplication, with similar routines given for formatting the date in the new order. A second related problem is that it is difficult to ascertain exactly what the script is designed to do.

This is a case where working with functions can ameliorate your problems somewhat. You can define a new function called format-date() that takes an XSD type date string as a parameter and formats the date into an American Standard notation:

define function format-date($dt as xs:dateTime) as xs:String
{
let $refDateStr := string($dt)
   let $year := substring($refDateStr,1,4)
   let $month := substring($refDateStr,6,2)
   let $day := substring($refDateStr,9,2)
   return concat($month,'/',$day,'/',$year)
}

First the code creates a new function called format-date in the immediate environment:

define function format-date

The name of the function can include alphanumeric characters along with the underscore (_) and dash (-) characters only.

You can set up zero or more parameters, separated by commas:

define function format-date($dt as xs:dateTime)

The parameters (such as $dt) must be preceded by a dollar sign. A parameter doesn't have to include a data type, as the data type can be inferred dynamically at runtime, but it's generally a good idea to include one if needed. Note, however, that this also precludes overloading (more than one function with the same name and different parametric signatures). The parameter-passing model is thus more akin to languages like JavaScript (or XSLT) than it is Java.

The xs: namespace prefix, discussed earlier, is necessary if you include schema types. Note that some XQuery parsers might support other schema languages, and as such will probably have different data type prefixes:

define function format-date($dt as xs:dateTime) as xs:string

The result type, similarly, need not be specified (as with parameters, it defaults to string and/or numeric general types depending upon the processor) but can be useful to ensure that the results are type-safe. The implication here, of course, is that the resulting output will be a string, rather than a specific nodal type.

The body of the function is itself an XQuery expression—here, a series of lets that breaks the initial text string into chronological pieces:

define function format-date($dt as xs:dateTime) as xs:string
{
   let $refDateStr := string($dt)
   let $year := substring($refDateStr,1,4)
   let $month:= substring($refDateStr,6,2)
   let $day := substring($refDateStr,9,2)
   return concat($month,'/',$day,'/',$year)
}

Note that there are also date-specific functions that do the same thing; however, they are still being finalized in the XQuery working draft.

The outer return clause for the function returns the specific contents of the function to the outside world, and of course should have the data type specified by the return type in the function declaration (here, xs:string):

define function format-date($dt as xs:dateTime) as xs:string
{
   let $refDateStr := string($dt)
   let $year := substring($refDateStr,1,4)
   let $month:= substring($refDateStr,6,2)
   let $day := substring($refDateStr,9,2)
   return concat($month,'/',$day,'/',$year)
}

You can have subordinate return values that create intermediate results, but you must have at least one final outer return value.

There is one implication of XQuery being a "side effect-free" language: You cannot, within XQuery, have a situation where the function changes some external, global variable. Anything passed into an XQuery function is passed by value, not reference. An immediate consequence is that a function must always return something of value—you cannot have a void function type (although you can have one with an empty string or sequence).

The functions are defined ahead of time within the XQuery command, and then are invoked as you would expect for functions. Taking the date-modifying report code mentioned earlier, the functional notation simplifies it considerably (see Figure 3.5):

define function format-date($dt as xs:dateTime) as xs:string
{
   let $refDateStr := string($dt)
   let $year := substring($refDateStr,1,4)
   let $month:= substring($refDateStr,6,2)
   let $day := substring($refDateStr,9,2)
   return concat($month,'/',$day,'/',$year)
}

<html>
   <body>
   <h1>File Report</h1>
   <table>
      <tr>
         <th>File Name</th>
         <th>Date Created</th>
         <th>Date Last Modified</th>
      </tr>
{for $file in document('directory.xml')//file
return
   <tr>
      <td>{string($file/@name)}</td>
      <td>{format-date($file/@dateCreated)}</td>
      <td>{format-date($file/@dateModified)}</td>
   </tr>
}
      </table>
   </body>
</html>

The body of the code now contains much less code, and the intent of the programming becomes considerably clearer in this example. The expressions

<td>{format-date($file/@dateCreated)}</td>
<td>{format-date($file/@dateModified)}</td>

indicate that the dateCreated attribute and then the dateModified attribute of the file element (here contained in the $file variable) be changed into the MM/DD/YYYY notation, to produce the final output in HTML:

Figure 3.5Figure 3.5 Consolidating reused code into functions can significantly simplify the source query, and encourages the development of code libraries.

<html>
   <body>
      <h1>File Report</h1>
      <table>
         <tr>
            <th>File Name</th>
            <th>Date Created</th>
            <th>Date Last Modified</th>
         </tr>
         <tr>
            <td>chapter3.xml</td>
            <td>11/25/2002</td>
            <td>11/28/2002</td>
         </tr>
         <tr>
            <td>chapter3app1.xml</td>
            <td>11/25/2002</td>
            <td>11/29/2002</td>
         </tr>
         <tr>
            <td>chapter3.toc</td>
            <td>11/25/2002</td>
            <td>11/30/2002</td>
         </tr>
         <tr>
            <td>chapter2.xml</td>
            <td>11/18/2002</td>
            <td>11/21/2002</td>
         </tr>
      </table>
   </body>
</html>

There are two issues to be aware of when dealing with functions: namespaces and libraries. The following sections describe these issues.

Namespaces

The XQuery language has its own specific (default) namespace that defines the functions that are commonly available. Although you can create functions into that namespace (which you are doing implicitly when you create a function without a namespace prefix), you stand the possibility of overwriting a system function with one of your own. In the current context, where all functions are local, this is not necessarily a bad thing, but in situations where more than one person is relying on these functions, that situation could prove disastrous.

Namespaces Can Be Useful, Not Just a Nuisance

People who work with XML only periodically sometimes see namespaces as something of a nuisance. Namespace identifiers are often long and unwieldy, and namespace prefixes can make a seemingly straightforward block of XML seem much more complex. However, namespaces can come in handy.

For instance, I've dealt with XML schemas describing such things as framework components (such as describing a form in Visual Basic via XML). A number of us were working on this application, and it was very important to ensure that the XML code one person wrote with samples wouldn't end up contaminating the base code until it had properly been approved.

To get around this, each developer was assigned their own namespace. The interpreter of the XML was programmed so that only certain namespaces would be enabled in each respective build (that is, you could run your own test-code, but other people running this code without the namespace enabled wouldn't have your functionality). After the XML code was deemed to be working correctly, a particular code's prefixes were swapped over to the formal implementation.

This system worked surprisingly well, especially as we moved more of our operant code into XML form. Without the namespaces, it would have been impossible to keep the coding straight; with them, not only could we tell at a glance whose code we were dealing with, but the software applications could use the same namespaces to assign functionality.

The declare namespace command lets you define other namespaces for use within function declarations. For instance, you might decide to create a package of date functions, and associate them with a given namespace URI (http://www.kurtcagle.net/schemas/xquery/date, for instance). This namespace would then be used to refer to all functions within that package as follows:

declare namespace dates = "http://www.kurtcagle.net/schemas/xquery/date"

define function dates:format-date($dt as xs:dateTime) as xs:string
{
   let $refDateStr := string($dt)
   let $year := substring($refDateStr,1,4)
   let $month:= substring($refDateStr,6,2)
   let $day := substring($refDateStr,9,2)
   return concat($month,'/',$day,'/',$year)
}

<html>
   <body>
   <h1>File Report</h1>
   <table>
      <tr>
         <th>File Name</th>
         <th>Date Created</th>
         <th>Date Last Modified</th>
      </tr>
{for $file in document('directory.xml')//file
return
   <tr>
      <td>{string($file/@name)}</td>
      <td>{dates:format-date($file/@dateCreated)}</td>
      <td>{dates:format-date($file/@dateModified)}</td>
   </tr>
}
      </table>
   </body>
</html>

By doing this, you avoid the problem of namespace collision, and not coincidentally, make it easier to organize your code.

Code Libraries

The second issue is a little more irksome, and has to do with the creation of code libraries. One of the principal reasons for working with functions is the capability to build function libraries that you (and others working in the same space) can use in your own code.

Currently (as of November 15, 2002) there is no provision within the XQuery specification for indicating code libraries, although there is an open-issue item concerning it. The primary difficulty in working with such external libraries revolves around the fact that such function libraries should realistically be in their own namespaces.

One speculative form for adding such functional libraries might look something like the following for the date library:

import "dateFunctions.xquery" in namespace dates = "http://www.kurtcagle.net/
schemas/xquery/dates"

In this case, dateFunctions.xquery is a URL that contains all the custom functions associated with dates. Once declared in this manner, the functions require the namespace prefix to be invoked (for example, dates:format-date($myDate)). Note that by associating the namespace (and its prefix) with the function set, you can use a different prefix than any defined within the imported XQuery call.

Ultimately, functions in XQuery serve much the same purpose as stored procedures (SPROCS) within SQL: They simplify the coding involved within queries, and also form a mechanism for encapsulating business logic within queries (a topic to be covered in Chapter 4 and elsewhere). This becomes critically important in dealing with pipelined architectures, in which the XQuery acts as a filter on a dataset to be passed to another component (such as a Web service, or an XSLT transform). Expect to see more on function libraries in the final specification.

  • + 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