Package org.ametys.odf.export.pdf

Class EducationalBookletGenerator

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.odf.export.pdf.EducationalBookletGenerator

All Implemented Interfaces:

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

public class EducationalBookletGenerator
extends ServiceableGenerator
implements Contextualizable

Generator producing the SAX of subprogram and its courses for the educational booklet

Field Summary

Fields

Modifier and Type	Field	Description
protected CatalogsManager	_catalogManager	The catalog manager
protected Context	_context	The avalon context
protected ODFHelper	_odfHelper	The ODF helper
protected AmetysObjectResolver	_resolver	The Ametys object resolver

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
EducationalBookletGenerator()

Method Summary

Modifier and Type	Method	Description
protected Set<Course>	_getChildCourses(ProgramItem programItem)	Get all child courses from the program item
protected Set<SubProgram>	_getChildSubPrograms(ProgramItem programItem)	Get the direct child SubPrograms of a ProgramItem
protected void	_saxCatalog(ProgramItem programItem)	Sax the catalog of program item
protected void	_saxContentAsFo(Content content, List<ProgramItem> ancestorPath, ProgramItem rootAncestor)	Sax content as fo
protected void	_saxProgramItem(ProgramItem programItem, String tagName, List<ProgramItem> ancestorPath, ProgramItem rootProgramItem)	Sax a ProgramItem as fo
void	contextualize(Context context)
void	generate()
void	service(ServiceManager sManager)

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 Details

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_catalogManager

protected CatalogsManager _catalogManager

The catalog manager

_context

protected Context _context

The avalon context

Constructor Details

EducationalBookletGenerator

public EducationalBookletGenerator()

Method Details

service

public void service(ServiceManager sManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

generate

public void generate()
              throws IOException,
SAXException,
ProcessingException

Specified by:

generate in interface Generator

Throws:

IOException

SAXException

ProcessingException

_saxCatalog

protected void _saxCatalog(ProgramItem programItem)
                    throws SAXException

Sax the catalog of program item

Parameters:

programItem - the program item

Throws:

SAXException - if an error occurred

_getChildCourses

protected Set<Course> _getChildCourses(ProgramItem programItem)
                                throws MalformedURLException,
IOException,
SAXException

Get all child courses from the program item

Parameters:

programItem - the program item

Returns:

the set of child courses

Throws:

MalformedURLException - if an error occurred

IOException - if an error occurred

SAXException - if an error occurred

_getChildSubPrograms

protected Set<SubProgram> _getChildSubPrograms(ProgramItem programItem)

Get the direct child SubPrograms of a ProgramItem

Parameters:

programItem - the program item

Returns:

the subprograms

_saxProgramItem

protected void _saxProgramItem(ProgramItem programItem,
 String tagName,
 List<ProgramItem> ancestorPath,
 ProgramItem rootProgramItem)
                        throws MalformedURLException,
IOException,
SAXException

Sax a ProgramItem as fo

Parameters:

programItem - the program item

tagName - the xml tag name

ancestorPath - The path of this program item (computed from the initial program item). Can be a partial path.

rootProgramItem - The root program item ancestor for this booklet

Throws:

MalformedURLException - if an error occurred

IOException - if an error occurred

SAXException - if an error occurred

_saxContentAsFo

protected void _saxContentAsFo(Content content,
 List<ProgramItem> ancestorPath,
 ProgramItem rootAncestor)
                        throws MalformedURLException,
IOException,
SAXException

Sax content as fo

Parameters:

content - the content

ancestorPath - The path of this program item (computed from the initial program item). Can be a partial path.

rootAncestor - The root program item ancestor for this booklet

Throws:

MalformedURLException - if an error occurred

IOException - if an error occurred

SAXException - if an error occurred