org.apache.cocoon.xml
Class RedundantNamespacesFilter

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.xml.RedundantNamespacesFilter

All Implemented Interfaces:

Poolable, Recyclable, LogEnabled, XMLPipe, XMLProducer, XMLConsumer, ContentHandler, LexicalHandler

public class RedundantNamespacesFilter
extends AbstractXMLPipe

A SAX filter that strips out redundant namespace declarations.

It handles both duplicate declarations (i.e. a namespace already declared by a parent element) and empty namespaces scopes (i.e. start/stopPrefixMapping with no element inbetween) that can be produced by some components (e.g. JXTG or BrowserUpdateTransformer). Such empty scopes confuse the Xalan serializer which then produces weird namespace declarations (xmlns:%@$#^@#="%@$#^@#").

This is a the most simple use of NamespacesTable.

Version:

CVS $Id: RedundantNamespacesFilter.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Constructor Summary

RedundantNamespacesFilter()
No-arg constructor.

RedundantNamespacesFilter(XMLConsumer consumer)
Creates a filter directly linked to its consumer

Method Summary

void	endElement(String uri, String loc, String raw) Receive notification of the end of an element.
void	endPrefixMapping(String prefix) End the scope of a prefix-URI mapping.
void	startElement(String uri, String loc, String raw, Attributes a) Receive notification of the beginning of an element.
void	startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping.

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

characters, comment, endCDATA, endDocument, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

recycle, setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Constructor Detail

RedundantNamespacesFilter

public RedundantNamespacesFilter()

No-arg constructor. Requires an explicit call to setConsumer().

RedundantNamespacesFilter

public RedundantNamespacesFilter(XMLConsumer consumer)

Creates a filter directly linked to its consumer

Parameters:

consumer - the SAX stream consumer

Method Detail

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Description copied from class: AbstractXMLPipe

Begin the scope of a prefix-URI Namespace mapping.

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class AbstractXMLPipe

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

Throws:

SAXException

startElement

public void startElement(String uri,
                         String loc,
                         String raw,
                         Attributes a)
                  throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class AbstractXMLPipe

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.

raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

a - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Throws:

SAXException

endElement

public void endElement(String uri,
                       String loc,
                       String raw)
                throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class AbstractXMLPipe

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

loc - The local name (without prefix), or the empty string if Namespace processing is not being performed.

raw - The raw XML 1.0 name (with prefix), or the empty string if raw names are not available.

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Description copied from class: AbstractXMLPipe

End the scope of a prefix-URI mapping.

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class AbstractXMLPipe

Parameters:

prefix - The prefix that was being mapping.

Throws:

SAXException