com.deltaxml.pipe.filters

Class CleanHouse

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

com.deltaxml.pipe.XMLFilterImpl2

com.deltaxml.pipe.filters.CleanHouse

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.XMLFilter, org.xml.sax.XMLReader

public final class CleanHouse
extends XMLFilterImpl2

Removes all elements or attributes in specified deltaxml namespaces.

All elements (including their contents) and attributes within the following namespaces are removed:

• deltaxml - http://www.deltaxml.com/ns/well-formed-delta-v1
• dxwarn2 - http://www.deltaxml.com/ns/warning-for-2-way-merge

CleanHouse is designed to be used as a post-filter. It should be used as the last filter in the XMLComparator output pipeline.

Note: This class has not been designed to be extended, therefore to err on the side of caution, it has been declared final.

Constructor Summary

Constructors

Constructor and Description
CleanHouse() Creates a new instance of CleanHouse.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) Overrides the default characters method.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Overrides the default endElement method.
void	endPrefixMapping(java.lang.String prefix) Overrides the default endPrefixMapping method.
void	startDocument() Overrides the default startDocument.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) Overrides the default startElement method.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Overrides the default startPrefixMapping method.

Methods inherited from class com.deltaxml.pipe.XMLFilterImpl2

attributeDecl, comment, elementDecl, endCDATA, endDTD, endEntity, externalEntityDecl, getProperty, internalEntityDecl, parse, parse, setProperty, startCDATA, startDTD, startEntity

Methods inherited from class org.xml.sax.helpers.XMLFilterImpl

endDocument, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setParent, skippedEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

CleanHouse

public CleanHouse()

Creates a new instance of CleanHouse.

Method Detail

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Overrides the default startPrefixMapping method. This version of the method filters out all mappings for namespaces scheduled for removal.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

prefix - the namespace prefix

uri - the URI of the namespace

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.startPrefixMapping(String, String)

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Overrides the default endPrefixMapping method. This version of the method filters out all mappings for namespaces scheduled for removal.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

prefix - the namespace prefix

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.endPrefixMapping(String)

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

Overrides the default startElement method. This version of the method filters out any elements residing in one of the namespaces scheduled for removal.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

uri - the URI of the element's namespace

localName - the element's localname

qName - the element's qualified name

atts - the element's attributes

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.startElement(String, String, String, Attributes)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Overrides the default endElement method. This version of the method filters out any elements residing in one of the namespaces scheduled for removal.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

uri - the URI of the element's namespace

localName - the element's localname

qName - the element's qualified name

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.endElement(String, String, String)

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Overrides the default startDocument. Although the start/endElement methods have balanced pushing/poping of charstack we'll be extra cautious and add this method to ensure serial reusability of this filter.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.XMLFilterImpl

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Overrides the default characters method. This version of the method filters out characters within elements that are scheduled for removal.

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.XMLFilterImpl

Parameters:

ch - an array of characters

start - the starting position in the array

length - the number of characters to use from the array

Throws:

org.xml.sax.SAXException - the superclass may throw an exception during processing.

See Also:

XMLFilterImpl.characters(char[], int, int)