Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> xml >> sax >> [ helpers overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.xml.sax.helpers.XMLFilterImpl JAVADOC | Sourc code of org.xml.sax.helpers.XMLFilterImpl SOURCE | Download org.xml.sax.helpers.XMLFilterImpl DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.xml.sax.helpers
Class XMLFilterImpl  view XMLFilterImpl download XMLFilterImpl.java

java.lang.Object
  extended byorg.xml.sax.helpers.XMLFilterImpl
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.XMLFilter, org.xml.sax.XMLReader
public class XMLFilterImpl
extends java.lang.Object
implements org.xml.sax.XMLFilter, org.xml.sax.EntityResolver, org.xml.sax.DTDHandler, org.xml.sax.ContentHandler, org.xml.sax.ErrorHandler

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.

Since:
SAX 2.0
Version:
2.0.1 (sax2r2)

Field Summary
private  org.xml.sax.ContentHandler contentHandler
           
private  org.xml.sax.DTDHandler dtdHandler
           
private  org.xml.sax.EntityResolver entityResolver
           
private  org.xml.sax.ErrorHandler errorHandler
           
private  org.xml.sax.Locator locator
           
private  org.xml.sax.XMLReader parent
           
 
Constructor Summary
XMLFilterImpl()
          Construct an empty XML filter, with no parent.
XMLFilterImpl(org.xml.sax.XMLReader parent)
          Construct an XML filter with the specified parent.
 
Method Summary
 void characters(char[] ch, int start, int length)
          Filter a character data event.
 void endDocument()
          Filter an end document event.
 void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
          Filter an end element event.
 void endPrefixMapping(java.lang.String prefix)
          Filter an end Namespace prefix mapping event.
 void error(org.xml.sax.SAXParseException e)
          Filter an error event.
 void fatalError(org.xml.sax.SAXParseException e)
          Filter a fatal error event.
 org.xml.sax.ContentHandler getContentHandler()
          Get the content event handler.
 org.xml.sax.DTDHandler getDTDHandler()
          Get the current DTD event handler.
 org.xml.sax.EntityResolver getEntityResolver()
          Get the current entity resolver.
 org.xml.sax.ErrorHandler getErrorHandler()
          Get the current error event handler.
 boolean getFeature(java.lang.String name)
          Look up the value of a feature.
 org.xml.sax.XMLReader getParent()
          Get the parent reader.
 java.lang.Object getProperty(java.lang.String name)
          Look up the value of a property.
 void ignorableWhitespace(char[] ch, int start, int length)
          Filter an ignorable whitespace event.
 void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          Filter a notation declaration event.
 void parse(org.xml.sax.InputSource input)
          Parse a document.
 void parse(java.lang.String systemId)
          Parse a document.
 void processingInstruction(java.lang.String target, java.lang.String data)
          Filter a processing instruction event.
 org.xml.sax.InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId)
          Filter an external entity resolution.
 void setContentHandler(org.xml.sax.ContentHandler handler)
          Set the content event handler.
 void setDocumentLocator(org.xml.sax.Locator locator)
          Filter a new document locator event.
 void setDTDHandler(org.xml.sax.DTDHandler handler)
          Set the DTD event handler.
 void setEntityResolver(org.xml.sax.EntityResolver resolver)
          Set the entity resolver.
 void setErrorHandler(org.xml.sax.ErrorHandler handler)
          Set the error event handler.
 void setFeature(java.lang.String name, boolean value)
          Set the value of a feature.
 void setParent(org.xml.sax.XMLReader parent)
          Set the parent reader.
 void setProperty(java.lang.String name, java.lang.Object value)
          Set the value of a property.
private  void setupParse()
          Set up before a parse.
 void skippedEntity(java.lang.String name)
          Filter a skipped entity event.
 void startDocument()
          Filter a start document event.
 void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
          Filter a start element event.
 void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
          Filter a start Namespace prefix mapping event.
 void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
          Filter an unparsed entity declaration event.
 void warning(org.xml.sax.SAXParseException e)
          Filter a warning event.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

parent

private org.xml.sax.XMLReader parent

locator

private org.xml.sax.Locator locator

entityResolver

private org.xml.sax.EntityResolver entityResolver

dtdHandler

private org.xml.sax.DTDHandler dtdHandler

contentHandler

private org.xml.sax.ContentHandler contentHandler

errorHandler

private org.xml.sax.ErrorHandler errorHandler
Constructor Detail

XMLFilterImpl

public XMLFilterImpl()
Construct an empty XML filter, with no parent.

This filter will have no parent: you must assign a parent before you start a parse or do any configuration with setFeature or setProperty, unless you use this as a pure event consumer rather than as an org.xml.sax.XMLReader.

XMLFilterImpl

public XMLFilterImpl(org.xml.sax.XMLReader parent)
Construct an XML filter with the specified parent.

Method Detail

setParent

