XMLFilterImpl

Base class for deriving an XML filter.

<p>This class is designed to sit between an {@link org.xml.sax.XMLReader XMLReader} and the client application's event handlers. By default, it does nothing but pass requests up to the reader and events on to the handlers unmodified, but subclasses can override specific methods to modify the event stream or the configuration requests as they pass through.</p>

@since SAX 2.0 @author David Megginson @version 2.0.1 (sax2r2) @see org.xml.sax.XMLFilter @see org.xml.sax.XMLReader @see org.xml.sax.EntityResolver @see org.xml.sax.ContentHandler @see org.xml.sax.ErrorHandler

class XMLFilterImpl : SaxHandler , XMLFilter , EntityResolver , ErrorHandler (

Ch = char

) {

this();

this(XMLReader parent);

void setParent(XMLReader parent);

XMLReader getParent();

void setFeature(const(Ch)[] name, bool value);

bool getFeature(const(Ch)[] name);

void setProperty(const(Ch)[] name, Object value);

Object getProperty(const(Ch)[] name);

void setEntityResolver(EntityResolver resolver);

EntityResolver getEntityResolver();

void setSaxHandler(SaxHandler handler);

SaxHandler getSaxHandler();

void setErrorHandler(ErrorHandler handler);

ErrorHandler getErrorHandler();

void parse(const(Ch)[] content);

void parse();

void setContent(const(Ch)[] content);

InputStream resolveEntity(const(Ch)[] publicId, const(Ch)[] systemId);

void setDocumentLocator(Locator locator);

void startDocument();

void endDocument();

void startPrefixMapping(const(Ch)[] prefix, const(Ch)[] uri);

void endPrefixMapping(const(Ch)[] prefix);

void startElement(const(Ch)[] uri, const(Ch)[] localName, const(Ch)[] qName, Attribute[] atts);

void endElement(const(Ch)[] uri, const(Ch)[] localName, const(Ch)[] qName);

void characters(Ch[] ch);

void ignorableWhitespace(Ch[] ch);

void processingInstruction(const(Ch)[] target, const(Ch)[] data);

void skippedEntity(const(Ch)[] name);

void warning(SAXException e);

void error(SAXException e);

void fatalError(SAXException e);

}

Constructors

this this(): Construct an empty XML filter, with no parent.
this this(XMLReader parent): Construct an XML filter with the specified parent.

Members

Functions

characters void characters(Ch[] ch): Filter a character data event.
endDocument void endDocument(): Filter an end document event.
endElement void endElement(const(Ch)[] uri, const(Ch)[] localName, const(Ch)[] qName): Filter an end element event.
endPrefixMapping void endPrefixMapping(const(Ch)[] prefix): Filter an end Namespace prefix mapping event.
error void error(SAXException e): Filter an error event.
fatalError void fatalError(SAXException e): Filter a fatal error event.
getEntityResolver EntityResolver getEntityResolver(): Get the current entity resolver.
getErrorHandler ErrorHandler getErrorHandler(): Get the current error event handler.
getFeature bool getFeature(const(Ch)[] name): Look up the value of a feature.
getParent XMLReader getParent(): Get the parent reader.
getProperty Object getProperty(const(Ch)[] name): Look up the value of a property.
getSaxHandler SaxHandler getSaxHandler(): Get the content event handler.
ignorableWhitespace void ignorableWhitespace(Ch[] ch): Filter an ignorable whitespace event.
parse void parse(const(Ch)[] content): Parse the given content.
parse void parse(): Undocumented in source. Be warned that the author may not have intended to support it.
processingInstruction void processingInstruction(const(Ch)[] target, const(Ch)[] data): Filter a processing instruction event.
resolveEntity InputStream resolveEntity(const(Ch)[] publicId, const(Ch)[] systemId): Filter an external entity resolution.
setContent void setContent(const(Ch)[] content): Undocumented in source. Be warned that the author may not have intended to support it.
setDocumentLocator void setDocumentLocator(Locator locator): Filter a new document locator event.
setEntityResolver void setEntityResolver(EntityResolver resolver): Set the entity resolver.
setErrorHandler void setErrorHandler(ErrorHandler handler): Set the error event handler.
setFeature void setFeature(const(Ch)[] name, bool value): Set the value of a feature.
setParent void setParent(XMLReader parent): Set the parent reader.
setProperty void setProperty(const(Ch)[] name, Object value): Set the value of a property.
setSaxHandler void setSaxHandler(SaxHandler handler): Set the content event handler.
skippedEntity void skippedEntity(const(Ch)[] name): Filter a skipped entity event.
startDocument void startDocument(): Filter a start document event.
startElement void startElement(const(Ch)[] uri, const(Ch)[] localName, const(Ch)[] qName, Attribute[] atts): Filter a start element event.
startPrefixMapping void startPrefixMapping(const(Ch)[] prefix, const(Ch)[] uri): Filter a start Namespace prefix mapping event.
warning void warning(SAXException e): Filter a warning event.

Inherited Members

From SaxHandler

locator Locator!(Ch) locator;: Undocumented in source.
setDocumentLocator void setDocumentLocator(Locator!(Ch) locator): Receive an object for locating the origin of SAX document events.
startDocument void startDocument(): Receive notification of the beginning of a document.
endDocument void endDocument(): Receive notification of the end of a document.
startPrefixMapping void startPrefixMapping(const(Ch)[] prefix, const(Ch)[] uri): Begin the scope of a prefix-URI Namespace mapping.
endPrefixMapping void endPrefixMapping(const(Ch)[] prefix): End the scope of a prefix-URI mapping.
startElement void startElement(const(Ch)[] uri, const(Ch)[] localName, const(Ch)[] qName, Attribute!(Ch)[] atts): Receive notification of the beginning of an element.
endElement void endElement(const(Ch)[] uri, const(Ch)[] localName, const(Ch)[] qName): Receive notification of the end of an element.
characters void characters(const(Ch)[] ch): Receive notification of character data.
ignorableWhitespace void ignorableWhitespace(Ch[] ch): Receive notification of ignorable whitespace in element content.
processingInstruction void processingInstruction(const(Ch)[] target, const(Ch)[] data): Receive notification of a processing instruction.
skippedEntity void skippedEntity(const(Ch)[] name): Receive notification of a skipped entity. This is not called for entity references within markup constructs such as element start tags or markup declarations. (The XML recommendation requires reporting skipped external entities. SAX also reports internal entity expansion/non-expansion, except within markup constructs.)

From XMLFilter

setParent void setParent(XMLReader parent): Set the parent reader.
getParent XMLReader getParent(): Get the parent reader.

From EntityResolver

resolveEntity InputStream resolveEntity(const(Ch)[] publicId, const(Ch)[] systemId): Allow the application to resolve external entities.

From ErrorHandler

warning void warning(SAXException exception): Receive notification of a warning.
error void error(SAXException exception): Receive notification of a recoverable error.
fatalError void fatalError(SAXException exception): Receive notification of a non-recoverable error.