org.apache.cocoon.woody.transformation
Class EffectPipe

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.woody.transformation.EffectPipe

All Implemented Interfaces:

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

Direct Known Subclasses:

EffectWidgetReplacingPipe

public class EffectPipe
extends AbstractXMLPipe

Nested Class Summary

protected class	EffectPipe.BufferHandler
protected class	EffectPipe.Element
protected class	EffectPipe.Handler
protected class	EffectPipe.NullHandler
protected class	EffectPipe.Output

Field Summary

protected EffectPipe.Handler	bufferHandler
protected char[]	c
protected String	data
protected LinkedList	elements
protected int	event
protected static int	EVENT_CHARACTERS
protected static int	EVENT_COMMENT
protected static int	EVENT_ELEMENT
protected static int	EVENT_END_CDATA
protected static int	EVENT_END_DOCUMENT
protected static int	EVENT_END_DTD
protected static int	EVENT_END_ELEMENT
protected static int	EVENT_END_ENTITY
protected static int	EVENT_END_PREFIX_MAPPING
protected static int	EVENT_IGNORABLE_WHITESPACE
protected static int	EVENT_PROCESSING_INSTRUCTION
protected static int	EVENT_SET_DOCUMENT_LOCATOR
protected static int	EVENT_SKIPPED_ENTITY
protected static int	EVENT_START_CDATA
protected static int	EVENT_START_DOCUMENT
protected static int	EVENT_START_DTD
protected static int	EVENT_START_ELEMENT
protected static int	EVENT_START_ENTITY
protected static int	EVENT_START_PREFIX_MAPPING
protected EffectPipe.Handler	handler
protected LinkedList	handlers
protected EffectPipe.Element	input
protected int	len
protected Locator	locator
protected String	name
protected EffectPipe.Handler	nullHandler
EffectPipe.Output	out
protected String	prefix
protected String	publicId
protected int	start
protected String	systemId
protected String	target
protected String	uri

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

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Constructor Summary

EffectPipe()

Method Summary

void	characters(char[] c, int start, int len) Receive notification of character data.
void	comment(char[] c, int start, int len) Report an XML comment anywhere in the document.
void	endCDATA() Report the end of a CDATA section.
void	endDocument() Receive notification of the end of a document.
void	endDTD() Report the end of DTD declarations.
void	endElement(String uri, String loc, String raw) Receive notification of the end of an element.
void	endEntity(String name) Report the end of an entity.
void	endPrefixMapping(String prefix) End the scope of a prefix-URI mapping.
void	ignorableWhitespace(char[] c, int start, int len) Receive notification of ignorable whitespace in element content.
void	init()
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
void	recycle() Recycle the producer by removing references, and resetting handlers to null (empty) implementations.
void	setConsumer(XMLConsumer consumer) Set the XMLConsumer that will receive XML data.
void	setContentHandler(ContentHandler handler) Set the ContentHandler that will receive XML data.
void	setDocumentLocator(Locator locator) Receive an object for locating the origin of SAX document events.
void	setLexicalHandler(LexicalHandler handler) Set the LexicalHandler that will receive XML data.
void	skippedEntity(String name) Receive notification of a skipped entity.
void	startCDATA() Report the start of a CDATA section.
void	startDocument() Receive notification of the beginning of a document.
void	startDTD(String name, String publicId, String systemId) Report the start of DTD declarations, if any.
void	startElement(String uri, String loc, String raw, Attributes attrs) Receive notification of the beginning of an element.
void	startEntity(String name) Report the beginning of an entity.
void	startPrefixMapping(String prefix, String uri) Begin the scope of a prefix-URI Namespace mapping.

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

Field Detail

EVENT_SET_DOCUMENT_LOCATOR

protected static final int EVENT_SET_DOCUMENT_LOCATOR

See Also:

Constant Field Values

EVENT_START_DOCUMENT

protected static final int EVENT_START_DOCUMENT

See Also:

Constant Field Values

EVENT_END_DOCUMENT

protected static final int EVENT_END_DOCUMENT

See Also:

Constant Field Values

EVENT_START_PREFIX_MAPPING

protected static final int EVENT_START_PREFIX_MAPPING

See Also:

Constant Field Values

EVENT_END_PREFIX_MAPPING

protected static final int EVENT_END_PREFIX_MAPPING

See Also:

Constant Field Values

EVENT_START_ELEMENT

protected static final int EVENT_START_ELEMENT

See Also:

Constant Field Values

EVENT_END_ELEMENT

protected static final int EVENT_END_ELEMENT

See Also:

Constant Field Values

EVENT_ELEMENT

protected static final int EVENT_ELEMENT

