Home » xml-commons-external-1.4.01-src » org.xml » sax » helpers » [javadoc | source]
org.xml.sax.helpers
public class: XMLFilterImpl [javadoc | source]
java.lang.Object
   org.xml.sax.helpers.XMLFilterImpl

All Implemented Interfaces:
    ContentHandler, DTDHandler, ErrorHandler, XMLFilter, EntityResolver

Base class for deriving an XML filter.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This class is designed to sit between an 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.

Constructor:
 public XMLFilterImpl() 
    Also see:
    org.xml.sax.XMLReader#setFeature
    org.xml.sax.XMLReader#setProperty
    setParent
 public XMLFilterImpl(XMLReader parent) 
    Construct an XML filter with the specified parent.
Method from org.xml.sax.helpers.XMLFilterImpl Summary:
characters,   endDocument,   endElement,   endPrefixMapping,   error,   fatalError,   getContentHandler,   getDTDHandler,   getEntityResolver,   getErrorHandler,   getFeature,   getParent,   getProperty,   ignorableWhitespace,   notationDecl,   parse,   parse,   processingInstruction,   resolveEntity,   setContentHandler,   setDTDHandler,   setDocumentLocator,   setEntityResolver,   setErrorHandler,   setFeature,   setParent,   setProperty,   skippedEntity,   startDocument,   startElement,   startPrefixMapping,   unparsedEntityDecl,   warning
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.xml.sax.helpers.XMLFilterImpl Detail:
 public  void characters(char[] ch,
    int start,
    int length) throws SAXException 
    Filter a character data event.
 public  void endDocument() throws SAXException 
    Filter an end document event.
 public  void endElement(String uri,
    String localName,
    String qName) throws SAXException 
    Filter an end element event.
 public  void endPrefixMapping(String prefix) throws SAXException 
    Filter an end Namespace prefix mapping event.
 public  void error(SAXParseException e) throws SAXException 
    Filter an error event.
 public  void fatalError(SAXParseException e) throws SAXException 
    Filter a fatal error event.
 public ContentHandler getContentHandler() 
    Get the content event handler.
 public DTDHandler getDTDHandler() 
    Get the current DTD event handler.
 public EntityResolver getEntityResolver() 
    Get the current entity resolver.
 public ErrorHandler getErrorHandler() 
    Get the current error event handler.
 public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException 
    Look up the value of a feature.

    This will always fail if the parent is null.

 public XMLReader getParent() 
    Get the parent reader.
 public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException 
    Look up the value of a property.
 public  void ignorableWhitespace(char[] ch,
    int start,
    int length) throws SAXException 
    Filter an ignorable whitespace event.
 public  void notationDecl(String name,
    String publicId,
    String systemId) throws SAXException 
    Filter a notation declaration event.
 public  void parse(InputSource input) throws SAXException, IOException 
    Parse a document.
 public  void parse(String systemId) throws SAXException, IOException 
    Parse a document.
 public  void processingInstruction(String target,
    String data) throws SAXException 
    Filter a processing instruction event.
 public InputSource resolveEntity(String publicId,
    String systemId) throws SAXException, IOException 
    Filter an external entity resolution.
 public  void setContentHandler(ContentHandler handler) 
    Set the content event handler.
 public  void setDTDHandler(DTDHandler handler) 
    Set the DTD event handler.
 public  void setDocumentLocator(Locator locator) 
    Filter a new document locator event.
 public  void setEntityResolver(EntityResolver resolver) 
    Set the entity resolver.
 public  void setErrorHandler(ErrorHandler handler) 
    Set the error event handler.
 public  void setFeature(String name,
    boolean value) throws SAXNotRecognizedException, SAXNotSupportedException 
    Set the value of a feature.

    This will always fail if the parent is null.

 public  void setParent(XMLReader parent) 
    Set the parent reader.

    This is the XMLReader from which this filter will obtain its events and to which it will pass its configuration requests. The parent may itself be another filter.

    If there is no parent reader set, any attempt to parse or to set or get a feature or property will fail.

 public  void setProperty(String name,
    Object value) throws SAXNotRecognizedException, SAXNotSupportedException 
    Set the value of a property.

    This will always fail if the parent is null.

 public  void skippedEntity(String name) throws SAXException 
    Filter a skipped entity event.
 public  void startDocument() throws SAXException 
    Filter a start document event.
 public  void startElement(String uri,
    String localName,
    String qName,
    Attributes atts) throws SAXException 
    Filter a start element event.
 public  void startPrefixMapping(String prefix,
    String uri) throws SAXException 
    Filter a start Namespace prefix mapping event.
 public  void unparsedEntityDecl(String name,
    String publicId,
    String systemId,
    String notationName) throws SAXException 
    Filter an unparsed entity declaration event.
 public  void warning(SAXParseException e) throws SAXException 
    Filter a warning event.