Package org.ametys.odf.oai

Class ListIdentifiersGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.ametys.odf.oai.AbstractOAIResponseGenerator

org.ametys.odf.oai.AbstractOAIVerbGenerator

org.ametys.odf.oai.ListIdentifiersGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

ListRecordsGenerator

public class ListIdentifiersGenerator
extends AbstractOAIVerbGenerator
implements Serviceable

Generator for the ListIdentifiers verb.

Field Summary

Fields

Modifier and Type	Field	Description
private CatalogsManager	_catalogsManager
private OaiSetExtensionPoint	_oaiSetEP	The OAI-PMH Sets Extension Point
private ODFHelper	_odfHelper

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

Method Summary

Modifier and Type	Method	Description
protected void	generateVerb()	Generates SAX events for the current verb.
protected Collection<String>	getAllowedParameters()	Returns a Collection af all possible parameters.
protected Collection<String>	getRequiredParameters()	Returns a Collection af all mandatory parameters.
protected String	getTagName()	Returns the surrounding tag name.
protected void	saxProgram(Program program)	Generate the program information.
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.odf.oai.AbstractOAIVerbGenerator

doGenerate

Methods inherited from class org.ametys.odf.oai.AbstractOAIResponseGenerator

generate, generateError, getURL

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 Detail

_oaiSetEP

private OaiSetExtensionPoint _oaiSetEP

The OAI-PMH Sets Extension Point

_catalogsManager

private CatalogsManager _catalogsManager

_odfHelper

private ODFHelper _odfHelper

Constructor Detail

ListIdentifiersGenerator

public ListIdentifiersGenerator()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getRequiredParameters

protected Collection<String> getRequiredParameters()

Description copied from class: AbstractOAIVerbGenerator

Returns a Collection af all mandatory parameters.

Specified by:

getRequiredParameters in class AbstractOAIVerbGenerator

Returns:

a Collection af all mandatory parameters.

getAllowedParameters

protected Collection<String> getAllowedParameters()

Description copied from class: AbstractOAIVerbGenerator

Returns a Collection af all possible parameters.

Specified by:

getAllowedParameters in class AbstractOAIVerbGenerator

Returns:

a Collection af all possible parameters.

generateVerb

protected void generateVerb()
                     throws IOException,
                            SAXException,
                            ProcessingException

Description copied from class: AbstractOAIVerbGenerator

Generates SAX events for the current verb.

Specified by:

generateVerb in class AbstractOAIVerbGenerator

Throws:

IOException - if an I/O error occurs

SAXException - if an error occurs

ProcessingException - if an error occurs

getTagName

protected String getTagName()

Returns the surrounding tag name.

Returns:

the surrounding tag name.

saxProgram

protected void saxProgram(Program program)
                   throws SAXException

Generate the program information.

Parameters:

program - the program

Throws:

SAXException - if an error occurs