intradoc.common
Interface DataMergerImplementor

public interface DataMergerImplementor

Interface used PageMerger class to allow other objects to augment script execution. When implementing the methods in this interface, if there are errors in call arguments throw an IllegalArgumentException.

Method Summary

boolean	computeFunction(java.lang.String function, java.lang.Object[] params) Compute a function.
boolean	computeOptionList(java.util.Vector params, java.util.Vector[] optList, java.lang.String[] selName) If can evaluate the option list, set optList[0] to that option list and optionally set the variable (selName[0]) containing the key used to look up the selected value from the DataBinder.
boolean	computeValue(java.lang.String variable, java.lang.String[] val) Compute the value of a variable.
void	notifyNextRow(java.lang.String rsetName, boolean hasNext) Called on next advance of row.
boolean	testCondition(java.lang.String condition, boolean[] retVal) Sets retVal[0] to true if 'condition' is true otherwise sets retVal[0] to false if 'condition' is false.
boolean	testForNextRow(java.lang.String rsetName, boolean[] retVal) Tests to see if there is another row.

Method Detail

testCondition

public boolean testCondition(java.lang.String condition,
                             boolean[] retVal)

Sets retVal[0] to true if 'condition' is true otherwise sets retVal[0] to false if 'condition' is false. Returns false if 'condition' was not evaluated.

testForNextRow

public boolean testForNextRow(java.lang.String rsetName,
                              boolean[] retVal)
                       throws java.io.IOException

Tests to see if there is another row. Returns false if made no attempt, otherwise attempts to move to next row and sets retVal[0] with the result of attempt.

java.io.IOException

notifyNextRow

public void notifyNextRow(java.lang.String rsetName,
                          boolean hasNext)
                   throws java.io.IOException

Called on next advance of row. If hasNext is true then in process of outputting another row otherwise function is notifying loop termination.

java.io.IOException

computeValue

public boolean computeValue(java.lang.String variable,
                            java.lang.String[] val)
                     throws java.io.IOException

Compute the value of a variable. Returns false if the value was not computed. If computed put return value in 'val[0]'.

java.io.IOException

computeFunction

public boolean computeFunction(java.lang.String function,
                               java.lang.Object[] params)
                        throws java.io.IOException

Compute a function. The 'params' array holds the arguments to the function with the last entry of the array being held in reserve for the return value of the function. Use the ScriptUtils routines to convert the Object values to the appropriate arguments of the functions. See ScriptCommonEvaluations for an example of how to evaluate functions. Returns false if function was not handled.

java.io.IOException

computeOptionList

public boolean computeOptionList(java.util.Vector params,
                                 java.util.Vector[] optList,
                                 java.lang.String[] selName)
                          throws java.io.IOException

If can evaluate the option list, set optList[0] to that option list and optionally set the variable (selName[0]) containing the key used to look up the selected value from the DataBinder. If 'selName[0]' is set to null then default lookup behavior for determining the selected value is used. The first parameter 'params' is a Vector containing an arrayof strings created by parsing the HTML option list tag using a ":" separator. The first entry in the Vector is the name of the option list, the second (if it exists) is the default lookup key to put into 'selName[0]'.

java.io.IOException