Package org.ametys.odf.program.generators

Class ProgramContentGenerator

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

org.ametys.odf.program.generators.ODFContentGenerator

org.ametys.odf.program.generators.ProgramContentGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

CourseContentGenerator, OrgUnitContentGenerator, ProgramPdfContentGenerator

public class ProgramContentGenerator
extends ODFContentGenerator
implements Initializable

Generator for rendering raw content data for a Program.

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__CACHE_ID
private Cache<String,SaxBuffer>	_cache
private AbstractCacheManager	_cacheManager
protected ODFHelper	_odfHelper	The ODF helper
protected SourceResolver	_srcResolver	The source resolver

Fields inherited from class org.ametys.odf.program.generators.ODFContentGenerator

_resolver

Fields inherited from class org.ametys.cms.content.ContentGenerator

_contentSaxer, _contentTypeExtensionPoint, _cTypesHelper, _DC_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
ProgramContentGenerator()

Method Summary

Modifier and Type	Method	Description
protected void	_addAttrIfNotEmpty(AttributesImpl attrs, String attrName, String attrValue)	Add an attribute if its not null or empty.
private Set<String>	_getContentIds(ModelAwareDataHolder dataHolder, ModelItemContainer modelItemContainer, String contentType)
protected void	_saxOtherData(Content content, Locale defaultLocale)	SAX any other data needed by the view.
protected Set<String>	getLinkedContents(Content content, String linkedContentType)	Get the linked contents of the defined content type.
void	initialize()
void	recycle()
protected void	saxChildProgramPart(AbstractProgram program, Locale defaultLocale)	SAX the referenced ProgramParts
protected void	saxContainer(Container container, String parentPath, Locale defaultLocale)	SAX a container
protected void	saxContent(Content content, ContentHandler handler, String viewName)	SAX the HTML content of a Content
protected void	saxContent(Content content, ContentHandler handler, String viewName, String format, boolean withContentRoot, boolean ignoreChildren)	SAX a Content to given format
protected void	saxCourse(Course course, String parentPath, Locale defaultLocale)	SAX a course
protected void	saxCourseList(CourseList courseList, String parentPath, Locale defaultLocale)	SAX a course list
protected void	saxCoursePart(CoursePart coursePart, Locale defaultLocale)	SAX a course part
protected void	saxLinkedContents(Content content, String tagName, String linkedContentType, String viewName)	SAX the referenced content types.
protected void	saxOrgUnits(Content content)	SAX the referenced OrgUnits
protected void	saxPersons(Content content)	SAX the referenced Persons
protected void	saxSubProgram(SubProgram subProgram, String parentPath)	SAX a sub program
protected void	saxTranslation(Content content)	SAX the existing translation
void	service(ServiceManager serviceManager)
void	setup(SourceResolver res, Map objModel, String src, Parameters par)

Methods inherited from class org.ametys.odf.program.generators.ODFContentGenerator

saxTranslations

Methods inherited from class org.ametys.cms.content.ContentGenerator

_generateContent, _getView, _saxAttributesComments, _saxContent, _saxOtherData, generate, getDefaultLocale

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

dispose

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

__CACHE_ID

private static final String __CACHE_ID

_srcResolver

protected SourceResolver _srcResolver

The source resolver

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_cacheManager

private AbstractCacheManager _cacheManager

_cache

private Cache<String,SaxBuffer> _cache

Constructor Detail

ProgramContentGenerator

public ProgramContentGenerator()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ODFContentGenerator

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

setup

public void setup(SourceResolver res,
                  Map objModel,
                  String src,
                  Parameters par)
           throws ProcessingException,
                  SAXException,
                  IOException

Specified by:

setup in interface SitemapModelComponent

Overrides:

setup in class AbstractGenerator

Throws:

ProcessingException

SAXException

IOException

recycle

public void recycle()

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractGenerator

_saxOtherData

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

Description copied from class: ContentGenerator

SAX any other data needed by the view.

Default implementation does nothing.

Overrides:

_saxOtherData in class ContentGenerator

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.

saxPersons

protected void saxPersons(Content content)
                   throws SAXException

SAX the referenced Persons

Parameters:

content - The content to analyze

Throws:

SAXException - if an error occurs while saxing

saxOrgUnits

protected void saxOrgUnits(Content content)
                    throws SAXException

SAX the referenced OrgUnits

Parameters:

content - The content to analyze

Throws:

