Package org.ametys.cms.content

Class ContentGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.cms.content.ContentGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

CommentsGenerator, ContentGenerator, ODFContentGenerator

public class ContentGenerator
extends ServiceableGenerator

Generator for rendering raw content data.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentSaxer	_contentSaxer	The content saxer
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	Content type extension point.
protected ContentTypesHelper	_cTypesHelper	Helper for content types
protected static DateFormat	_DC_DATE_FORMAT	The display date format.

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

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

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor	Description
ContentGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	_generateContent()	Generate the content (with the start/end document)
protected View	_getView(Content content, boolean isEdition)	Retrieves the view to be used when SAX'ing attributes and attribute comments.
protected void	_saxAttributesComments(Content content, View view)	SAX content attributes comments.
protected void	_saxContent(Content content, Locale defaultLocale)	SAX the content
protected void	_saxOtherData(Content content)	Deprecated. Use and/or override _saxOtherData(Content, Locale) instead
protected void	_saxOtherData(Content content, Locale defaultLocale)	SAX any other data needed by the view.
void	generate()
protected Locale	getDefaultLocale(Request request)	Get the default locale to use to sax localized values
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

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

setConsumer, setContentHandler, setLexicalHandler

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.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

_DC_DATE_FORMAT

protected static final DateFormat _DC_DATE_FORMAT

The display date format.

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

Content type extension point.

_cTypesHelper

protected ContentTypesHelper _cTypesHelper

Helper for content types

_contentSaxer

protected ContentSaxer _contentSaxer

The content saxer

Constructor Detail

ContentGenerator

public ContentGenerator()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
                     SAXException,
                     ProcessingException

Throws:

IOException

SAXException

ProcessingException

_generateContent

protected void _generateContent()
                         throws SAXException,
                                IOException,
                                ProcessingException

Generate the content (with the start/end document)

Throws:

SAXException - if an error occurs while SAXing

IOException - if an error occurs

ProcessingException - if an error occurs

getDefaultLocale

protected Locale getDefaultLocale(Request request)

Get the default locale to use to sax localized values

Parameters:

request - the request

Returns:

the default locale

_saxContent

protected void _saxContent(Content content,
                           Locale defaultLocale)
                    throws SAXException,
                           IOException,
                           ProcessingException

SAX the content

Parameters:

content - The content to SAX

defaultLocale - The default locale to use to sax localized values if the content's language is null.

Throws:

SAXException - if an error occurs while SAXing

IOException - if an error occurs

ProcessingException - if an error occurs

_saxAttributesComments

protected void _saxAttributesComments(Content content,
                                      View view)
                               throws SAXException

SAX content attributes comments.

Parameters:

content - the content.

view - the view containing the attributes.

Throws:

SAXException - if an error occurs while SAXing.

_saxOtherData

@Deprecated
protected void _saxOtherData(Content content)
                      throws SAXException,
                             ProcessingException

Deprecated.

Use and/or override _saxOtherData(Content, Locale) instead

SAX any other data needed by the view.

Default implementation does nothing.

Parameters:

content - the content.

Throws:

SAXException - if an error occurs while SAXing.

ProcessingException - if an error occurs.

_saxOtherData

protected void _saxOtherData(Content content,
                             Locale defaultLocale)
                      throws SAXException,
                             ProcessingException,
                             IOException

SAX any other data needed by the view.

Default implementation does nothing.

Parameters:

content - the content.

defaultLocale - The default locale

Throws:

SAXException - if an error occurs while SAXing.

ProcessingException - if an error occurs.

IOException - if an error occurs.

_getView

protected View _getView(Content content,
                        boolean isEdition)
                 throws ProcessingException

Retrieves the view to be used when SAX'ing attributes and attribute comments.

Parameters:

content - The content to consider. Cannot be null.

isEdition - true if the view is to use for edition, false otherwise

Returns:

The retrieved view

Throws:

ProcessingException - If the view could not be retrieved