org.apache.cocoon.generation
Class ServerPagesGenerator.CompletionPipe

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.xml.AbstractXMLProducer
              |
              +--org.apache.cocoon.xml.AbstractXMLPipe
                    |
                    +--org.apache.cocoon.generation.ServerPagesGenerator.CompletionPipe

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, XMLConsumer, XMLPipe, XMLProducer

Enclosing class:

ServerPagesGenerator

public class ServerPagesGenerator.CompletionPipe

extends AbstractXMLPipe

Field Summary

protected org.apache.avalon.excalibur.collections.ArrayStack

eventStack The SAX event stack.

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

contentHandler, lexicalHandler, xmlConsumer

Constructor Summary

ServerPagesGenerator.CompletionPipe()

Method Summary

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(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) Receive notification of the end of an element.
void	endEntity(java.lang.String name) Report the end of an entity.
void	endPrefixMapping(java.lang.String prefix) End the scope of a prefix-URI mapping.
void	flushEvents()
void	recycle() Recycle the producer by removing references
void	startCDATA() Report the start of a CDATA section.
void	startDocument() Receive notification of the beginning of a document.
void	startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Report the start of DTD declarations, if any.
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes atts) Receive notification of the beginning of an element.
void	startEntity(java.lang.String name) Report the beginning of an entity.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Begin the scope of a prefix-URI Namespace mapping.

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

characters, comment, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

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

setConsumer, setContentHandler, setLexicalHandler

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

getLogger, setLogger, 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

Field Detail

eventStack

protected org.apache.avalon.excalibur.collections.ArrayStack eventStack

The SAX event stack. Used for "completing" pendind SAX events left "open" by prematurely returning server pages generators

Constructor Detail

ServerPagesGenerator.CompletionPipe

public ServerPagesGenerator.CompletionPipe()

Method Detail

startDocument

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

Receive notification of the beginning of a document.

Overrides:

startDocument in class AbstractXMLPipe

endDocument

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

Receive notification of the end of a document.

Overrides:

endDocument in class AbstractXMLPipe

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Receive notification of the beginning of an element.

Overrides:

startElement in class AbstractXMLPipe

Following copied from class: org.apache.cocoon.xml.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.

endElement

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

Receive notification of the end of an element.

Overrides:

endElement in class AbstractXMLPipe

Following copied from class: org.apache.cocoon.xml.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.

startPrefixMapping

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

Begin the scope of a prefix-URI Namespace mapping.

Overrides:

startPrefixMapping in class AbstractXMLPipe

Following copied from class: org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

endPrefixMapping

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

End the scope of a prefix-URI mapping.

Overrides:

endPrefixMapping in class AbstractXMLPipe

Following copied from class: org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

prefix - The prefix that was being mapping.

startCDATA

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

Description copied from class: AbstractXMLPipe

Report the start of a CDATA section.

Overrides:

startCDATA in class AbstractXMLPipe

endCDATA

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

Description copied from class: AbstractXMLPipe

Report the end of a CDATA section.

Overrides:

endCDATA in class AbstractXMLPipe

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)
              throws org.xml.sax.SAXException

Description copied from class: AbstractXMLPipe

Report the start of DTD declarations, if any.

Overrides:

startDTD in class AbstractXMLPipe

Following copied from class: org.apache.cocoon.xml.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.

endDTD

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

Description copied from class: AbstractXMLPipe

Report the end of DTD declarations.

Overrides:

endDTD in class AbstractXMLPipe

startEntity

public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException

Description copied from class: AbstractXMLPipe

Report the beginning of an entity.

Overrides:

startEntity in class AbstractXMLPipe

Following copied from class: org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

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

endEntity

public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException

Description copied from class: AbstractXMLPipe

Report the end of an entity.

Overrides:

endEntity in class AbstractXMLPipe

Following copied from class: org.apache.cocoon.xml.AbstractXMLPipe

Parameters:

name - The name of the entity that is ending.

flushEvents

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

recycle

public void recycle()

Description copied from class: AbstractXMLProducer

Recycle the producer by removing references

Overrides:

recycle in class AbstractXMLProducer