org.apache.cocoon.sitemap.impl
Class AbstractVirtualSitemapComponent

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.sitemap.impl.AbstractVirtualSitemapComponent

All Implemented Interfaces:

Configurable, ContentHandler, Contextualizable, LexicalHandler, LogEnabled, Poolable, Recyclable, Serviceable, SitemapModelComponent, XMLConsumer, XMLConsumer, XMLPipe, XMLProducer

Direct Known Subclasses:

VirtualPipelineGenerator, VirtualPipelineReader, VirtualPipelineSerializer, VirtualPipelineTransformer

public abstract class AbstractVirtualSitemapComponent

extends AbstractXMLPipe

implements SitemapModelComponent, Serviceable, Contextualizable, Configurable

TODO List:

• Refactor ProcessingPipelines implementations
• Implement caching

Field Summary

protected DefaultContext	context
protected ServiceManager	manager
protected SourceResolver	resolver

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Constructor Summary

AbstractVirtualSitemapComponent()

Method Summary

void	configure(Configuration configuration)
void	contextualize(Context context)
protected EnvironmentWrapper	getMappedSourceEnvironment()
protected VirtualProcessingPipeline	getPipeline()
protected abstract String	getTypeName()
protected EnvironmentWrapper	getVPCEnvironment()
void	recycle() Release all resources.
void	service(ServiceManager manager)
void	setup(SourceResolver resolver, Map objectModel, String src, Parameters par) The Sitemap will call the setup() method to prepare the component for use.

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping

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

context

protected DefaultContext context

resolver

protected SourceResolver resolver

manager

protected ServiceManager manager

Constructor Detail

AbstractVirtualSitemapComponent

public AbstractVirtualSitemapComponent()

Method Detail

getTypeName

protected abstract String getTypeName()

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

See Also:

Contextualizable.contextualize(org.apache.avalon.framework.context.Context)

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

See Also:

Serviceable.service(org.apache.avalon.framework.service.ServiceManager)

recycle

public void recycle()

Release all resources.

Specified by:

recycle in interface Recyclable

Overrides:

recycle in class AbstractXMLProducer

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

See Also:

Configurable.configure(org.apache.avalon.framework.configuration.Configuration)

setup

public void setup(SourceResolver resolver,
                  Map objectModel,
                  String src,
                  Parameters par)
           throws ProcessingException,
                  SAXException,
                  IOException

Description copied from interface: SitemapModelComponent

The Sitemap will call the setup() method to prepare the component for use. This is where you start the process of getting your information ready to generate your results. See ObjectModelHelper for help with the objectModel.

Specified by:

setup in interface SitemapModelComponent

Parameters:

resolver - The SourceResolver to find resources within your context.

objectModel - A java.util.Map that contains the request and session information.

src - The value of the "src" attribute in the sitemap.

par - The sitemap parameters passed into your component.

Throws:

ProcessingException - if there is any other unexpected problem.

IOException - if there is a problem reading files.

SAXException - if there is a problem reading a SAX stream.

See Also:

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

getPipeline

protected VirtualProcessingPipeline getPipeline()

getMappedSourceEnvironment

protected EnvironmentWrapper getMappedSourceEnvironment()

getVPCEnvironment

protected EnvironmentWrapper getVPCEnvironment()