xml

The xml package contains additional classes useful for XML parsing.

XML parser

The XMLSAXParser class simplifies the creation of XML SAX parser. It works with the ResolverSAXHandler handler.

It allows to either:

• Validate the XML file using a DTD: XMLSAXParser.setHandlerDTD(URL, String)
• Validate the XML file using a Schema: XMLSAXParser.setSchema(URL)

The parser can be configured such as exceptions or XML warnings encountered during the validation will not be shown:

• XMLSAXParser.showExceptions(boolean)
• XMLSAXParser.showWarnings(boolean)

A custom EntityResolver Can be used for resolving entities during the parsing^[1]

As for example the EntityListResolver in the same package

.

ResolverSAXHandler

The XMLSAXParser class works with the ResolverSAXHandler handler.

Setting the locale

By default, the Locale of the parser is the default locale of the platform. However, it is possible to change the locale of the parser.

Examples

Create a validating parser using a DTD

  XMLSAXParser parser = new XMLSAXParser("My Parser");
  parser.setValidating(true);
  parser.setHandlerDTD(dtd);
  parser.setHandler(handler);
  parse.parse(file);

Create a validating parser using a Schema

  XMLSAXParser parser = new XMLSAXParser("My Parser");
  parser.setValidating(true);
  parser.setSchema(schema);
  parser.setHandler(handler);
  parse.parse(file);

Create a validating parser and get the parsing exceptions

  XMLSAXParser parser = new XMLSAXParser("My Parser");
  parser.setValidating(true);
  parser.setSchema(schema);
  parser.setHandler(handler);
  parser.showExceptions(false);
  parse.parse(file);

  if (handler.hasParserExceptions()) {
    List>ResolverSAXHandler.ExceptionResult> results = handler.getExceptionResults();
  }

EntityListResolver

The EntityListResolver class manage entity resolution in XML files. It implements all the following interfaces:

• The LSResourceResolver interface used for DOM parsing
• The EntityResolver interface used for SAX parsing
• The URIResolver interface used for XSL transform

This class offer a framework to resolve resources encountered in XML files (including XML Schemas).

Note that this class is able to resolve sibling entities of an entity which has been resolved. For example, if the following systemID is resolved:

• "http://location/refXSD.xsd" => "D:/myFiles/schemas/refXSD.xsd"

Then upon encountering the following entity (for example referred to in refXSD.xsd):

• "http://location/childSchema.xsd"

The resolver will look for the following resource:

• "D:/myFiles/schemas/childSchema.xsd"

XMLWriter

The XMLWriter class is a helper class which allows to write an XML Document.

XMLRootDetector

The XMLRootDetector class allows to get the root element of an XML file or only its name. Note that this class uses a Stax parser, which means that it will stop the parsing as soon as this element has been encountered.

The XML root element is a XMLNode, which maintains the structure of the XML content, including the parent-children nodes relationships.

XMLTreeHandler

The XMLTreeHandler class allows to get the tree of XML elements in an XML file. The result will be a XMLNode, which maintains the structure of the XML content, including the parent-children nodes relationships.

XML Includer

The XMLIncluder class process the XInclude declarations in a XML file and creates a returning Reader^[2]

Note that if you want to parse and validate an XML file, you don't need to use this class directly, but you can directly configure the XML parser class

.

For example:

  XMLIncluder includer = new XMLIncluder(<my XML file>);
  String content = includer.getContent();

The XMLNodeIncluder class does the same but uses the xml.tree nodes to create the tree structure.

For example:

   XMLNodeIncluder includer = new XMLNodeIncluder(<my XML file>);
   includer.write(<my output XML file>);

XMLNodeUtilities

The XMLNodeUtilities class contains various utilities concerning XML content. It work on the XMLNode root of the XML content:

• The XMLNodeUtilities.print(XMLNode, int) method allows to get the String content associated with the XML content under a root node
• The XMLNodeUtilities.search(XMLNode, String, boolean) method allows to search for the list of children nodes which have a specific name under a root node

The XMLNodeUtilities2 class does the same thing, but has only instance methods. This class offers more customization capabilities.