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

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.cocoon.components.modules.input.BaseLinkModule

All Implemented Interfaces:

Component, Configurable, Disposable, InputModule, LogEnabled, ThreadSafe

public class BaseLinkModule

extends AbstractInputModule

implements ThreadSafe

BaseLinkModule returns a relative link (../, ../../ etc) to the base of the current request or sitemap URI. For instance, if called within a <map:match pattern="a/b/c.xsp"> pipeline, {baselink:SitemapBaseLink} would evaluate to ../../. based on RequestURIModule

Author:

Torsten Knodt

Field Summary

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

BaseLinkModule()

Method Summary

Object	getAttribute(String name, Configuration modeConf, Map objectModel) Standard access to an attribute's value.
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.

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

BaseLinkModule

public BaseLinkModule()

Method Detail

getAttribute

public Object getAttribute(String name,
                           Configuration modeConf,
                           Map objectModel)
                    throws 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 InputModule.getAttributeValues(String, Configuration, Map) or InputModule.getAttributeNames(Configuration, Map) and InputModule.getAttribute(String, Configuration, Map) to get them one by one.

Specified by:

getAttribute in interface InputModule

Overrides:

getAttribute in class AbstractInputModule

Throws:

ConfigurationException

getAttributeNames

public Iterator getAttributeNames(Configuration modeConf,
                                  Map objectModel)
                           throws 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.

Specified by:

getAttributeNames in interface InputModule

Overrides:

getAttributeNames in class AbstractInputModule

Throws:

ConfigurationException

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

Overrides:

getAttributeValues in class AbstractInputModule

Throws:

ConfigurationException