org.apache.cocoon.forms.transformation
Class EffectPipe

java.lang.Object
  extended by org.apache.cocoon.util.AbstractLogEnabled
      extended by org.apache.cocoon.xml.AbstractXMLProducer
          extended by org.apache.cocoon.xml.AbstractXMLPipe
              extended by org.apache.cocoon.forms.transformation.EffectPipe
All Implemented Interfaces:
Poolable, Recyclable, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, XMLConsumer, ContentHandler, LexicalHandler
Direct Known Subclasses:
EffectWidgetReplacingPipe

public class EffectPipe
extends org.apache.cocoon.xml.AbstractXMLPipe

Base class for XMLPipe's. Allows the structure of the source code of the XMLPipe to match the structure of the data being transformed.

Version:
$Id: EffectPipe.java 454815 2006-10-10 16:36:12Z vgritsenko $

Nested Class Summary
protected  class EffectPipe.BufferHandler
          Buffers content into the pipe's SAX buffer.
protected  class EffectPipe.CopyHandler
          Copies events over into the contentHandler
protected  class EffectPipe.ErrorHandler
          Throws exception on most events, with the exception of ignorableWhitespace.
protected static interface EffectPipe.Handler
          Handler interface.
protected  class EffectPipe.NullHandler
          Ignores all events
 
Field Summary
protected  org.apache.cocoon.xml.SaxBuffer buffer
           
protected  EffectPipe.Handler hBuffer
           
protected  EffectPipe.Handler hNull
           
protected  Locator locator
           
 
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer
contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer
 
Constructor Summary
EffectPipe()
           
 
Method Summary
protected  void beginBuffer()
           
 void characters(char[] ch, int start, int len)
           
 void comment(char[] ch, int start, int len)
           
protected  org.apache.cocoon.xml.SaxBuffer endBuffer()
           
 void endCDATA()
           
 void endDocument()
           
 void endDTD()
           
 void endElement(String uri, String loc, String raw)
           
 void endEntity(String name)
           
 void endPrefixMapping(String prefix)
           
protected  String getLocation()
           
 void ignorableWhitespace(char[] ch, int start, int len)
           
protected  void init(EffectPipe.Handler top)
          Initialize the pipe before starting processing
protected  void popHandler()
           
 void processingInstruction(String target, String data)
           
protected  void pushHandler(EffectPipe.Handler handler)
           
 void recycle()
          Recycle the pipe after processing
 void setDocumentLocator(Locator locator)
           
 void skippedEntity(String name)
           
 void startCDATA()
           
 void startDocument()
           
 void startDTD(String name, String publicId, String systemId)
           
 void startElement(String uri, String loc, String raw, Attributes attrs)
           
 void startEntity(String name)
           
 void startPrefixMapping(String prefix, String uri)
           
 
Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer
setConsumer, setContentHandler, setLexicalHandler
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
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
 

Field Detail

hNull

protected final EffectPipe.Handler hNull

hBuffer

protected final EffectPipe.Handler hBuffer

locator

protected Locator locator

buffer

protected org.apache.cocoon.xml.SaxBuffer buffer
Constructor Detail

EffectPipe

public EffectPipe()
Method Detail

init

protected void init(EffectPipe.Handler top)
Initialize the pipe before starting processing


recycle

public void recycle()
Recycle the pipe after processing

Specified by:
recycle in interface Recyclable
Overrides:
recycle in class org.apache.cocoon.xml.AbstractXMLProducer

getLocation

protected String getLocation()
Returns:
current location (if known)

pushHandler

protected void pushHandler(EffectPipe.Handler handler)

popHandler

protected void popHandler()

beginBuffer

protected void beginBuffer()

endBuffer

protected org.apache.cocoon.xml.SaxBuffer endBuffer()

setDocumentLocator

public void setDocumentLocator(Locator locator)
Specified by:
setDocumentLocator in interface ContentHandler
Overrides:
setDocumentLocator in class org.apache.cocoon.xml.AbstractXMLPipe

startDocument

public void startDocument()
                   throws SAXException
Specified by:
startDocument in interface ContentHandler
Overrides:
startDocument in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

endDocument

public void endDocument()
                 throws SAXException
Specified by:
endDocument in interface ContentHandler
Overrides:
endDocument in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException
Specified by:
startPrefixMapping in interface ContentHandler
Overrides:
startPrefixMapping in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException
Specified by:
endPrefixMapping in interface ContentHandler
Overrides:
endPrefixMapping in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

startElement

public void startElement(String uri,
                         String loc,
                         String raw,
                         Attributes attrs)
                  throws SAXException
Specified by:
startElement in interface ContentHandler
Overrides:
startElement in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

endElement

public void endElement(String uri,
                       String loc,
                       String raw)
                throws SAXException
Specified by:
endElement in interface ContentHandler
Overrides:
endElement in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

characters

public void characters(char[] ch,
                       int start,
                       int len)
                throws SAXException
Specified by:
characters in interface ContentHandler
Overrides:
characters in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int len)
                         throws SAXException
Specified by:
ignorableWhitespace in interface ContentHandler
Overrides:
ignorableWhitespace in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException
Specified by:
processingInstruction in interface ContentHandler
Overrides:
processingInstruction in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

skippedEntity

public void skippedEntity(String name)
                   throws SAXException
Specified by:
skippedEntity in interface ContentHandler
Overrides:
skippedEntity in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

startDTD

public void startDTD(String name,
                     String publicId,
                     String systemId)
              throws SAXException
Specified by:
startDTD in interface LexicalHandler
Overrides:
startDTD in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

endDTD

public void endDTD()
            throws SAXException
Specified by:
endDTD in interface LexicalHandler
Overrides:
endDTD in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

startEntity

public void startEntity(String name)
                 throws SAXException
Specified by:
startEntity in interface LexicalHandler
Overrides:
startEntity in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

endEntity

public void endEntity(String name)
               throws SAXException
Specified by:
endEntity in interface LexicalHandler
Overrides:
endEntity in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

startCDATA

public void startCDATA()
                throws SAXException
Specified by:
startCDATA in interface LexicalHandler
Overrides:
startCDATA in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

endCDATA

public void endCDATA()
              throws SAXException
Specified by:
endCDATA in interface LexicalHandler
Overrides:
endCDATA in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException

comment

public void comment(char[] ch,
                    int start,
                    int len)
             throws SAXException
Specified by:
comment in interface LexicalHandler
Overrides:
comment in class org.apache.cocoon.xml.AbstractXMLPipe
Throws:
SAXException


Copyright © 1999-2008 The Apache Software Foundation. All Rights Reserved.