Package org.ametys.odf.export.pdf

Class FOProgramsGenerator

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

All Implemented Interfaces:

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

public class FOProgramsGenerator
extends ServiceableGenerator

Generator producing the SAX events for the catalogue summary

Field Summary

Fields

Modifier and Type	Field	Description
protected CatalogsManager	_catalogManager	The catalog manager
protected ContentTypeExtensionPoint	_ctypeEP	The content type extension point
protected ODFHelper	_odfHelper	The ODf helper
protected OdfReferenceTableHelper	_odfTableRefHelper	The ODf enumeration helper
protected QueryHelper	_queryHelper	The query 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
FOProgramsGenerator()

Method Summary

Modifier and Type	Method	Description
protected AmetysObjectIterable<Program>	_getPrograms(String catalog, String lang, String queryId)	Get programs from catalog, lang and a query
protected AmetysObjectIterable<Program>	_getPrograms(String catalog, String lang, List<OrgUnit> orgUnits, List<OdfReferenceTableEntry> degrees)	Get programs from catalog, lang, orgunit and degree.
protected void	_saxAbstractProgram(String tagName, AbstractProgram program, Map<String,ContentAttributeDefinition> tableRefAttributeDefs, boolean includeSubprograms)	SAX a program or subprogram
protected void	_saxPrograms(AmetysObjectIterable<Program> programs, boolean includeSubPrograms)	Sax programs
protected void	_saxTableRefAttributeValues(AbstractProgram program, Map<String,ContentAttributeDefinition> tableRefAttributeDefs)	SAX enumerated values of an attribute
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

_ctypeEP

protected ContentTypeExtensionPoint _ctypeEP

The content type extension point

_odfHelper

protected ODFHelper _odfHelper

The ODf helper

_odfTableRefHelper

protected OdfReferenceTableHelper _odfTableRefHelper

The ODf enumeration helper

_catalogManager

protected CatalogsManager _catalogManager

The catalog manager

_queryHelper

protected QueryHelper _queryHelper

The query helper

Constructor Details

FOProgramsGenerator

public FOProgramsGenerator()

Method Details

service

public void service(ServiceManager sManager)
             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

_getPrograms

protected AmetysObjectIterable<Program> _getPrograms(String catalog,
 String lang,
 List<OrgUnit> orgUnits,
 List<OdfReferenceTableEntry> degrees)

Get programs from catalog, lang, orgunit and degree. Orgunit and degree can be null.

Parameters:

catalog - The catalog

lang - The content language

orgUnits - The restricted orgunits. Can be empty to not filter by orgunits

degrees - The restricted degrees. Can be empty to not filter by degrees

Returns:

An iterable of programs corresponding to the query with catalog, lang, orgunit and degree.

_getPrograms

protected AmetysObjectIterable<Program> _getPrograms(String catalog,
 String lang,
 String queryId)
                                              throws ProcessingException

Get programs from catalog, lang and a query

Parameters:

catalog - The catalog

lang - The content language

queryId - The query id

Returns:

An iterable of programs corresponding to the query. Results are filtered

Throws:

ProcessingException - if failed to execute query

_saxPrograms

protected void _saxPrograms(AmetysObjectIterable<Program> programs,
 boolean includeSubPrograms)
                     throws MalformedURLException,
IOException,
SAXException

Sax programs

Parameters:

programs - the programs to sax

includeSubPrograms - true to include subprograms

Throws:

MalformedURLException - if an error occurred

IOException - if an error occurred

SAXException - if an error occurred

_saxAbstractProgram

protected void _saxAbstractProgram(String tagName,
 AbstractProgram program,
 Map<String,ContentAttributeDefinition> tableRefAttributeDefs,
 boolean includeSubprograms)
                            throws MalformedURLException,
IOException,
SAXException

SAX a program or subprogram

Parameters:

tagName - the XML root tag

program - The abstract program to sax

tableRefAttributeDefs - The table reference attribute definitions

includeSubprograms - true to include subprograms

Throws:

MalformedURLException - if an error occurred

IOException - if an error occurred

SAXException - if an error occurred

_saxTableRefAttributeValues

protected void _saxTableRefAttributeValues(AbstractProgram program,
 Map<String,ContentAttributeDefinition> tableRefAttributeDefs)
                                    throws AmetysRepositoryException,
SAXException,
IOException

SAX enumerated values of an attribute

Parameters:

program - The program

tableRefAttributeDefs - The table reference attribute definitions

Throws:

AmetysRepositoryException - if an error occurred

SAXException - if an error occurred

IOException - if an error occurred