org.apache.cocoon.serialization
Class FOPSerializer

java.lang.Object
  org.apache.cocoon.util.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.serialization.AbstractSerializer
                  org.apache.cocoon.serialization.FOPSerializer

All Implemented Interfaces:

org.apache.cocoon.caching.CacheableProcessingComponent, Configurable, ContentHandler, LexicalHandler, Poolable, Recyclable, org.apache.cocoon.serialization.Serializer, Serviceable, org.apache.cocoon.sitemap.SitemapOutputComponent, XMLConsumer, org.apache.cocoon.xml.XMLConsumer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer

public class FOPSerializer

extends org.apache.cocoon.serialization.AbstractSerializer

implements Configurable, org.apache.cocoon.caching.CacheableProcessingComponent, Serviceable

FOP 0.20.5 (and older) based serializer.

Version:

$Id: FOPSerializer.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary

protected org.apache.fop.apps.Driver	driver The Driver which is FOP.
protected static RendererFactory	factory The Renderer Factory to use
protected Logger	logger This Avalon logger is created for FOP
protected ServiceManager	manager Manager to get URLFactory from.
protected String	mimetype The current mime-type.
protected org.apache.fop.render.Renderer	renderer The current Renderer.
protected String	rendererName The renderer name if configured
protected boolean	setContentLength Should we set the content length ?

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

FOPSerializer()

Method Summary

void	configure(Configuration conf) Set the configurations for this serializer.
Serializable	getKey() Generate the unique key.
String	getMimeType() Return the MIME type.
SourceValidity	getValidity() Generate the validity object.
void	recycle() Recycle serializer by removing references
void	service(ServiceManager manager) Set the component manager for this serializer.
void	setOutputStream(OutputStream out) Create the FOP driver Set the OutputStream where the XML should be serialized.
boolean	shouldSetContentLength() Test if the component wants to set the content length

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

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

setConsumer

Field Detail

factory

protected static final RendererFactory factory

The Renderer Factory to use

driver

protected org.apache.fop.apps.Driver driver

The Driver which is FOP.

renderer

protected org.apache.fop.render.Renderer renderer

The current Renderer.

mimetype

protected String mimetype

The current mime-type.

rendererName

protected String rendererName

The renderer name if configured

setContentLength

protected boolean setContentLength

Should we set the content length ?

logger

protected Logger logger

This Avalon logger is created for FOP

manager

protected ServiceManager manager

Manager to get URLFactory from.

Constructor Detail

FOPSerializer

public FOPSerializer()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Set the component manager for this serializer.

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration conf)
               throws ConfigurationException

Set the configurations for this serializer.

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getMimeType

public String getMimeType()

Return the MIME type.

Specified by:

getMimeType in interface org.apache.cocoon.sitemap.SitemapOutputComponent

setOutputStream

public void setOutputStream(OutputStream out)

Create the FOP driver Set the OutputStream where the XML should be serialized.

Specified by:

setOutputStream in interface org.apache.cocoon.sitemap.SitemapOutputComponent

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 org.apache.cocoon.caching.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 org.apache.cocoon.caching.CacheableProcessingComponent

Returns:

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

recycle

public void recycle()

Recycle serializer by removing references

Specified by:

recycle in interface Recyclable

shouldSetContentLength

public boolean shouldSetContentLength()

Test if the component wants to set the content length

Specified by:

shouldSetContentLength in interface org.apache.cocoon.sitemap.SitemapOutputComponent