SAXException - if an error occurs while saxing

saxChildProgramPart

protected void saxChildProgramPart(AbstractProgram program,
                                   Locale defaultLocale)
                            throws SAXException,
                                   ProcessingException,
                                   IOException

SAX the referenced ProgramParts

Parameters:

program - The program or subprogram

defaultLocale - The default locale

Throws:

SAXException - if an error occurs while saxing

IOException - if an error occurs

ProcessingException - if an error occurs

saxTranslation

protected void saxTranslation(Content content)
                       throws SAXException

SAX the existing translation

Parameters:

content - The content

Throws:

SAXException - if an error occurs while saxing

saxLinkedContents

protected void saxLinkedContents(Content content,
                                 String tagName,
                                 String linkedContentType,
                                 String viewName)
                          throws SAXException

SAX the referenced content types.

Parameters:

content - The content to analyze

tagName - The root tagName

linkedContentType - The content type to search

viewName - The view to parse the found contents

Throws:

SAXException - if an error occurs while saxing

getLinkedContents

protected Set<String> getLinkedContents(Content content,
                                        String linkedContentType)

Get the linked contents of the defined content type.

Parameters:

content - The content to analyze

linkedContentType - The content type to search

Returns:

A Set of content ids

_getContentIds

private Set<String> _getContentIds(ModelAwareDataHolder dataHolder,
                                   ModelItemContainer modelItemContainer,
                                   String contentType)

saxContainer

protected void saxContainer(Container container,
                            String parentPath,
                            Locale defaultLocale)
                     throws SAXException,
                            ProcessingException,
                            IOException

SAX a container

Parameters:

container - the container to SAX

parentPath - the parent path

defaultLocale - The default locale

Throws:

SAXException - if an error occurs

IOException - if an error occurs

ProcessingException - if an error occurs

saxSubProgram

protected void saxSubProgram(SubProgram subProgram,
                             String parentPath)
                      throws SAXException

SAX a sub program

Parameters:

subProgram - the sub program to SAX

parentPath - the parent path

Throws:

SAXException - if an error occurs

saxCourseList

protected void saxCourseList(CourseList courseList,
                             String parentPath,
                             Locale defaultLocale)
                      throws SAXException,
                             ProcessingException,
                             IOException

SAX a course list

Parameters:

courseList - The course list to SAX

parentPath - the parent path

defaultLocale - The default locale

Throws:

SAXException - if an error occurs

IOException - if an error occurs

ProcessingException - if an error occurs

saxCourse

protected void saxCourse(Course course,
                         String parentPath,
                         Locale defaultLocale)
                  throws SAXException,
                         ProcessingException,
                         IOException

SAX a course

Parameters:

course - the course to SAX

parentPath - the parent path

defaultLocale - The default locale

Throws:

SAXException - if an error occurs

IOException - if an error occurs

ProcessingException - if an error occurs

saxContent

protected void saxContent(Content content,
                          ContentHandler handler,
                          String viewName)
                   throws SAXException,
                          IOException

SAX the HTML content of a Content

Parameters:

content - the content

handler - the ContentHandler to send SAX events to.

viewName - the view name

Throws:

SAXException - If an error occurred saxing the content

IOException - If an error occurred resolving the content

saxContent

protected void saxContent(Content content,
                          ContentHandler handler,
                          String viewName,
                          String format,
                          boolean withContentRoot,
                          boolean ignoreChildren)
                   throws SAXException,
                          IOException

SAX a Content to given format

Parameters:

content - the content

handler - the ContentHandler to send SAX events to.

viewName - the view name

format - the output format

withContentRoot - true to wrap content stream into a root content tag

ignoreChildren - true to not SAX sub contents

Throws:

SAXException - If an error occurred saxing the content

IOException - If an error occurred resolving the content

_addAttrIfNotEmpty

protected void _addAttrIfNotEmpty(AttributesImpl attrs,
                                  String attrName,
                                  String attrValue)

Add an attribute if its not null or empty.

Parameters:

attrs - The attributes

attrName - The attribute name

attrValue - The attribute value

saxCoursePart

protected void saxCoursePart(CoursePart coursePart,
                             Locale defaultLocale)
                      throws SAXException,
                             ProcessingException,
                             IOException

SAX a course part

Parameters:

coursePart - The course part to SAX

defaultLocale - The default locale

Throws:

SAXException - if an error occurs

IOException - if an error occurs

ProcessingException - if an error occurs