See Also:

Constant Field Values

EVENT_CHARACTERS

protected static final int EVENT_CHARACTERS

See Also:

Constant Field Values

EVENT_IGNORABLE_WHITESPACE

protected static final int EVENT_IGNORABLE_WHITESPACE

See Also:

Constant Field Values

EVENT_PROCESSING_INSTRUCTION

protected static final int EVENT_PROCESSING_INSTRUCTION

See Also:

Constant Field Values

EVENT_SKIPPED_ENTITY

protected static final int EVENT_SKIPPED_ENTITY

See Also:

Constant Field Values

EVENT_START_DTD

protected static final int EVENT_START_DTD

See Also:

Constant Field Values

EVENT_END_DTD

protected static final int EVENT_END_DTD

See Also:

Constant Field Values

EVENT_START_ENTITY

protected static final int EVENT_START_ENTITY

See Also:

Constant Field Values

EVENT_END_ENTITY

protected static final int EVENT_END_ENTITY

See Also:

Constant Field Values

EVENT_START_CDATA

protected static final int EVENT_START_CDATA

See Also:

Constant Field Values

EVENT_END_CDATA

protected static final int EVENT_END_CDATA

See Also:

Constant Field Values

EVENT_COMMENT

protected static final int EVENT_COMMENT

See Also:

Constant Field Values

event

protected int event

nullHandler

protected EffectPipe.Handler nullHandler

bufferHandler

protected EffectPipe.Handler bufferHandler

handlers

protected LinkedList handlers

handler

protected EffectPipe.Handler handler

elements

protected LinkedList elements

input

protected EffectPipe.Element input

locator

protected Locator locator

name

protected String name

publicId

protected String publicId

systemId

protected String systemId

target

protected String target

data

protected String data

prefix

protected String prefix

uri

protected String uri

c

protected char[] c

start

protected int start

len

protected int len

out

public EffectPipe.Output out

Constructor Detail

EffectPipe

public EffectPipe()

Method Detail

init

public void init()

setConsumer

public void setConsumer(XMLConsumer consumer)

Description copied from class: AbstractXMLProducer

Set the XMLConsumer that will receive XML data.
This method will simply call setContentHandler(consumer) and setLexicalHandler(consumer).

Specified by:

setConsumer in interface XMLProducer

Overrides:

setConsumer in class AbstractXMLProducer

setContentHandler

public void setContentHandler(ContentHandler handler)

Description copied from class: AbstractXMLProducer

Set the ContentHandler that will receive XML data.
Subclasses may retrieve this ContentHandler instance accessing the protected super.contentHandler field.

Overrides:

setContentHandler in class AbstractXMLProducer

setLexicalHandler

public void setLexicalHandler(LexicalHandler handler)

Description copied from class: AbstractXMLProducer

Set the LexicalHandler that will receive XML data.
Subclasses may retrieve this LexicalHandler instance accessing the protected super.lexicalHandler field.

Overrides:

setLexicalHandler in class AbstractXMLProducer

recycle

public void recycle()

Description copied from class: AbstractXMLProducer

Recycle the producer by removing references, and resetting handlers to null (empty) implementations.

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractXMLProducer

setDocumentLocator

public void setDocumentLocator(Locator locator)

Description copied from class: AbstractXMLPipe

Receive an object for locating the origin of SAX document events.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class AbstractXMLPipe

Parameters:

locator - An object that can return the location of any SAX document event.

startDocument

public void startDocument()
                   throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the beginning of a document.

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class AbstractXMLPipe

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of the end of a document.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class AbstractXMLPipe

Throws:

SAXException

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

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

startElement

public void startElement(String uri,
                         String loc,
                         String raw,
                         Attributes attrs)
                  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.

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

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

ignorableWhitespace

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

Description copied from class: AbstractXMLPipe

Receive notification of ignorable whitespace in element content.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace 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

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Description copied from class: AbstractXMLPipe

Receive notification of a skipped entity.

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class AbstractXMLPipe

Parameters:

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

Throws:

SAXException

startDTD

public void startDTD(String name,
                     String publicId,
                     String systemId)
              throws SAXException

Description copied from class: AbstractXMLPipe

Report the start of DTD declarations, if any.

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in class AbstractXMLPipe

Parameters:

name - The document type name.

publicId - The declared public identifier for the external DTD subset, or null if none was declared.

systemId - The declared system identifier for the external DTD subset, or null if none was declared.

Throws:

SAXException

endDTD

public void endDTD()
            throws SAXException

Description copied from class: AbstractXMLPipe

Report the end of DTD declarations.

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class AbstractXMLPipe

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[] c,
                    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:

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