Package org.ametys.plugins.glossary

Class DefinitionsGenerator

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.plugins.glossary.DefinitionsGenerator

All Implemented Interfaces:

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

public class DefinitionsGenerator
extends ServiceableGenerator

Generate the list of word definitions as XML.

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected Expression	_getThemeExpression(String siteName, String language, String[] themes)	Get the list of theme expressions to filter the definitions with
void	generate()
protected void	saxDefinition(DefaultDefinition definition)	Generate a word definition.
void	service(ServiceManager serviceManager)
boolean	themeExists(String themeName, String siteName, String language)	Verify the existence of a theme

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

Constructor Details

DefinitionsGenerator

public DefinitionsGenerator()

Method Details

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

_getThemeExpression

protected Expression _getThemeExpression(String siteName,
 String language,
 String[] themes)

Get the list of theme expressions to filter the definitions with

Parameters:

siteName - the site's name

language - the site's language

themes - the array of theme Ids to create expressions

Returns:

a list of ThemeExpression

saxDefinition

protected void saxDefinition(DefaultDefinition definition)
                      throws SAXException

Generate a word definition.

Parameters:

definition - the definition to generate.

Throws:

SAXException - If an error occurs while generating the XML.

themeExists

public boolean themeExists(String themeName,
 String siteName,
 String language)

Verify the existence of a theme

Parameters:

themeName - the id of the theme to verify

siteName - the site's name

language - the site's language

Returns:

true if the theme exists, false otherwise