Home > Articles > Web Services > XML

  • Print
  • + Share This
Like this article? We recommend

The ZwiftBooks Filter Solution

Let’s use SAX filters to help ZwiftBooks maximize their reuse of existing code. Figure 2 illustrates our problem. The company already has in place a SAX implementation that alerts the warehouse whenever an isbn attribute is located within incoming XML documents. Now, a new arrangement has been made to provide services to an Asian book purchaser. The only problem is that the XML uses the attribute asin and includes XX as a prefix to every ISBN. Since the attribute name isn’t isbn, it will slip by our handler. What we need to do is change the attribute name from asin to isbn and strip out the leading XX—a fine task for a SAX filter. By creating a SAXDataFilter that changes the attribute name and value, we can pass the conforming XML to our original handler without changing existing code.

Figure 2

Figure 2 Using a SAX filter to modify the XML stream.

To make working with attributes fairly painless, SAX2 provides an AttributesImpl class that implements the SAX2 Attributes interface with manipulators so that attributes can be modified or reused. The AttributesImpl class can be used in two different ways:

  • Take a persistent snapshot of an Attributes object in a startElement event.
  • Construct or modify an Attributes object in a SAX2 driver or filter.

We use this class to modify both the asin attribute name and its value in the filter example in Listing 2.

Listing 2 SAX handler code for a SAX filter that modifies attribute name and value.

 1. import org.xml.sax.helpers.XMLFilterImpl;
 2. import org.xml.sax.helpers.AttributesImpl;
 3. import org.xml.sax.Attributes;
 4. import org.xml.sax.SAXException;
 5.
 6.
 7.
 8. public class SaxDataFilter extends XMLFilterImpl {
 9.
10. public void startElement (String namespaceUri, String localName,
11.        String qualifiedName,
12.        Attributes attributes)
13.           throws SAXException {
14.
15.  AttributesImpl newAttributes = null; // set up local var
16.
17.  // check to see which element we’re looking at
18.  if (qualifiedName.equals("book")) {
19.
20.  // copy all the attributes for this element into a new
21.  // structure that allows us to retrieve and modify attributes
22.  newAttributes = new AttributesImpl(attributes);
23.
24.  String asiabookcode = newAttributes.getValue("asin");
25.
26.  // remove leading two characters from the book code
27.  String isbnCode = asiabookcode.substring(2);
28.
29.  // determine the index of the incoming asin attribute
30.  int idx = newAttributes.getIndex("asin");
31.
32.  // change both the attribute name and the value
33.  newAttributes.setQName(idx, "isbn");
34.  newAttributes.setValue(idx, isbnCode);
35.
36.  }
37.
38. // pass original parameter data (except for attributes)
39. // to the next pipeline - note that we are passing newAttributes
40.
41. super.startElement(namespaceUri, localName,
42.      qualifiedName, newAttributes);
43. }
44.
45.
46. }

We define newAttributes on line 15; on line 22 we instantiate it with a copy of all incoming attributes. We then extract the value of the asin attribute (line 24) and strip off the leading XX (line 27). With our new isbn value in hand, we change the name and the value (lines 33–34). Then, in line 41, we pass all the parameters we received to the next handler in the chain by calling super.startElement(..). Note that we’re not passing the original attributes parameter but rather newAttributes, the instance of AttributesImpl that we created and modified.

Listing 3 shows the SaxIsbnHandler, which remains unchanged from the previous article. It now sits at the end of the filter chain and reacts to incoming ISBNs.

Listing 3 A basic SAX handler that alerts the warehouse when an incoming ISBN is found.

public class SaxIsbnHandler extends DefaultHandler {

 public void startElement(String namespaceUri,
       String localName,
       String qualifiedName,
       Attributes attributes)
        throws SAXException {

 String isbnNumber = null;

 // if we have a <book>, retrieve the attributes
 if (qualifiedName.equals("book")) {
  int numAttributes = attributes.getLength();

  if (numAttributes > 0) {

  // step through each attribute, looking for isbn
  for(int i=0; i<numAttributes; i++) {

   if (attributes.getQName(i).equals("isbn") ) {
   isbnNumber = attributes.getValue(i);
   alertWarehouse( isbnNumber );
   break;
   }

  } // end for
  }

 } // end if book
 }

 }

Now let’s pull it all together. Listing 4 shows how the filter chain is constructed.

Listing 4 SAX filter chain construction.

 1. import javax.xml.parsers.*;
 2. import org.xml.sax.*;
 3. import org.xml.sax.helpers.*;
 4.
 5. public class SaxIsbnFilterMain {
 6.
 7. public static void main (String [] args) {
 8.
 9.  String filename   = "AsiaBooks.xml";
10.
11.  // define the two parts of the filter chain
12.  DefaultHandler isbnHandler = new SaxIsbnHandler(); // original
13.  SaxDataFilter isbnFilter = new SaxDataFilter(); // filter
14.
15.  try {
16.
17.  XMLReader reader =
18.   XMLReaderFactory.createXMLReader(
19.   "org.apache.crimson.parser.XMLReaderImpl");
20.
21.  // register the dummy reader with the filter
22.  isbnFilter.setParent(reader);
23.
24.  // warning: this method is not what it seems.
25.  // it sets the content handler of the parent reader!
26.  isbnFilter.setContentHandler(isbnHandler);
27.
28.  // XML Data Source
29.  InputSource inputSource = new InputSource(filename);
30.
31.  // start the pipeline rolling - tell filter to parse
32.  isbnFilter.parse(inputSource);
33.
34.
35.  } catch(Exception e) {
36.  String errorMessage =
37.   "Error parsing " + filename + ": " + e;
38.   System.err.println(errorMessage);
39.   e.printStackTrace();
40.  }
41. }
42.
43. }

Setting up the filter chain correctly is the trickiest thing about using SAX filters, since the mechanism is not as intuitive as we might like, so let’s walk through the process step by step:

  • Line 12 creates an instance of the existing handler—the one that alerts the warehouse when an ISBN is found.
  • Line 13 creates the filter instance—the one that changes isbn.
  • Line 17 creates a "blank" XMLReader instance using the XMLReaderFactory.
  • Line 18 tells the filter to set the blank XMLReader as parent.
  • Line 26 sets our isbnHandler as the ContentHandler of the filter. But wait a minute. Doesn’t our filter already have handler code? Isn’t that what Listing 2 is all about? Yes, but what’s happening is that XMLFilterImpl tells the dummy reader we just created to use the code we wrote in Listing 1 as its handler, and now the original code defined as isbnHandler (Listing 3) becomes the filter’s handler.
  • Line 32 is where the parsing starts—with our isbnFilter. The parse method of XMLFilterImpl calls the parent handler first (Listing 2), which does its filtering and then makes a call to its superclass, super.startElement( ). This in turn triggers the isbnHandler code now set as the handler code for the filter. Whew!

If you find this implementation confusing and convoluted, you’re in good company. In his book XML in a Nutshell (O’Reilly, 2004), Elliotte Rusty Harold wonders out loud why he has hard time getting SAX filters right. In Java & XML (O’Reilly, 2001), Brett McLaughlin includes a similar comment. However, once you have a working example to study, it’s possible to do some powerful things with SAX filters.

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