org.apache.cocoon.sitemap
Class Handler

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.sitemap.Handler
All Implemented Interfaces:
org.apache.avalon.framework.component.Composable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.logger.Loggable, Processor, java.lang.Runnable, SourceResolver

public class Handler
extends org.apache.avalon.framework.logger.AbstractLoggable
implements java.lang.Runnable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.component.Composable, Processor, org.apache.avalon.framework.activity.Disposable, SourceResolver

Handles the manageing and stating of one Sitemap

Version:
CVS $Revision: 1.9.2.17 $ $Date: 2001/10/25 20:36:24 $
Author:
Carsten Ziegeler, Giacomo Pati, Stefano Mazzocchi

Fields inherited from interface org.apache.cocoon.Processor
ROLE
 
Constructor Summary
protected Handler(java.lang.String sourceFileName, boolean check_reload)
           
 
Method Summary
protected  boolean available()
           
 void compose(org.apache.avalon.framework.component.ComponentManager manager)
          Composable
 void contextualize(org.apache.avalon.framework.context.Context context)
          Contextualizable
 void dispose()
          dispose
 java.lang.Exception getException()
           
protected  boolean hasChanged()
           
protected  boolean isRegenerating()
           
 boolean process(Environment environment)
          Process the given Environment producing the output.
 boolean process(Environment environment, StreamPipeline pipeline, EventPipeline eventPipeline)
          Process the given Environment to assemble a StreamPipeline and an EventPipeline.
protected  void regenerate(Environment environment)
           
protected  void regenerateAsynchronously(Environment environment)
           
 Source resolve(java.lang.String systemId)
          Resolve an entity.
 void run()
          Generate the Sitemap class
 void setBasePath(java.lang.String basePath)
           
 void throwEventualException()
           
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable
getLogger, setLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Handler

protected Handler(java.lang.String sourceFileName,
                  boolean check_reload)
           throws java.io.FileNotFoundException
Method Detail

contextualize

public void contextualize(org.apache.avalon.framework.context.Context context)
                   throws org.apache.avalon.framework.context.ContextException
Contextualizable
Specified by:
contextualize in interface org.apache.avalon.framework.context.Contextualizable

compose

public void compose(org.apache.avalon.framework.component.ComponentManager manager)
             throws org.apache.avalon.framework.component.ComponentException
Composable
Specified by:
compose in interface org.apache.avalon.framework.component.Composable

available

protected boolean available()

hasChanged

protected boolean hasChanged()

isRegenerating

protected boolean isRegenerating()

regenerateAsynchronously

protected void regenerateAsynchronously(Environment environment)
                                 throws java.lang.Exception

regenerate

protected void regenerate(Environment environment)
                   throws java.lang.Exception

process

public boolean process(Environment environment)
                throws java.lang.Exception
Description copied from interface: Processor
Process the given Environment producing the output.
Specified by:
process in interface Processor
Following copied from interface: org.apache.cocoon.Processor
Returns:
If the processing is successfull true is returned. If not match is found in the sitemap false is returned.
Throws:
ResourceNotFoundException - If a sitemap component tries to access a resource which can not be found, e.g. the generator ConnectionResetException If the connection was reset

process

public boolean process(Environment environment,
                       StreamPipeline pipeline,
                       EventPipeline eventPipeline)
                throws java.lang.Exception
Description copied from interface: Processor
Process the given Environment to assemble a StreamPipeline and an EventPipeline.
Specified by:
process in interface Processor

setBasePath

public void setBasePath(java.lang.String basePath)

run

public void run()
Generate the Sitemap class
Specified by:
run in interface java.lang.Runnable

throwEventualException

public void throwEventualException()
                            throws java.lang.Exception

getException

public java.lang.Exception getException()

dispose

public void dispose()
dispose
Specified by:
dispose in interface org.apache.avalon.framework.activity.Disposable

resolve

public Source resolve(java.lang.String systemId)
               throws ProcessingException,
                      org.xml.sax.SAXException,
                      java.io.IOException
Resolve an entity. Interface SourceResolver
Specified by:
resolve in interface SourceResolver
Following copied from interface: org.apache.cocoon.environment.SourceResolver
Parameters:
systemID - This is either a system identifier (java.net.URL or a local file.


Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.