Package org.ametys.odf.content

Class ProgramItemStructureGenerator

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

All Implemented Interfaces:

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

public class ProgramItemStructureGenerator
extends ServiceableGenerator
implements Initializable

SAX the structure (ie. the child program items) of a ProgramItem

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCacheManager	_cacheManager	The cache manager
protected ContentTypesHelper	_cTypesHelper	The content types helper
protected ODFHelper	_odfHelper	The ODF helper
protected OdfReferenceTableHelper	_odfReferenceTableHelper	Helper for ODF reference table
protected ODFSkillsHelper	_odfSkillsHelper	The ODF skills 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
ProgramItemStructureGenerator()

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.
protected List<ProgramItem>	_getInitialAncestorPath(Request request, ProgramItem rootProgramItem)	Get the initial ancestor path from request or from root program item
protected void	_saxCommonAttributes(ProgramItem programItem, List<ProgramItem> ancestorPath, AttributesImpl attrs)	SAX the common attributes for program item
protected void	_saxReferenceTableItem(String itemId, String tagName, String lang)	SAX the item of a reference table
protected void	_saxStructureViewIfExists(Content content)	SAX the 'structure' view if exists
void	generate()
void	initialize()
void	recycle()
protected void	saxChildProgramItems(ProgramItem programItem, List<ProgramItem> ancestorPath)	SAX the child program items
protected void	saxContainer(Container container, List<ProgramItem> ancestorPath)	SAX a container
protected void	saxCourse(Course course, List<ProgramItem> ancestorPath)	SAX a course
protected void	saxCourseList(CourseList cl, List<ProgramItem> ancestorPath)	SAX a course list
protected void	saxCoursePart(CoursePart coursePart)	SAX a course part
protected void	saxCourseParts(Course course)	SAX a course part
protected void	saxProgram(Program program)	SAX a program
protected void	saxProgramItem(ProgramItem programItem, List<ProgramItem> ancestorPath)	SAX a program item with its child program items
protected void	saxSubProgram(SubProgram subProgram, List<ProgramItem> ancestorPath)	SAX a subprogram
void	service(ServiceManager smanager)
void	setup(SourceResolver res, Map objModel, String src, Parameters par)

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 Details

_odfHelper

protected ODFHelper _odfHelper

The ODF helper

_odfReferenceTableHelper

protected OdfReferenceTableHelper _odfReferenceTableHelper

Helper for ODF reference table

_cTypesHelper

protected ContentTypesHelper _cTypesHelper

The content types helper

_odfSkillsHelper

protected ODFSkillsHelper _odfSkillsHelper

The ODF skills helper

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_cacheManager

protected AbstractCacheManager _cacheManager

The cache manager

Constructor Details

ProgramItemStructureGenerator

public ProgramItemStructureGenerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

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

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

generate

public void generate()
              throws IOException,
SAXException,
ProcessingException

Specified by:

generate in interface Generator

Throws:

IOException

SAXException

ProcessingException

_getInitialAncestorPath

protected List<ProgramItem> _getInitialAncestorPath(Request request,
 ProgramItem rootProgramItem)

Get the initial ancestor path from request or from root program item

Parameters:

request - the request

rootProgramItem - the root program item in saxed structure

Returns:

the initial ancestor path as a list of program items

saxProgramItem

protected void saxProgramItem(ProgramItem programItem,
 List<ProgramItem> ancestorPath)
                       throws SAXException

SAX a program item with its child program items

Parameters:

programItem - the program item

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

Throws:

SAXException - if an error occurs while saxing

saxChildProgramItems

protected void saxChildProgramItems(ProgramItem programItem,
 List<ProgramItem> ancestorPath)
                             throws SAXException

SAX the child program items

Parameters:

programItem - the program item

ancestorPath - The path of parent program item in the structure (starting from the initial saxed program item)

Throws:

SAXException - if an error occurs while saxing

saxProgram

protected void saxProgram(Program program)
                   throws SAXException

SAX a program

Parameters:

program - the subprogram to SAX

Throws:

SAXException - if an error occurs

saxSubProgram

protected void saxSubProgram(SubProgram subProgram,
 List<ProgramItem> ancestorPath)
                      throws SAXException

SAX a subprogram

Parameters:

subProgram - the subprogram to SAX

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

Throws:

SAXException - if an error occurs

saxContainer

protected void saxContainer(Container container,
 List<ProgramItem> ancestorPath)
                     throws SAXException

SAX a container

Parameters:

container - the container to SAX

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

Throws:

SAXException - if an error occurs while saxing

saxCourseList

protected void saxCourseList(CourseList cl,
 List<ProgramItem> ancestorPath)
                      throws SAXException

SAX a course list

Parameters:

cl - the course list to SAX

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

Throws:

SAXException - if an error occurs while saxing

saxCourse

protected void saxCourse(Course course,
 List<ProgramItem> ancestorPath)
                  throws SAXException

SAX a course

Parameters:

course - the container to SAX

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

Throws:

SAXException - if an error occurs while saxing

saxCourseParts

protected void saxCourseParts(Course course)
                       throws SAXException

SAX a course part

Parameters:

course - The course

Throws:

SAXException - if an error occurs

saxCoursePart

protected void saxCoursePart(CoursePart coursePart)
                      throws SAXException

SAX a course part

Parameters:

coursePart - The course part to SAX

Throws:

SAXException - if an error occurs

_saxStructureViewIfExists

protected void _saxStructureViewIfExists(Content content)
                                  throws SAXException

SAX the 'structure' view if exists

Parameters:

content - the content

Throws:

SAXException - if an error occurs

_saxCommonAttributes

protected void _saxCommonAttributes(ProgramItem programItem,
 List<ProgramItem> ancestorPath,
 AttributesImpl attrs)

SAX the common attributes for program item

Parameters:

programItem - the program item

ancestorPath - The path of this program item in the structure (starting from the initial saxed program item)

attrs - the attributes

_saxReferenceTableItem

protected void _saxReferenceTableItem(String itemId,
 String tagName,
 String lang)
                               throws SAXException

SAX the item of a reference table

Parameters:

itemId - the item id

tagName - the tag name

lang - the language to use

Throws:

SAXException - if an error occurs while saxing

_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