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

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.components.modules.input.AbstractInputModule
          extended byorg.apache.cocoon.components.modules.input.AbstractMetaModule
              extended byorg.apache.cocoon.components.modules.input.StringConcatMetaModule
All Implemented Interfaces:
Configurable, Disposable, org.apache.cocoon.components.modules.input.InputModule, Serviceable

public class StringConcatMetaModule
extends org.apache.cocoon.components.modules.input.AbstractMetaModule

StringConcatMetaModule concats strings from configured module chain. It assumes that all modules have string attributes, on the contrary, it calls toString() method.
If null is returned by some module RuntimeException will be thrown.

For configuration of input module chain take a look at example on ChainMetaModule.


Field Summary
 
Fields inherited from class org.apache.cocoon.components.modules.input.AbstractMetaModule
defaultInput, initialized, input, INPUT_MODULE_SELECTOR, inputConf, inputSelector, manager
 
Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule
settings
 
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule
ROLE
 
Constructor Summary
StringConcatMetaModule()
           
 
Method Summary
 void configure(Configuration config)
           
 Object getAttribute(String name, Configuration modeConf, Map objectModel)
           
protected  org.apache.cocoon.components.modules.input.ModuleHolder[] getFilteredInputModules(Configuration[] configurations)
           
protected  org.apache.cocoon.components.modules.input.ModuleHolder[] getInputModules(Configuration[] dynamicConfigurations)
           
 
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractMetaModule
dispose, getNames, getNames, getValue, getValue, getValue, getValue, getValues, getValues, getValues, getValues, lazy_initialize, obtainModule, releaseModule, service
 
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule
getAttributeNames, getAttributeValues
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringConcatMetaModule

public StringConcatMetaModule()
Method Detail

getFilteredInputModules

protected org.apache.cocoon.components.modules.input.ModuleHolder[] getFilteredInputModules(Configuration[] configurations)
                                                                                     throws ConfigurationException
Parameters:
configurations - List of configuration objects for input modules
Returns:
List of ModuleHolder objects obtained from configurations. If configuration does not have attribute it will be skipped and error logged.
Throws:
ConfigurationException

getInputModules

protected org.apache.cocoon.components.modules.input.ModuleHolder[] getInputModules(Configuration[] dynamicConfigurations)
                                                                             throws ConfigurationException
Parameters:
dynamicConfigurations -
Returns:
It returns list of modules. If does not contain valid list of configuration (e.g. is null) then static list is returned. In other case list is obtained from dynamicConfigurations.
Throws:
ConfigurationException

configure

public void configure(Configuration config)
               throws ConfigurationException
Throws:
ConfigurationException
See Also:
AbstractInputModule.configure(org.apache.avalon.framework.configuration.Configuration)

getAttribute

public Object getAttribute(String name,
                           Configuration modeConf,
                           Map objectModel)
                    throws ConfigurationException
Throws:
ConfigurationException


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.