net.ontopia.topicmaps.nav2.impl.basic
Class Function

java.lang.Object
  net.ontopia.topicmaps.nav2.impl.basic.AbstractFunction
      net.ontopia.topicmaps.nav2.impl.basic.Function

All Implemented Interfaces:

FunctionIF

public final class Function
extends AbstractFunction

INTERNAL: A FunctionIF implementation used by the XML-based ModuleIF reader code. The function evaluates the taglib tree node in the context of the calling tag and the page context.

See Also:

ModuleReader

Constructor Summary

Function(ModuleIF parentModule, java.lang.String name, JSPTreeNodeIF rootNode, java.util.Collection params)

Function(ModuleIF parentModule, java.lang.String name, JSPTreeNodeIF rootNode, java.util.Collection params, java.lang.String returnVariableName)

Function(java.lang.String name, JSPTreeNodeIF rootNode, java.util.Collection params)
Default constructor.

Method Summary

void	call(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag) INTERNAL: Executes this function in the specified context.
ModuleIF	getModule() INTERNAL: Gets the reference to the Module this function belongs to.
java.lang.String	getName() INTERNAL: Gets the name of this function.
java.util.Collection	getParameters() INTERNAL: Return the names of the parameters as an ordered Collection.
java.lang.String	getReturnVariableName() INTERNAL: Gets the name of the variable to which the return value of the function should be assigned to.
JSPTreeNodeIF	getRootNode() INTERNAL: Gets the rode node of this Function.
java.lang.String	toString()

Methods inherited from class net.ontopia.topicmaps.nav2.impl.basic.AbstractFunction

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

Function

public Function(java.lang.String name,
                JSPTreeNodeIF rootNode,
                java.util.Collection params)

Default constructor.

Function

public Function(ModuleIF parentModule,
                java.lang.String name,
                JSPTreeNodeIF rootNode,
                java.util.Collection params)

Function

public Function(ModuleIF parentModule,
                java.lang.String name,
                JSPTreeNodeIF rootNode,
                java.util.Collection params,
                java.lang.String returnVariableName)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: FunctionIF

INTERNAL: Gets the name of this function.

Specified by:

getName in interface FunctionIF

Overrides:

getName in class AbstractFunction

Returns:

null

getParameters

public java.util.Collection getParameters()

Description copied from interface: FunctionIF

INTERNAL: Return the names of the parameters as an ordered Collection.

Specified by:

getParameters in interface FunctionIF

Overrides:

getParameters in class AbstractFunction

Returns:

Empty list

getReturnVariableName

public java.lang.String getReturnVariableName()

Description copied from interface: FunctionIF

INTERNAL: Gets the name of the variable to which the return value of the function should be assigned to. Returns null if no return variable name was specified.

Specified by:

getReturnVariableName in interface FunctionIF

Overrides:

getReturnVariableName in class AbstractFunction

Returns:

null

call

public void call(javax.servlet.jsp.PageContext pageContext,
                 javax.servlet.jsp.tagext.TagSupport callingTag)
          throws java.io.IOException,
                 javax.servlet.jsp.JspException

Description copied from interface: FunctionIF

INTERNAL: Executes this function in the specified context.

Specified by:

call in interface FunctionIF

Overrides:

call in class AbstractFunction

Throws:

java.io.IOException

javax.servlet.jsp.JspException

getRootNode

public JSPTreeNodeIF getRootNode()

Description copied from interface: FunctionIF

INTERNAL: Gets the rode node of this Function.

Specified by:

getRootNode in interface FunctionIF

Overrides:

getRootNode in class AbstractFunction

Returns:

null

getModule

public ModuleIF getModule()

Description copied from interface: FunctionIF

INTERNAL: Gets the reference to the Module this function belongs to.

Specified by:

getModule in interface FunctionIF

Overrides:

getModule in class AbstractFunction

Returns:

null

toString

public java.lang.String toString()

Overrides:

toString in class AbstractFunction