public void setParent(org.xml.sax.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.

Specified by:
setParent in interface org.xml.sax.XMLFilter

getParent

public org.xml.sax.XMLReader getParent()
Get the parent reader.

Specified by:
getParent in interface org.xml.sax.XMLFilter

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException
Set the value of a feature.

This will always fail if the parent is null.

Specified by:
setFeature in interface org.xml.sax.XMLReader

getFeature

public boolean getFeature(java.lang.String name)
                   throws org.xml.sax.SAXNotRecognizedException,
                          org.xml.sax.SAXNotSupportedException
Look up the value of a feature.

This will always fail if the parent is null.

Specified by:
getFeature in interface org.xml.sax.XMLReader

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException
Set the value of a property.

This will always fail if the parent is null.

Specified by:
setProperty in interface org.xml.sax.XMLReader

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException,
                                    org.xml.sax.SAXNotSupportedException
Look up the value of a property.

Specified by:
getProperty in interface org.xml.sax.XMLReader

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver resolver)
Set the entity resolver.

Specified by:
setEntityResolver in interface org.xml.sax.XMLReader

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()
Get the current entity resolver.

Specified by:
getEntityResolver in interface org.xml.sax.XMLReader

setDTDHandler

public void setDTDHandler(org.xml.sax.DTDHandler handler)
Set the DTD event handler.

Specified by:
setDTDHandler in interface org.xml.sax.XMLReader

getDTDHandler

public org.xml.sax.DTDHandler getDTDHandler()
Get the current DTD event handler.

Specified by:
getDTDHandler in interface org.xml.sax.XMLReader

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler handler)
Set the content event handler.

Specified by:
setContentHandler in interface org.xml.sax.XMLReader

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()
Get the content event handler.

Specified by:
getContentHandler in interface org.xml.sax.XMLReader

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler handler)
Set the error event handler.

Specified by:
setErrorHandler in interface org.xml.sax.XMLReader

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()
Get the current error event handler.

Specified by:
getErrorHandler in interface org.xml.sax.XMLReader

parse

public void parse(org.xml.sax.InputSource input)
           throws org.xml.sax.SAXException,
                  java.io.IOException
Parse a document.

Specified by:
parse in interface org.xml.sax.XMLReader

parse

public void parse(java.lang.String systemId)
           throws org.xml.sax.SAXException,
                  java.io.IOException
Parse a document.

Specified by:
parse in interface org.xml.sax.XMLReader

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                             java.lang.String systemId)
                                      throws org.xml.sax.SAXException,
                                             java.io.IOException
Filter an external entity resolution.

Specified by:
resolveEntity in interface org.xml.sax.EntityResolver

notationDecl

public void notationDecl(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)
                  throws org.xml.sax.SAXException
Filter a notation declaration event.

Specified by:
notationDecl in interface org.xml.sax.DTDHandler

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)
                        throws org.xml.sax.SAXException
Filter an unparsed entity declaration event.

Specified by:
unparsedEntityDecl in interface org.xml.sax.DTDHandler

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)
Filter a new document locator event.

Specified by:
setDocumentLocator in interface org.xml.sax.ContentHandler

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
Filter a start document event.

Specified by:
startDocument in interface org.xml.sax.ContentHandler

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Filter an end document event.

Specified by:
endDocument in interface org.xml.sax.ContentHandler

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException
Filter a start Namespace prefix mapping event.

Specified by:
startPrefixMapping in interface org.xml.sax.ContentHandler

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException
Filter an end Namespace prefix mapping event.

Specified by:
endPrefixMapping in interface org.xml.sax.ContentHandler

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException
Filter a start element event.

Specified by:
startElement in interface org.xml.sax.ContentHandler

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
Filter an end element event.

Specified by:
endElement in interface org.xml.sax.ContentHandler

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
Filter a character data event.

Specified by:
characters in interface org.xml.sax.ContentHandler

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException
Filter an ignorable whitespace event.

Specified by:
ignorableWhitespace in interface org.xml.sax.ContentHandler

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException
Filter a processing instruction event.

Specified by:
processingInstruction in interface org.xml.sax.ContentHandler

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException
Filter a skipped entity event.

Specified by:
skippedEntity in interface org.xml.sax.ContentHandler

warning

public void warning(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException
Filter a warning event.

Specified by:
warning in interface org.xml.sax.ErrorHandler

error

public void error(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException
Filter an error event.

Specified by:
error in interface org.xml.sax.ErrorHandler

fatalError

public void fatalError(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException
Filter a fatal error event.

Specified by:
fatalError in interface org.xml.sax.ErrorHandler

setupParse

private void setupParse()
Set up before a parse.

Before every parse, check whether the parent is non-null, and re-register the filter for all of the events.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> org >> xml >> sax >> [ helpers overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of org.xml.sax.helpers.XMLFilterImpl JAVADOC | Sourc code of org.xml.sax.helpers.XMLFilterImpl SOURCE | Download org.xml.sax.helpers.XMLFilterImpl DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD