|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.cocoon.components.modules.input.InputModuleHelper
Constructor Summary | |
InputModuleHelper()
|
Method Summary | |
Object |
getAttribute(Map objectModel,
Configuration conf,
String module,
String name,
Object deflt)
Get a single attribute value from a module. |
Object |
getAttribute(Map objectModel,
String module,
String name,
Object deflt)
Get a single attribute value from a module. |
Iterator |
getAttributeNames(Map objectModel,
Configuration conf,
String module)
Get an iterator to a collection of attribute names from a module. |
Iterator |
getAttributeNames(Map objectModel,
String module)
Get an iterator to a collection of attribute names from a module. |
Object[] |
getAttributeValues(Map objectModel,
Configuration conf,
String module,
String name,
Object[] deflt)
Get an array of values from a module. |
Object[] |
getAttributeValues(Map objectModel,
String module,
String name,
Object[] deflt)
Get an array of values from a module. |
void |
releaseAll()
Releases all obtained module references. |
void |
setup(ServiceManager manager)
Initializes the instance for first use. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public InputModuleHelper()
Method Detail |
public void setup(ServiceManager manager) throws InputModuleException
manager
- a ServiceManager
value
InputModuleException
- if an error occurspublic Object getAttribute(Map objectModel, Configuration conf, String module, String name, Object deflt) throws InputModuleException
objectModel
- a Map
valueconf
- a Configuration
containing the module dynamic configuration (aka modeConf)module
- a String
value holding the module namename
- a String
value holding the attribute namedeflt
- an Object
value holding a default value
Object
value
InputModuleException
- if an error occurspublic Object getAttribute(Map objectModel, String module, String name, Object deflt) throws InputModuleException
getAttribute(Map, Configuration, String, String, Object)
with a
null
configuration.
InputModuleException
public Object[] getAttributeValues(Map objectModel, Configuration conf, String module, String name, Object[] deflt) throws InputModuleException
objectModel
- a Map
valueconf
- a Configuration
containing the module dynamic configuration (aka modeConf)module
- a String
value holding the module namename
- a String
value holding the attribute namedeflt
- an Object[]
value holding a default value
Object[]
value
InputModuleException
- if an error occurspublic Object[] getAttributeValues(Map objectModel, String module, String name, Object[] deflt) throws InputModuleException
getAttributeValues(Map, Configuration, String, String, Object[])
with a null
configuration.
InputModuleException
public Iterator getAttributeNames(Map objectModel, Configuration conf, String module) throws InputModuleException
objectModel
- a Map
valuemodule
- the module's name
Iterator
value
InputModuleException
- if an error occurspublic Iterator getAttributeNames(Map objectModel, String module) throws InputModuleException
getAttributeNames(Map, Configuration, String)
with a
null
configuration.
InputModuleException
public void releaseAll() throws InputModuleException
InputModuleException
- if an error occurs
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |