This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.cocoon.generation
Class SiteTreeGenerator

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.apache.lenya.cms.cocoon.generation.SiteTreeGenerator

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.component.Component, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.parameters.Parameterizable, org.apache.avalon.framework.service.Serviceable, org.apache.cocoon.caching.CacheableProcessingComponent, org.apache.cocoon.generation.Generator, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.xml.XMLProducer

public class SiteTreeGenerator
extends org.apache.cocoon.generation.ServiceableGenerator
implements org.apache.avalon.framework.parameters.Parameterizable, org.apache.cocoon.caching.CacheableProcessingComponent

Site tree generator.

Version:

$Id:$

Field Summary

static java.lang.String	AREA_PARAMETER The area of the site tree.
protected static java.lang.String	ATTR_ATTRIBUTE
protected static java.lang.String	CDATA
protected static java.lang.String	HREF_ATTRIBUTE
protected static java.lang.String	I18N_NS
protected static java.lang.String	I18N_PX
protected static java.lang.String	ID_ATTRIBUTE
protected static java.lang.String	LABEL_ATTRIBUTE
protected static java.lang.String	LABEL_ELEMENT
protected static java.lang.String	LANG_ATTRIBUTE
protected static java.lang.String	LINK_ATTRIBUTE
protected static java.lang.String	NODE_ELEMENT
protected static java.lang.String	Q_ATTR_ATTRIBUTE
protected static java.lang.String	Q_LANG_ATTRIBUTE
protected static java.lang.String	SITE_ELEMENT
protected static java.lang.String	SUFFIX_ATTRIBUTE
protected static java.lang.String	VISIBLEINNAV_ATTRIBUTE

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

SiteTreeGenerator()

Method Summary

void	generate()
java.io.Serializable	getKey()
org.apache.excalibur.source.SourceValidity	getValidity()
void	parameterize(org.apache.avalon.framework.parameters.Parameters parameters) No parameters implemented.
void	recycle() Recycle the generator
void	setup(org.apache.cocoon.environment.SourceResolver resolver, java.util.Map objectModel, java.lang.String src, org.apache.avalon.framework.parameters.Parameters par)

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose, service

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

I18N_PX

protected static final java.lang.String I18N_PX

See Also:

Constant Field Values

I18N_NS

protected static final java.lang.String I18N_NS

See Also:

Constant Field Values

CDATA

protected static final java.lang.String CDATA

See Also:

Constant Field Values

SITE_ELEMENT

protected static final java.lang.String SITE_ELEMENT

See Also:

Constant Field Values

NODE_ELEMENT

protected static final java.lang.String NODE_ELEMENT

See Also:

Constant Field Values

LABEL_ELEMENT

protected static final java.lang.String LABEL_ELEMENT

See Also:

Constant Field Values

LABEL_ATTRIBUTE

protected static final java.lang.String LABEL_ATTRIBUTE

See Also:

Constant Field Values

ATTR_ATTRIBUTE

protected static final java.lang.String ATTR_ATTRIBUTE

See Also:

Constant Field Values

Q_ATTR_ATTRIBUTE

protected static final java.lang.String Q_ATTR_ATTRIBUTE

See Also:

Constant Field Values

ID_ATTRIBUTE

protected static final java.lang.String ID_ATTRIBUTE

See Also:

Constant Field Values

LANG_ATTRIBUTE

protected static final java.lang.String LANG_ATTRIBUTE

See Also:

Constant Field Values

HREF_ATTRIBUTE

protected static final java.lang.String HREF_ATTRIBUTE

See Also:

Constant Field Values

LINK_ATTRIBUTE

protected static final java.lang.String LINK_ATTRIBUTE

See Also:

Constant Field Values

VISIBLEINNAV_ATTRIBUTE

protected static final java.lang.String VISIBLEINNAV_ATTRIBUTE

See Also:

Constant Field Values

SUFFIX_ATTRIBUTE

protected static final java.lang.String SUFFIX_ATTRIBUTE

See Also:

Constant Field Values

Q_LANG_ATTRIBUTE

protected static final java.lang.String Q_LANG_ATTRIBUTE

See Also:

Constant Field Values

AREA_PARAMETER

public static final java.lang.String AREA_PARAMETER

The area of the site tree.

See Also:

Constant Field Values

Constructor Detail

SiteTreeGenerator

public SiteTreeGenerator()

Method Detail

parameterize

public void parameterize(org.apache.avalon.framework.parameters.Parameters parameters)
                  throws org.apache.avalon.framework.parameters.ParameterException

No parameters implemented.

Specified by:

parameterize in interface org.apache.avalon.framework.parameters.Parameterizable

Throws:

org.apache.avalon.framework.parameters.ParameterException

See Also:

Parameterizable.parameterize(org.apache.avalon.framework.parameters.Parameters)

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
                  java.util.Map objectModel,
                  java.lang.String src,
                  org.apache.avalon.framework.parameters.Parameters par)
           throws org.apache.cocoon.ProcessingException,
                  org.xml.sax.SAXException,
                  java.io.IOException

Specified by:

setup in interface org.apache.cocoon.sitemap.SitemapModelComponent

Overrides:

setup in class org.apache.cocoon.generation.AbstractGenerator

Throws:

org.apache.cocoon.ProcessingException

org.xml.sax.SAXException

java.io.IOException

See Also:

SitemapModelComponent.setup(org.apache.cocoon.environment.SourceResolver, java.util.Map, java.lang.String, org.apache.avalon.framework.parameters.Parameters)

generate

public void generate()
              throws org.xml.sax.SAXException

Specified by:

generate in interface org.apache.cocoon.generation.Generator

Throws:

org.xml.sax.SAXException

See Also:

Generator.generate()

recycle

public void recycle()

Recycle the generator

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

Overrides:

recycle in class org.apache.cocoon.generation.AbstractGenerator

getKey

public java.io.Serializable getKey()

Specified by:

getKey in interface org.apache.cocoon.caching.CacheableProcessingComponent

See Also:

CacheableProcessingComponent.getKey()

getValidity

public org.apache.excalibur.source.SourceValidity getValidity()

Specified by:

getValidity in interface org.apache.cocoon.caching.CacheableProcessingComponent

See Also:

CacheableProcessingComponent.getValidity()