net.ontopia.topicmaps.webed.impl.basic
Class ActionForwardPage

java.lang.Object
  net.ontopia.topicmaps.webed.impl.basic.ActionForwardPage

All Implemented Interfaces:

ActionForwardPageIF

public class ActionForwardPage
extends Object
implements ActionForwardPageIF

INTERNAL: Default implementation of the interface ActionForwardPageIF

Field Summary

protected static ParamRuleIF	DEF_PARAM_RULE
protected String	framename
protected String	nextActionTemplate
protected ParamRuleIF	paramRule
protected Map	reqParams
protected String	url

Constructor Summary

ActionForwardPage(String relativeURL)

ActionForwardPage(String aUrlString, Map parameters)

ActionForwardPage(String relativeURL, ParamRuleIF paramRule)

ActionForwardPage(String relativeURL, String framename)

ActionForwardPage(String relativeURL, String framename, String nextActionTemplate)

ActionForwardPage(String aUrlString, String framename, String nextActionTemplate, ParamRuleIF paramRule)

Method Summary

void	addParameter(String paramName, String paramValue) INTERNAL: Adds a request parameter (name, value) pair which should be included when setting up the next request.
boolean	equals(Object comp)
String	getFramename() INTERNAL: Gets the name of the frame which the forwarded page should appear in.
ParamRuleIF	getNextActionParamRule() INTERNAL: Get the rule for processing the request parameter handling with the current action name and constructing the next action request parameter with the help of the next action template.
String	getNextActionTemplate() INTERNAL: Gets name of the template for the request parameter which identifies the next action.
Map	getParameters() INTERNAL: Gets all existing request parameter (name, value) pairs.
String	getURL() INTERNAL: Gets the URL to forward to.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEF_PARAM_RULE

protected static final ParamRuleIF DEF_PARAM_RULE

url

protected String url

framename

protected String framename

nextActionTemplate

protected String nextActionTemplate

paramRule

protected ParamRuleIF paramRule

reqParams

protected Map reqParams

Constructor Detail

ActionForwardPage

public ActionForwardPage(String relativeURL)

ActionForwardPage

public ActionForwardPage(String aUrlString,
                         Map parameters)

ActionForwardPage

public ActionForwardPage(String relativeURL,
                         ParamRuleIF paramRule)

ActionForwardPage

public ActionForwardPage(String relativeURL,
                         String framename)

ActionForwardPage

public ActionForwardPage(String relativeURL,
                         String framename,
                         String nextActionTemplate)

ActionForwardPage

public ActionForwardPage(String aUrlString,
                         String framename,
                         String nextActionTemplate,
                         ParamRuleIF paramRule)

Method Detail

getURL

public String getURL()

Description copied from interface: ActionForwardPageIF

INTERNAL: Gets the URL to forward to.

Specified by:

getURL in interface ActionForwardPageIF

getFramename

public String getFramename()

Description copied from interface: ActionForwardPageIF

INTERNAL: Gets the name of the frame which the forwarded page should appear in.

Specified by:

getFramename in interface ActionForwardPageIF

addParameter

public void addParameter(String paramName,
                         String paramValue)

Description copied from interface: ActionForwardPageIF

INTERNAL: Adds a request parameter (name, value) pair which should be included when setting up the next request.

Specified by:

addParameter in interface ActionForwardPageIF

getParameters

public Map getParameters()

Description copied from interface: ActionForwardPageIF

INTERNAL: Gets all existing request parameter (name, value) pairs.

Specified by:

getParameters in interface ActionForwardPageIF

Returns:

Map containing parameter name (String object) as key and parameter value (String object) as value.

getNextActionTemplate

public String getNextActionTemplate()

Description copied from interface: ActionForwardPageIF

INTERNAL: Gets name of the template for the request parameter which identifies the next action. May be making use of name patterns with the help of placeholders.

Specified by:

getNextActionTemplate in interface ActionForwardPageIF

getNextActionParamRule

public ParamRuleIF getNextActionParamRule()

Description copied from interface: ActionForwardPageIF

INTERNAL: Get the rule for processing the request parameter handling with the current action name and constructing the next action request parameter with the help of the next action template.

Note: If no specific rule was setup the next action will be identical to the next action template

Specified by:

getNextActionParamRule in interface ActionForwardPageIF

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object comp)

Overrides:

equals in class Object