org.apache.cocoon.components.modules.input
Class SitemapVariableHolder

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.cocoon.components.modules.input.SitemapVariableHolder
All Implemented Interfaces:
Configurable, LogEnabled, SitemapConfigurable, ThreadSafe

public final class SitemapVariableHolder
extends AbstractLogEnabled
implements Configurable, SitemapConfigurable, ThreadSafe

This "component" is a trick to get global variables on a per sitemap base

Version:
CVS $Id: SitemapVariableHolder.java 55389 2004-10-23 15:46:58Z cziegeler $
Author:
Carsten Ziegeler

Field Summary
static String ROLE
           
 
Constructor Summary
SitemapVariableHolder()
           
 
Method Summary
 void configure(Configuration conf)
          Configures the database access helper.
 void configure(SitemapConfigurationHolder holder)
          Set the Configuration from a sitemap
 Object get(String key)
          Get a value
 Iterator getKeys()
          Get keys
protected  Map getValues()
           
protected  void prepare(ChainedConfiguration conf, Map values)
           
 
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
 

Field Detail

ROLE

public static final String ROLE
Constructor Detail

SitemapVariableHolder

public SitemapVariableHolder()
Method Detail

configure

public void configure(Configuration conf)
               throws ConfigurationException
Configures the database access helper. Takes all elements nested in component declaration and stores them as key-value pairs in settings. Nested configuration option are not catered for. This way global configuration options can be used. For nested configurations override this function.

Specified by:
configure in interface Configurable
Throws:
ConfigurationException

configure

public void configure(SitemapConfigurationHolder holder)
Set the Configuration from a sitemap

Specified by:
configure in interface SitemapConfigurable

get

public Object get(String key)
Get a value


getKeys

public Iterator getKeys()
Get keys


getValues

protected Map getValues()

prepare

protected void prepare(ChainedConfiguration conf,
                       Map values)


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.