org.apache.cocoon.portal.components.modules.input
Class AbstractModule

java.lang.Object
  extended by org.apache.cocoon.portal.components.modules.input.AbstractModule
All Implemented Interfaces:
Component, Serviceable, ThreadSafe, InputModule
Direct Known Subclasses:
CopletModule, LayoutModule, SkinModule

public abstract class AbstractModule
extends Object
implements InputModule, Serviceable, ThreadSafe

Version:
CVS $Id: AbstractModule.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary
protected  ServiceManager manager
          The service manager.
 
Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule
ROLE
 
Constructor Summary
AbstractModule()
           
 
Method Summary
 Iterator getAttributeNames(Configuration modeConf, Map objectModel)
          Returns an Iterator of String objects containing the names of the attributes available.
 Object[] getAttributeValues(String name, Configuration modeConf, Map objectModel)
          Returns an array of String objects containing all of the values the given attribute has, or null if the attribute does not exist.
 void service(ServiceManager manager)
           
 
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.components.modules.input.InputModule
getAttribute
 

Field Detail

manager

protected ServiceManager manager
The service manager.

Constructor Detail

AbstractModule

public AbstractModule()
Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException
Specified by:
service in interface Serviceable
Throws:
ServiceException

getAttributeNames

public Iterator getAttributeNames(Configuration modeConf,
                                  Map objectModel)
Description copied from interface: InputModule
Returns an Iterator of String objects containing the names of the attributes available. If no attributes are available, the method returns an empty Iterator.

Specified by:
getAttributeNames in interface InputModule
Parameters:
modeConf - column's mode configuration from resource description. This argument is optional.

getAttributeValues

public Object[] getAttributeValues(String name,
                                   Configuration modeConf,
                                   Map objectModel)
                            throws ConfigurationException
Description copied from interface: InputModule
Returns an array of String objects containing all of the values the given attribute has, or null if the attribute does not exist. As an alternative, InputModule.getAttributeNames(Configuration, Map) together with InputModule.getAttribute(String, Configuration, Map) can be used to get the values one by one.

Specified by:
getAttributeValues in interface InputModule
Parameters:
name - a String that specifies what the caller thinks would identify an attributes. This is mainly a fallback if no modeConf is present.
modeConf - column's mode configuration from resource description. This argument is optional.
Throws:
ConfigurationException


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.