Package net.ontopia.topicmaps.nav2.impl.basic

Class AbstractFunction

java.lang.Object
net.ontopia.topicmaps.nav2.impl.basic.AbstractFunction
All Implemented Interfaces:
FunctionIF
Direct Known Subclasses:
DisplayHierarchyFunction, Function, HelloWorldFunction
public abstract class AbstractFunction extends Object implements FunctionIF
INTERNAL: Abstract implementation of FunctionIF, which should be the superclass for customized functions.

Subclasses of this abstract function only have to implement the getParameters() and execute() methods.

Since:
1.3.4

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractFunction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    call(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag)
    INTERNAL: Executes this function in the specified context.
    Collection
    execute(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.
    String
    getName()
    INTERNAL: Gets the name of this function.
    Collection
    getParameters()
    INTERNAL: Return the names of the parameters as an ordered Collection.
    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.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AbstractFunction

      public AbstractFunction()

  • Method Details

    • getParameters

      public Collection getParameters()
      Description copied from interface: FunctionIF
      INTERNAL: Return the names of the parameters as an ordered Collection.
      Specified by:
      getParameters in interface FunctionIF
      Returns:
      Empty list

    • execute

      public Collection execute(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag) throws IOException, javax.servlet.jsp.JspException
      Description copied from interface: FunctionIF
      INTERNAL: Executes this function in the specified context.
      Specified by:
      execute in interface FunctionIF
      Returns:
      Collection The function return value collection. If null is returned, no value will be given to the parent value accepting tag.
      Throws:
      IOException
      javax.servlet.jsp.JspException

    • call

      public void call(javax.servlet.jsp.PageContext pageContext, javax.servlet.jsp.tagext.TagSupport callingTag) throws IOException, javax.servlet.jsp.JspException
      Description copied from interface: FunctionIF
      INTERNAL: Executes this function in the specified context.
      Specified by:
      call in interface FunctionIF
      Throws:
      IOException
      javax.servlet.jsp.JspException

    • getName

      public String getName()
      Description copied from interface: FunctionIF
      INTERNAL: Gets the name of this function.
      Specified by:
      getName in interface FunctionIF
      Returns:
      null

    • getReturnVariableName

      public 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
      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
      Returns:
      null

    • getRootNode

      public JSPTreeNodeIF getRootNode()
      Description copied from interface: FunctionIF
      INTERNAL: Gets the rode node of this Function.
      Specified by:
      getRootNode in interface FunctionIF
      Returns:
      null

    • toString

      public String toString()
      Overrides:
      toString in class Object