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

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLogEnabled
        |
        +--org.apache.cocoon.components.modules.input.AbstractInputModule
              |
              +--org.apache.cocoon.components.modules.input.NullInputModule

All Implemented Interfaces:

org.apache.avalon.framework.component.Component, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.activity.Disposable, InputModule, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.thread.ThreadSafe

public class NullInputModule

extends AbstractInputModule

implements org.apache.avalon.framework.thread.ThreadSafe

NullInputModule returns a null object. Use this if you wnat to explicitly forbit a parameter to be filled. E.g. a database column shall be filled with a default value, your forms never contain that parameter but you don't want anyone to provide this parameter manually.

Version:

CVS $Id: NullInputModule.java,v 1.2.4.1 2002/11/17 19:12:49 haul Exp $

Author:

Christian Haul

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

NullInputModule()

Method Summary

java.lang.Object	getAttribute(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel) Standard access to an attribute's value.
java.util.Iterator	getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf, java.util.Map objectModel) Returns an Iterator of String objects containing the names of the attributes available.
java.lang.Object[]	getAttributeValues(java.lang.String name, org.apache.avalon.framework.configuration.Configuration modeConf, java.util.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.

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

configure, dispose

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

Constructor Detail

NullInputModule

public NullInputModule()

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name,
                                     org.apache.avalon.framework.configuration.Configuration modeConf,
                                     java.util.Map objectModel)
                              throws org.apache.avalon.framework.configuration.ConfigurationException

Description copied from interface: InputModule

Standard access to an attribute's value. If more than one value exists, the first is returned. If the value does not exist, null is returned. To get all values, use getAttributeSet or getAttributeNames and getAttribute to get them one by one.

Following copied from interface: org.apache.cocoon.components.modules.input.InputModule

Parameters:

name - a String that specifies what the caller thinks would identify an attribute. This is mainly a fallback if no modeConf is present.

modeConf - column's mode configuration from resource description. This argument is optional.

objectModel -

getAttributeNames

public java.util.Iterator getAttributeNames(org.apache.avalon.framework.configuration.Configuration modeConf,
                                            java.util.Map objectModel)
                                     throws org.apache.avalon.framework.configuration.ConfigurationException

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.

Following copied from interface: org.apache.cocoon.components.modules.input.InputModule

Parameters:

modeConf - column's mode configuration from resource description. This argument is optional.

objectModel -

getAttributeValues

public java.lang.Object[] getAttributeValues(java.lang.String name,
                                             org.apache.avalon.framework.configuration.Configuration modeConf,
                                             java.util.Map objectModel)
                                      throws org.apache.avalon.framework.configuration.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, getAttributeNames together with getAttribute can be used to get the values one by one.

Following copied from interface: org.apache.cocoon.components.modules.input.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.

objectModel -