Class ResolvingXMLFilter

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

org.xmlresolver.tools.ResolvingXMLFilter

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler, XMLFilter, XMLReader

Direct Known Subclasses:

ResolvingXMLReader

public class ResolvingXMLFilter
extends XMLFilterImpl

An implementation of XMLFilter that performs catalog resolution.

This class implements the oasis-xml-catalog processing instruction if the underlying resolver allows it.

Each instance constructed with the zero-argument constructor uses a shared, static resolver. This avoids paying the instantiation cost each time a parse is created.

Author:

ndw

Field Summary

Fields

Modifier and Type	Field	Description
protected final ResolverLogger	logger
protected Resolver	resolver
protected static Resolver	staticResolver

Constructor Summary

Constructors

Constructor	Description
ResolvingXMLFilter()	Construct a filter with the default resolver.
ResolvingXMLFilter(XMLReader parent, Resolver resolver)	Construct an XML filter with the specified parent and resolver.
ResolvingXMLFilter(Resolver resolver)	Construct an XML filter with the specified resolver.

Method Summary

Modifier and Type	Method	Description
Resolver	getResolver()	Provide access to the underlying Catalog.
void	notationDecl(String name, String publicId, String systemId)	SAX DTDHandler API.
void	parse(String systemId)	SAX XMLReader API.
void	parse(InputSource input)	Parse a document.
void	processingInstruction(String target, String pidata)	SAX ContentHandler API.
InputSource	resolveEntity(String publicId, String systemId)	Implements the resolveEntity method for the SAX interface, using an underlying CatalogResolver to do the real work.
InputSource	resolveEntity(String name, String publicId, String baseURI, String systemId)	Implements the EntityResolver2 interface.
void	startElement(String uri, String localName, String qName, Attributes atts)	SAX ContentHandler API.
void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName)	SAX DTDHandler API.

Methods inherited from class XMLFilterImpl

characters, endDocument, endElement, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent, setProperty, skippedEntity, startDocument, startPrefixMapping, warning

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ContentHandler

declaration

Field Details

logger

protected final ResolverLogger logger

staticResolver

protected static Resolver staticResolver

resolver

protected Resolver resolver

Constructor Details

ResolvingXMLFilter

public ResolvingXMLFilter()

Construct a filter with the default resolver.

ResolvingXMLFilter

public ResolvingXMLFilter(Resolver resolver)

Construct an XML filter with the specified resolver.

Parameters:

resolver - The resolver

ResolvingXMLFilter

public ResolvingXMLFilter(XMLReader parent,
 Resolver resolver)

Construct an XML filter with the specified parent and resolver.

Parameters:

parent - The parent reader

resolver - The resolver

Method Details

getResolver

public Resolver getResolver()

Provide access to the underlying Catalog.

Returns:

The underlying resolver

parse

public void parse(InputSource input)
           throws IOException,
SAXException

Parse a document.

If the input doesn't have an associated open stream, this class will attempt to find the URI of the input in the catalog.

Specified by:

parse in interface XMLReader

Overrides:

parse in class XMLFilterImpl

Throws:

IOException

SAXException

parse

public void parse(String systemId)
           throws IOException,
SAXException

SAX XMLReader API.

Specified by:

parse in interface XMLReader

Overrides:

parse in class XMLFilterImpl

Throws:

IOException

SAXException

See Also:

• parse(InputSource)

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws SAXException,
IOException

Implements the resolveEntity method for the SAX interface, using an underlying CatalogResolver to do the real work.

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class XMLFilterImpl

Throws:

SAXException

IOException

resolveEntity

public InputSource resolveEntity(String name,
 String publicId,
 String baseURI,
 String systemId)
                          throws SAXException,
IOException

Implements the EntityResolver2 interface.

Parameters:

name - The entity name

publicId - The entity public identifier

baseURI - The base URI

systemId - The entity system identifier

Returns:

The resolved entity

Throws:

SAXException - If a SAX error occurs

IOException - If an I/O error occurs

notationDecl

public void notationDecl(String name,
 String publicId,
 String systemId)
                  throws SAXException

SAX DTDHandler API.

Captured here only to detect the end of the prolog so that we can ignore subsequent oasis-xml-catalog PIs. Otherwise the events are just passed through.

Specified by:

notationDecl in interface DTDHandler

Overrides:

notationDecl in class XMLFilterImpl

Throws:

SAXException

unparsedEntityDecl

public void unparsedEntityDecl(String name,
 String publicId,
 String systemId,
 String notationName)
                        throws SAXException

SAX DTDHandler API.

Captured here only to detect the end of the prolog so that we can ignore subsequent oasis-xml-catalog PIs. Otherwise the events are just passed through.

Specified by:

unparsedEntityDecl in interface DTDHandler

Overrides:

unparsedEntityDecl in class XMLFilterImpl

Throws:

SAXException

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes atts)
                  throws SAXException

SAX ContentHandler API.

Captured here only to detect the end of the prolog so that we can ignore subsequent oasis-xml-catalog PIs. Otherwise the events are just passed through.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class XMLFilterImpl

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
 String pidata)
                           throws SAXException

SAX ContentHandler API.

Detect and use the oasis-xml-catalog PI if it occurs.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class XMLFilterImpl

Throws:

SAXException