Home > Articles

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

This chapter is from the book

The Key JAXP Classes and Interfaces for SAX Support

The classes and interfaces that are critical for an application to parse an XML document using a SAX parser are discussed in the following sections.

The SAXParserFactory Class

SAXParserFactory is an abstract class that defines the factory API that enables an application to get an instance of the SAXParser class. The instance of the SAXParser class provides the SAX-based parser to parse XML documents.

An instance of the SAXParserFactory class can be obtained by using the static newInstance() method of the SAXParserFactory class. The actual SAX parser that is loaded depends on the entry of the javax.xml.parsers.SAXParserFactory system property. The default implementation associated with the Java Web Services Developer pack is the Xerces parser. The system property can be changed with the -D option. For example, the following command will ensure that the MyXMLHandler application uses Xerces as the SAX parser:

java -Djavax.xml.parsers.SAXParserFactory=
org.apache.xerces.jaxp.SAXParserFactoryImpl MyXMLHandler.

The SAXParserFactory class defines several methods that you can use to query and configure the parser. For example, you can use the setNamespaceAware() method to set the SAX parser to be namespace-aware. Setting the parser to be namespace-aware enables it to provide support for namespaces in an XML document. See the section "Handling Namespaces" in Chapter 4, "Advanced Use of SAX," to understand namespaces and how they are supported and processed by XML parsers.

The SAXParser Class

SAXParser is an abstract class that implements the XMLReader interface. The XMLReader interface provides the necessary methods to parse an XML document. Therefore, by obtaining an instance of the SAXParser class, you gain access to several parse() methods with which an XML document can be parsed from a variety of input sources, such as files, URLs, inputstreams, and so on.

Table 3.5 describes the methods that are defined in the XMLReader interface and are critical for a SAX parser. You will see many of these methods used in the examples later in this chapter, as well as in Chapter 4.

Table 3.5 XMLReader Methods

XMLReader Methods

Description

getContentHandler()

This method returns the content event handler registered with the parser.

getDTDHandler()

This method returns the DTD event handler registered with the parser.

getEntityResolver()

This method returns the entity resolver registered with the parser.

getErrorHandler()

This method returns the error handler registered with the parser.

getFeature(java.lang.String name)

This method looks up the value of the feature provided in the argument. The returned value is either true or false. The argument has to be a fully qualified URI. The list of standard features that a SAX parser can support is available at http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description.

getProperty(java.lang.String name)

This method looks up the value of the property specified in the argument. The returned value is either true or false. The argument has to be a fully qualified URI. The list of standard features that a SAX parser can support is available at http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description.

parse(InputSource input)

This method reads the XML information from any valid input stream and parses it.

parse(java.lang.String systemId)

This method reads the XML document from a system identifier and parses it.

setContentHandler(ContentHandler handler)

This method registers a content event handler with the parser.

setDTDHandler(DTDHandler handler)

This method registers a DTD event handler with the parser.

setEntityResolver(EntityResolver resolver)

This method registers an entity resolver with the parser.

setErrorHandler(ErrorHandler handler)

This method registers an error event handler with the parser.

setFeature(java.lang.String name, boolean value)

This method sets the state of a feature for the parser. For example, the value true for the feature http://xml.org/sax/features/external-parameter-entities will ensure that the parser will process external parameter entities.

setProperty(java.lang.String name, java.lang.Object value)

This method sets the state of a property for the parser. For example, setting the http://xml.org/sax/properties/lexical-handler will ensure that lexical handling is turned on for the parser. (Of course, you will need to implement the LexicalHandler interface as well).


An instance of the SAXParser class can be obtained by using the newSAXParser() method of the SAXParserFactory class.

CAUTION

It is important to note that the SAXParserFactory class is not thread-safe. However, if the instance of the class is used by only one thread, an application can use the same instance of the SAXParserFactory to obtain multiple instances of SAXParser. As with the SAXParserFactory class, the SAXParser class is also not thread-safe.

The DefaultHandler Class

DefaultHandler is an adapter class that implements the four core SAX 2.0 handler interfaces and provides do-nothing implementations of the interface methods. These four interfaces are as follows:

  • ContentHandler

  • ErrorHandler

  • DTDHandler

  • EntityResolver

You can extend this class and override only those callback methods that are required. This is a convenient alternative to implementing the interface methods as do-nothing methods when implemented individually in an application.

The ContentHandler Interface

The ContentHandler interface defines the methods that an application must implement to handle the events that are generated when a valid XML syntax is found. For example, when the parser finds a < in the XML source, it invokes the startElement() method of the ContentHandler interface. This is probably the most critical interface, and almost all applications will at least need to implement the methods defined in the ContentHandler interface.

The ErrorHandler Interface

This interface declares the methods that enable you to implement error handling in your application. You need to implement this interface to implement your own customized error handling. This interface provides the error(), fatalerror(), and warning() methods to handle the different possible error conditions. Note that you should register the instance of the ErrorHandler interface with the XML reader. Otherwise, the errors generated during the parsing of the XML document will go unreported, and you might get some strange output. You will learn how to register and use the ErrorHandler methods later in the "Handling Errors" section in this chapter.

The DTDHandler Interface

This interface declares the methods that inform the application about notations and unparsed entities. Notations are used to represent non-parseable (binary) data, such as an image or a multimedia file, as entities in an XML document. This mechanism to represent binary data as an entity is a two-step process.

First, you need to provide an entity declaration for the binary data with the NDATA keyword. For example, to represent a movie file, the entity declaration could be like this:

<!ENTITY aMovieFile SYSTEM "http://xxxx.xxxx.xxxx/xxxx" NDATA avi>

The NDATA keyword specifies that data in the entity is not parseable and uses a different notation called avi.

Next, the DTD has to include a declaration for the notation. The DTD entry for the previous notation will be as follows:

<!NOTATION avi SYSTEM " http://xxxx.xxxx.xxxx/xxxx">

The DTDHandler interface declares two methods that are invoked when the parser reaches an unparsed entity and a notation. These methods pass on the unparsed entity and the notation information to the calling application.

The EntityResolver Interface

This interface declares the methods that enable the application to process the external entities. External entities are the entities that are defined outside the scope of the XML document being parsed, such as an external DTD, or an external parameter entity. Although by default the parser has the capability to process external entities automatically, this interface can be used to customize the handling of the external entity resolution. The customization of external entity resolution is covered in detail in Chapter 4.

This concludes the first part of this chapter. The next part will take you through a series of examples that will show you how SAX is used to process XML documents.

NOTE

To work through the examples, you'll first need to download the APIs. See Appendix A, "Installing the JAX APIs," to learn more about the process of downloading JAXP and the JAXP reference implementation provided by Sun. You will also need to download the Java Web Services Developer Pack (JWSDP). The JWSDP includes JAXP, as well as the Xalan and Xerces APIs. These are the default JAXP reference implementations for SAX, DOM, and XSLT.

After downloading the JWSDP, you need to set up the JAR files for JAXP and the JAXP reference implementation. After the JAR files are set up, you can begin coding the applications that use SAX.

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