|
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Object | +--intradoc.common.DynamicHtmlMerger
Class that gives an initial implementation of the DynamicHtmlOutput interface. Note: this class has no constructor. This class must be specialized and a full constructor supplied.
| Field Summary | |
protected int |
m_curStackDepth
|
protected ExecutionContext |
m_cxt
Context in which script is implemented. |
java.lang.StringBuffer |
m_debugTrace
|
protected int |
m_errorNestingLevel
|
java.lang.StringBuffer |
m_errorTrace
Debug attributes. |
protected int |
m_evalNestingLevel
|
protected ParseSyntaxException |
m_evalScriptError
|
protected ScriptStackElement[] |
m_evalScriptStack
|
protected java.lang.String |
m_function
Active context variables. |
protected IdcBreakpoint |
m_idcBreakpoint
|
boolean |
m_isReportErrorStack
|
protected boolean |
m_isTracingScript
|
protected boolean |
m_isViewablePageOutput
|
protected java.util.Vector |
m_mergerImplementors
|
int |
m_numEvalFunction
|
int |
m_numEvalString
|
int |
m_numGetValue
|
int |
m_numIncResource
|
protected ParseOutput |
m_parseOutput
Reusable ParseOutput object. |
protected int |
m_recursionCount
|
protected ScriptContext |
m_scriptContext
Holds custom implementation of variables and functions. |
protected ScriptStackElement[] |
m_scriptStack
|
protected java.lang.String |
m_variable
|
| Constructor Summary | |
protected |
DynamicHtmlMerger()
|
| Method Summary | |
void |
addDataMerger(DataMergerImplementor mergerImplementor)
Adds a callback interface allowing selective evaluation of result sets. |
boolean |
appAdvanceRow(java.lang.String rsetName)
Advances to next row of a result set. |
void |
appAppendStackReferenceInfo(java.lang.StringBuffer stackMsg,
HtmlChunk chunk,
GrammarElement elt)
|
void |
appendPageStatistics(java.lang.StringBuffer buf)
|
void |
appendStackElementMessage(java.lang.StringBuffer stackMsg,
ScriptStackElement prev,
ScriptStackElement cur)
|
boolean |
appEvaluateCondition(java.lang.String condition)
Place for specialization to do its own evaluation of conditions. |
boolean |
appEvaluateFunction(java.lang.String func,
java.lang.Object[] params)
If not filter or callback interface implements funciton, then function is implemented here. |
DynamicHtml |
appGetAndRedirectHtmlResource(java.lang.String resName,
boolean useSuper,
HtmlChunk htmlChunk)
Gets a resource include. |
java.lang.String |
appGetLocalVariable(java.lang.String key)
Place for specialization to get a local variable. |
java.util.Vector |
appGetOptionList(java.lang.String optListName)
Method returns option list from application data. |
java.lang.String |
appGetOptionListSelectName(java.lang.String optListName)
Method returns key to use when trying to determine which value is selected. |
java.lang.Object |
appGetValue(java.lang.String variable)
|
void |
appSetBackHtmlResource(java.lang.String key,
DynamicHtml origHtml,
HtmlChunk htmlChunk)
Sets back a resource include. |
void |
appSetLocalVariable(java.lang.String key,
java.lang.String val)
Place for specialization to set a local variable. |
boolean |
checkCondition(HtmlChunk chunk,
GrammarElement elt)
Return true if 'condition' satisfied otherwise return false. |
void |
checkInitStack()
|
ScriptStackElement[] |
cloneCurrentStack()
|
void |
computeFunction(java.lang.String func,
java.lang.Object[] params)
|
java.lang.Object |
computeValue(java.lang.String variable,
boolean toBool)
|
void |
copyChunkInfo(ParseLocationInfo l,
HtmlChunk htmlChunk)
|
void |
createArgumentException(java.lang.String msg,
java.lang.String parseStr,
ParseSyntaxException e)
Create an exception that reports the location of an error during runtime processing of script. |
java.lang.String |
createArgumentMessage(java.lang.String msg,
java.lang.String parseStr,
ParseSyntaxException e)
Creates a message that reports the location of an error as an offset in a string that was parsed and executed. |
static java.lang.String |
createErrorMessage(HtmlChunk chunk,
GrammarElement elt,
java.lang.String msg)
|
protected void |
displayOptions(java.util.Vector params,
java.io.Writer writer)
|
void |
doBreakpoint(HtmlChunk chunk)
|
void |
endActiveResultSet()
End the loop by removing the result set. |
void |
evaluateBreakpoint(HtmlChunk chunk)
Given the chunk, tries to display contextual information for a breakpoint. |
boolean |
evaluateCondition(java.lang.String condition)
|
java.lang.Object |
evaluateGrammar(java.lang.String str)
|
java.lang.Object |
evaluateGrammarElement(HtmlChunk chunk,
GrammarElement elt,
boolean toBool)
Recursively called method that evaluates a grammar element. |
java.lang.String |
evaluateResourceInclude(java.lang.String inc)
|
java.lang.String |
evaluateScript(java.lang.String str)
|
java.lang.String |
evaluateScriptEx(java.lang.String str,
boolean isXml)
|
protected java.lang.String |
evaluateScriptInternal(java.lang.String str,
boolean isXml)
|
java.lang.Object |
evaluateScriptInValue(java.lang.Object obj)
See if value for element should be recusively evaluated. |
java.lang.String |
evaluateScriptReportError(java.lang.String str)
|
java.lang.String |
executeDynamicHtml(DynamicHtml dynHtml)
|
int |
executeFilter(java.lang.String filter)
Evaluates a plugin filter. |
DynamicHtml |
getAndRedirectHtmlResource(java.lang.String resName,
HtmlChunk htmlChunk)
Gets a resource of idoc script to evaluate. |
ScriptStackElement |
getCurrentStackElement()
|
java.lang.String |
getDebugTrace()
Gets the current debug trace. |
java.lang.String |
getErrorTrace()
Gets the current error trace. |
ExecutionContext |
getExecutionContext()
Gets the current execution context associated with this merger. |
boolean |
getIsTracingScript()
Gets value of flag that turns on/off whether or not script is traced. |
boolean |
getIsViewablePageOutput()
Gets value of flag that turns on/off whether or not this script is being executed in a context where at least some of the result will be directly viewable by a user or administrator. |
java.lang.String |
getOptionListSelectedValue(java.lang.String selectName)
Gets value for an option list key (probably returned by the method appGetOptionListSelectName. |
protected java.util.Vector |
getOptions(java.util.Vector params,
java.lang.String[] selNamePtr)
|
ParseOutput |
getOrCreateParseOutput(java.lang.String debugFileName,
boolean isXml)
This method should be used by those who are parsing small bits of Idoc script. |
ScriptContext |
getScriptContext()
|
java.util.Vector |
getScriptOptionList(java.lang.String name,
java.lang.String selNameDef,
java.lang.String[] selNamePtr)
|
void |
init(ExecutionContext ctxt)
|
boolean |
loadNextRow(HtmlChunk chunk,
java.lang.String rsetName)
Advances rows in a result set. |
java.lang.String |
outputDynamicHtmlPage(DynamicHtml dynHtml)
|
java.util.Vector |
parseIntoParams(java.lang.String param)
|
DynamicHtml |
parseScriptInternal(java.lang.String str)
|
DynamicHtml |
parseScriptInternalEx(java.lang.String str,
boolean isXml)
|
void |
popStack()
|
void |
pushStack(java.lang.String resName,
GrammarElement arg,
DynamicHtml elt,
HtmlChunk htmlChunk)
|
void |
pushStackMessage(java.lang.String msg)
|
void |
registerMerger()
|
void |
reportError(java.lang.String msg)
Outputs a error message without carriage return. |
void |
reportErrorAsTraceMessage(HtmlChunk chunk,
GrammarElement elt,
java.lang.String msg)
Reports a grammar execution error as trace message. |
void |
reportErrorln(java.lang.String msg)
Outputs a error message with carriage return. |
void |
reportErrorMessage(HtmlChunk chunk,
GrammarElement elt,
java.lang.String msg)
Reports a grammar execution error message. |
void |
reportTrace(java.lang.String msg,
DynamicHtml dynHtml)
Outputs a debug trace. |
void |
reportTraceln(java.lang.String msg,
DynamicHtml dynHtml)
Outputs a debug trace with carriage return. |
void |
setBackRedirectHtmlResource(java.lang.String inc,
DynamicHtml dynHtml,
HtmlChunk htmlChunk)
Undoes the redirection. |
void |
setExecutionContext(ExecutionContext cxt)
Beware. |
void |
setIsTracingScript(boolean isTracingScript)
Turns on/off flag that controls whether or not script is traced. |
void |
setIsViewablePageOutput(boolean isViewablePageOutput)
Turns on/off flag that controls output is meant to be viewable. |
void |
setScriptContext(ScriptContext context)
|
void |
substituteVariable(HtmlChunk chunk,
GrammarElement elt,
java.io.Writer writer)
Displays the value of a variable or option list. |
void |
unregisterMerger()
|
void |
updateBreakpoint(java.lang.String type)
|
void |
writeOptions(java.io.Writer writer,
java.util.Vector options,
java.lang.String selName)
Write out options list. |
java.lang.String |
writeResourceInclude(java.lang.String inc,
java.io.Writer writer,
boolean mustExist)
|
void |
writeValue(java.io.Writer writer,
java.lang.String value)
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected ExecutionContext m_cxt
protected java.util.Vector m_mergerImplementors
protected ScriptContext m_scriptContext
protected java.lang.String m_function
protected java.lang.String m_variable
protected int m_recursionCount
protected ParseSyntaxException m_evalScriptError
protected ScriptStackElement[] m_evalScriptStack
protected int m_evalNestingLevel
protected int m_errorNestingLevel
protected IdcBreakpoint m_idcBreakpoint
protected ParseOutput m_parseOutput
public java.lang.StringBuffer m_errorTrace
public java.lang.StringBuffer m_debugTrace
public boolean m_isReportErrorStack
protected boolean m_isViewablePageOutput
protected boolean m_isTracingScript
protected ScriptStackElement[] m_scriptStack
protected int m_curStackDepth
public int m_numGetValue
public int m_numEvalFunction
public int m_numIncResource
public int m_numEvalString
| Constructor Detail |
protected DynamicHtmlMerger()
| Method Detail |
public void init(ExecutionContext ctxt)
public void checkInitStack()
public void pushStack(java.lang.String resName,
GrammarElement arg,
DynamicHtml elt,
HtmlChunk htmlChunk)
public void pushStackMessage(java.lang.String msg)
public void popStack()
public void copyChunkInfo(ParseLocationInfo l,
HtmlChunk htmlChunk)
public ScriptStackElement getCurrentStackElement()
public ScriptStackElement[] cloneCurrentStack()
public DynamicHtml getAndRedirectHtmlResource(java.lang.String resName,
HtmlChunk htmlChunk)
throws ParseSyntaxException
getAndRedirectHtmlResource in interface DynamicHtmlOutputParseSyntaxException
public void setBackRedirectHtmlResource(java.lang.String inc,
DynamicHtml dynHtml,
HtmlChunk htmlChunk)
throws ParseSyntaxException
setBackRedirectHtmlResource in interface DynamicHtmlOutputParseSyntaxException
public boolean checkCondition(HtmlChunk chunk,
GrammarElement elt)
throws java.io.IOException,
ParseSyntaxException
checkCondition in interface DynamicHtmlOutputjava.io.IOException
ParseSyntaxException
public boolean loadNextRow(HtmlChunk chunk,
java.lang.String rsetName)
throws java.io.IOException
loadNextRow in interface DynamicHtmlOutputjava.io.IOExceptionpublic void endActiveResultSet()
DynamicHtmlOutput
endActiveResultSet in interface DynamicHtmlOutput
public void substituteVariable(HtmlChunk chunk,
GrammarElement elt,
java.io.Writer writer)
throws java.io.IOException,
ParseSyntaxException
substituteVariable in interface DynamicHtmlOutputjava.io.IOException
ParseSyntaxExceptionpublic void evaluateBreakpoint(HtmlChunk chunk)
DynamicHtmlOutput
evaluateBreakpoint in interface DynamicHtmlOutputpublic void registerMerger()
registerMerger in interface DynamicHtmlOutputpublic void unregisterMerger()
unregisterMerger in interface DynamicHtmlOutputpublic void updateBreakpoint(java.lang.String type)
public void doBreakpoint(HtmlChunk chunk)
doBreakpoint in interface DynamicHtmlOutput
public int executeFilter(java.lang.String filter)
throws java.io.IOException
java.io.IOException
public boolean appAdvanceRow(java.lang.String rsetName)
throws java.io.IOException
java.io.IOException
public java.lang.Object evaluateGrammarElement(HtmlChunk chunk,
GrammarElement elt,
boolean toBool)
throws java.io.IOException,
java.lang.IllegalArgumentException
java.io.IOException
java.lang.IllegalArgumentException
public boolean evaluateCondition(java.lang.String condition)
throws java.lang.IllegalArgumentException,
java.io.IOException,
ServiceException
java.lang.IllegalArgumentException
java.io.IOException
ServiceException
public DynamicHtml appGetAndRedirectHtmlResource(java.lang.String resName,
boolean useSuper,
HtmlChunk htmlChunk)
throws ParseSyntaxException
ParseSyntaxException
public void appSetBackHtmlResource(java.lang.String key,
DynamicHtml origHtml,
HtmlChunk htmlChunk)
throws ParseSyntaxException
ParseSyntaxException
public boolean appEvaluateCondition(java.lang.String condition)
throws java.io.IOException
java.io.IOException
public void appSetLocalVariable(java.lang.String key,
java.lang.String val)
public java.lang.String appGetLocalVariable(java.lang.String key)
public void computeFunction(java.lang.String func,
java.lang.Object[] params)
throws java.lang.IllegalArgumentException,
java.io.IOException,
ServiceException
java.lang.IllegalArgumentException
java.io.IOException
ServiceException
public boolean appEvaluateFunction(java.lang.String func,
java.lang.Object[] params)
throws java.lang.IllegalArgumentException,
java.io.IOException
java.lang.IllegalArgumentException
java.io.IOExceptionpublic java.util.Vector parseIntoParams(java.lang.String param)
public java.lang.Object computeValue(java.lang.String variable,
boolean toBool)
throws java.lang.IllegalArgumentException,
java.io.IOException,
ServiceException
java.lang.IllegalArgumentException
java.io.IOException
ServiceException
public java.lang.Object appGetValue(java.lang.String variable)
throws java.lang.IllegalArgumentException,
java.io.IOException
java.lang.IllegalArgumentException
java.io.IOException
public void writeValue(java.io.Writer writer,
java.lang.String value)
throws java.io.IOException
java.io.IOException
protected void displayOptions(java.util.Vector params,
java.io.Writer writer)
throws java.io.IOException,
ServiceException
java.io.IOException
ServiceException
public java.util.Vector getScriptOptionList(java.lang.String name,
java.lang.String selNameDef,
java.lang.String[] selNamePtr)
throws java.io.IOException,
ServiceException
java.io.IOException
ServiceException
protected java.util.Vector getOptions(java.util.Vector params,
java.lang.String[] selNamePtr)
throws java.io.IOException,
ServiceException
java.io.IOException
ServiceExceptionpublic java.lang.String appGetOptionListSelectName(java.lang.String optListName)
public java.util.Vector appGetOptionList(java.lang.String optListName)
public void writeOptions(java.io.Writer writer,
java.util.Vector options,
java.lang.String selName)
throws java.io.IOException,
ServiceException
java.io.IOException
ServiceException
public java.lang.String getOptionListSelectedValue(java.lang.String selectName)
throws java.io.IOException
java.io.IOException
public java.lang.Object evaluateScriptInValue(java.lang.Object obj)
throws java.io.IOException,
java.lang.IllegalArgumentException
java.io.IOException
java.lang.IllegalArgumentException
public java.lang.Object evaluateGrammar(java.lang.String str)
throws java.lang.IllegalArgumentException,
java.io.IOException
java.lang.IllegalArgumentException
java.io.IOException
public java.lang.String evaluateScript(java.lang.String str)
throws java.io.IOException,
java.lang.IllegalArgumentException
java.io.IOException
java.lang.IllegalArgumentException
public java.lang.String evaluateScriptEx(java.lang.String str,
boolean isXml)
throws java.io.IOException,
java.lang.IllegalArgumentException
java.io.IOException
java.lang.IllegalArgumentException
public java.lang.String evaluateScriptReportError(java.lang.String str)
throws java.io.IOException,
java.lang.IllegalArgumentException,
ParseSyntaxException
java.io.IOException
java.lang.IllegalArgumentException
ParseSyntaxException
protected java.lang.String evaluateScriptInternal(java.lang.String str,
boolean isXml)
throws java.io.IOException,
java.lang.IllegalArgumentException
java.io.IOException
java.lang.IllegalArgumentException
public DynamicHtml parseScriptInternalEx(java.lang.String str,
boolean isXml)
throws java.io.IOException,
ParseSyntaxException
java.io.IOException
ParseSyntaxException
public DynamicHtml parseScriptInternal(java.lang.String str)
throws java.io.IOException,
ParseSyntaxException
java.io.IOException
ParseSyntaxException
public ParseOutput getOrCreateParseOutput(java.lang.String debugFileName,
boolean isXml)
public java.lang.String evaluateResourceInclude(java.lang.String inc)
throws java.io.IOException,
java.lang.IllegalArgumentException
java.io.IOException
java.lang.IllegalArgumentException
public java.lang.String writeResourceInclude(java.lang.String inc,
java.io.Writer writer,
boolean mustExist)
throws java.io.IOException,
java.lang.IllegalArgumentException
java.io.IOException
java.lang.IllegalArgumentException
public java.lang.String outputDynamicHtmlPage(DynamicHtml dynHtml)
throws java.io.IOException,
ParseSyntaxException
java.io.IOException
ParseSyntaxException
public java.lang.String executeDynamicHtml(DynamicHtml dynHtml)
throws java.io.IOException,
ParseSyntaxException
java.io.IOException
ParseSyntaxException
public void createArgumentException(java.lang.String msg,
java.lang.String parseStr,
ParseSyntaxException e)
throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentExceptioncreateErrorMessage
public java.lang.String createArgumentMessage(java.lang.String msg,
java.lang.String parseStr,
ParseSyntaxException e)
throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentExceptioncreateArgumentException
public void reportErrorMessage(HtmlChunk chunk,
GrammarElement elt,
java.lang.String msg)
public void appAppendStackReferenceInfo(java.lang.StringBuffer stackMsg,
HtmlChunk chunk,
GrammarElement elt)
public void appendStackElementMessage(java.lang.StringBuffer stackMsg,
ScriptStackElement prev,
ScriptStackElement cur)
public void reportErrorAsTraceMessage(HtmlChunk chunk,
GrammarElement elt,
java.lang.String msg)
public void reportErrorln(java.lang.String msg)
public void reportError(java.lang.String msg)
public void reportTraceln(java.lang.String msg,
DynamicHtml dynHtml)
public void reportTrace(java.lang.String msg,
DynamicHtml dynHtml)
public static java.lang.String createErrorMessage(HtmlChunk chunk,
GrammarElement elt,
java.lang.String msg)
public ExecutionContext getExecutionContext()
public void setExecutionContext(ExecutionContext cxt)
public void addDataMerger(DataMergerImplementor mergerImplementor)
public boolean getIsTracingScript()
public void setIsTracingScript(boolean isTracingScript)
public boolean getIsViewablePageOutput()
public void setIsViewablePageOutput(boolean isViewablePageOutput)
public java.lang.String getErrorTrace()
public java.lang.String getDebugTrace()
public ScriptContext getScriptContext()
public void setScriptContext(ScriptContext context)
public void appendPageStatistics(java.lang.StringBuffer buf)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
(c) 1996-2005 All rights reserved. Stellent, Inc. |