This project has retired. For details please refer to its Attic page.

org.apache.cocoon.transformation
Class FilterTransformer

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.transformation.AbstractTransformer
                  org.apache.cocoon.transformation.FilterTransformer

All Implemented Interfaces:

Poolable, Recyclable, Component, LogEnabled, CacheableProcessingComponent, SitemapModelComponent, Transformer, XMLPipe, XMLProducer, XMLConsumer, ContentHandler, LexicalHandler

public class FilterTransformer
extends AbstractTransformer
implements CacheableProcessingComponent

Version:

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

Author:

Sven Beauprez, Carsten Ziegeler

Field Summary

protected int	blocknr
protected int	count
protected int	counter
protected int	currentBlocknr
protected String	elementName
protected boolean	foundIt
protected String	parentName
protected boolean	skip

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

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

FilterTransformer()

Method Summary

void	characters(char[] c, int start, int len) Receive notification of character data.
void	comment(char[] ch, int start, int len) Report an XML comment anywhere in the document.
void	endCDATA() Report the end of a CDATA section.
void	endElement(String uri, String name, String raw) Receive notification of the end of an element.
void	endEntity(String name) Report the end of an entity.
Serializable	getKey() Generate the unique key.
SourceValidity	getValidity() Generate the validity object.
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
void	setup(SourceResolver resolver, Map objectModel, String source, Parameters parameters) BEGIN SitemapComponent methods
void	startCDATA() Report the start of a CDATA section.
void	startElement(String uri, String name, String raw, Attributes attributes) BEGIN SAX ContentHandler handlers
void	startEntity(String name) Report the beginning of an entity.

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

endDocument, endDTD, endPrefixMapping, ignorableWhitespace, setDocumentLocator, skippedEntity, startDocument, startDTD, startPrefixMapping

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.xml.sax.ContentHandler

endDocument, endPrefixMapping, ignorableWhitespace, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping

Methods inherited from interface org.xml.sax.ext.LexicalHandler

endDTD, startDTD

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

setConsumer

Field Detail

counter

protected int counter

count

protected int count

blocknr

protected int blocknr

currentBlocknr

protected int currentBlocknr

elementName

protected String elementName

parentName

protected String parentName

skip

protected boolean skip

foundIt

protected boolean foundIt

Constructor Detail

FilterTransformer

public FilterTransformer()

Method Detail

setup

public void setup(SourceResolver resolver,
                  Map objectModel,
                  String source,
                  Parameters parameters)
           throws ProcessingException,
                  SAXException,
                  IOException

BEGIN SitemapComponent methods

Specified by:

setup in interface SitemapModelComponent

Throws:

ProcessingException

SAXException

IOException

getKey

public Serializable getKey()

Generate the unique key. This key must be unique inside the space of this component. This method must be invoked before the generateValidity() method.

Specified by:

getKey in interface CacheableProcessingComponent

Returns:

The generated key or 0 if the component is currently not cacheable.

getValidity

public SourceValidity getValidity()

Generate the validity object. Before this method can be invoked the generateKey() method must be invoked.

Specified by:

getValidity in interface CacheableProcessingComponent

Returns:

The generated validity object or null if the component is currently not cacheable.

startElement

public void startElement(String uri,
                         String name,
                         String raw,
                         Attributes attributes)
                  throws SAXException

BEGIN SAX ContentHandler handlers

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.

name - 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.

attributes - 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 name,
                       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.

name - 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

characters

public void characters(char[] c,
                       int start,
                       int len)
                throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of character data.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class AbstractXMLPipe

Parameters:

c - The characters from the XML document.

start - The start position in the array.

len - The number of characters to read from the array.

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of a processing instruction.

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class AbstractXMLPipe

Parameters:

target - The processing instruction target.

data - The processing instruction data, or null if none was supplied.

Throws:

SAXException

startEntity

public void startEntity(String name)
                 throws SAXException

Description copied from class: AbstractXMLPipe

Report the beginning of an entity.

Specified by:

startEntity in interface LexicalHandler

Overrides:

startEntity in class AbstractXMLPipe

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%'.

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Description copied from class: AbstractXMLPipe

Report the end of an entity.

Specified by:

endEntity in interface LexicalHandler

Overrides:

endEntity in class AbstractXMLPipe

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Description copied from class: AbstractXMLPipe

Report the start of a CDATA section.

Specified by:

startCDATA in interface LexicalHandler

Overrides:

startCDATA in class AbstractXMLPipe

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Description copied from class: AbstractXMLPipe

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

Overrides:

endCDATA in class AbstractXMLPipe

Throws:

SAXException

comment

public void comment(char[] ch,
                    int start,
                    int len)
             throws SAXException

Description copied from class: AbstractXMLPipe

Report an XML comment anywhere in the document.

Specified by:

comment in interface LexicalHandler

Overrides:

comment in class AbstractXMLPipe

Parameters:

ch - An array holding the characters in the comment.

start - The starting position in the array.

len - The number of characters to use from the array.

Throws:

SAXException