org.apache.cocoon.serialization
Class AbstractTextSerializer

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.cocoon.xml.AbstractXMLProducer
          extended by org.apache.cocoon.xml.AbstractXMLPipe
              extended by org.apache.cocoon.serialization.AbstractSerializer
                  extended by org.apache.cocoon.serialization.AbstractTextSerializer
All Implemented Interfaces:
Poolable, Recyclable, Component, Configurable, Contextualizable, LogEnabled, CacheableProcessingComponent, Serializer, SitemapOutputComponent, XMLPipe, XMLProducer, XMLConsumer, ContentHandler, LexicalHandler
Direct Known Subclasses:
HTMLSerializer, RTFSerializer, TextSerializer, XMLSerializer

public abstract class AbstractTextSerializer
extends AbstractSerializer
implements Configurable, CacheableProcessingComponent, Contextualizable

Version:
$Id: AbstractTextSerializer.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Pierpaolo Fumagalli (Apache Software Foundation), Stefano Mazzocchi, Sylvain Wallez

Nested Class Summary
static class AbstractTextSerializer.NamespaceAsAttributes
          A pipe that ensures that all namespace prefixes are also present as 'xmlns:' attributes.
 
Field Summary
protected  Properties format
          The Properties used by this serializer.
 
Fields inherited from class org.apache.cocoon.serialization.AbstractSerializer
output
 
Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer
contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer
 
Fields inherited from interface org.apache.cocoon.serialization.Serializer
ROLE
 
Constructor Summary
AbstractTextSerializer()
           
 
Method Summary
 void configure(Configuration conf)
          Set the configurations for this serializer.
 void contextualize(Context context)
          Uses the context to retrieve a default encoding for the serializers.
 Serializable getKey()
          Generate the unique key.
protected  SAXTransformerFactory getTransformerFactory()
          Helper for TransformerFactory.
protected  TransformerHandler getTransformerHandler()
          Helper for TransformerHandler.
 SourceValidity getValidity()
          Generate the validity object.
protected  boolean needsNamespacesAsAttributes()
          Checks if the used Trax implementation correctly handles namespaces set using startPrefixMapping(), but wants them also as 'xmlns:' attributes.
 void recycle()
          Recycle serializer by removing references
 void setConsumer(XMLConsumer consumer)
          Interpose namespace pipe if needed.
 void setContentHandler(ContentHandler handler)
          Interpose namespace pipe if needed.
 void setLexicalHandler(LexicalHandler handler)
          Interpose namespace pipe if needed.
 
Methods inherited from class org.apache.cocoon.serialization.AbstractSerializer
getMimeType, setOutputStream, shouldSetContentLength
 
Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe
characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping
 
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
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping
 
Methods inherited from interface org.xml.sax.ext.LexicalHandler
comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity
 

Field Detail

format

protected final Properties format
The Properties used by this serializer.

Constructor Detail

AbstractTextSerializer

public AbstractTextSerializer()
Method Detail

setConsumer

public void setConsumer(XMLConsumer consumer)
Interpose namespace pipe if needed.

Specified by:
setConsumer in interface XMLProducer
Overrides:
setConsumer in class AbstractXMLProducer

setContentHandler

public void setContentHandler(ContentHandler handler)
Interpose namespace pipe if needed.

Overrides:
setContentHandler in class AbstractXMLProducer

setLexicalHandler

public void setLexicalHandler(LexicalHandler handler)
Interpose namespace pipe if needed.

Overrides:
setLexicalHandler in class AbstractXMLProducer

getTransformerFactory

protected SAXTransformerFactory getTransformerFactory()
Helper for TransformerFactory.


getTransformerHandler

protected TransformerHandler getTransformerHandler()
                                            throws TransformerException
Helper for TransformerHandler.

Throws:
TransformerException

contextualize

public void contextualize(Context context)
                   throws ContextException
Uses the context to retrieve a default encoding for the serializers.

Specified by:
contextualize in interface Contextualizable
Throws:
ContextException

configure

public void configure(Configuration conf)
               throws ConfigurationException
Set the configurations for this serializer.

Specified by:
configure in interface Configurable
Throws:
ConfigurationException

recycle

public void recycle()
Description copied from class: AbstractSerializer
Recycle serializer by removing references

Specified by:
recycle in interface Recyclable
Overrides:
recycle in class AbstractSerializer
See Also:
Recyclable.recycle()

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.

needsNamespacesAsAttributes

protected boolean needsNamespacesAsAttributes()
                                       throws Exception
Checks if the used Trax implementation correctly handles namespaces set using startPrefixMapping(), but wants them also as 'xmlns:' attributes.

The check consists in sending SAX events representing a minimal namespaced document with namespaces defined only with calls to startPrefixMapping (no xmlns:xxx attributes) and check if they are present in the resulting text.

Throws:
Exception


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