/**
* Returns a parameter giving expressions for the error values associated with a given coordinate
* axis, indexed by a table-identifying label. The value taken by this parameter is a string which
* is either a single (symmetric) numeric error expression or two comma-separated error
* expressions.
*
* @param axName axis label
* @param tlabel table identifier
* @return error pair parameter
*/
private Parameter createErrorParameter(String axName, String tlabel) {
Parameter param = new Parameter(axName.toLowerCase() + "error" + tlabel);
param.setUsage("<expr>|[<lo-expr>],[<hi-expr>]");
param.setPrompt("Error bound(s) in " + axName + " for table " + tlabel);
param.setNullPermitted(true);
param.setDescription(
new String[] {
"<p>Gives expressions for the errors on " + axName,
"coordinates for table " + tlabel + ".",
"The following forms are permitted:",
"<ul>",
"<li><code><expr></code>: symmetric error value</li>",
"<li><code><lo-expr>,<hi-expr></code>:"
+ "distinct lower and upper error values</li>",
"<li><code><lo-expr>,</code>: lower error value only</li>",
"<li><code>,<hi-expr></code>: upper error value only</li>",
"<li><code>null</code>: no errors</li>",
"</ul>",
"The expression in each case is a numeric algebraic expression",
"based on column names",
"as described in <ref id='jel'/>.",
"</p>",
});
return param;
}
/**
* Returns a parameter giving an expression for the coordinate values used by this axis. It is
* indexed by a table-identifying label.
*
* @param tlabel table identifier
* @return parameter giving JEL expression for coordinate data
*/
public Parameter createCoordParameter(String tlabel) {
Parameter param = new Parameter(axName_ + "data" + tlabel);
param.setUsage("<expr>");
param.setPrompt("Value to plot on " + axName_ + " axis" + " for table " + tlabel);
param.setDescription(
new String[] {
"<p>Gives a column name or expression for the " + axName_,
"axis data for table " + tlabel + ".",
"The expression is a numeric algebraic expression",
"based on column names",
"as described in <ref id=\"jel\"/>",
"</p>",
});
return param;
}
/**
* Constructs a new subset inclusion expression parameter.
*
* @param stlabel table/subset parameter label
* @return new subset expression parameter
*/
private Parameter createSubsetExpressionParameter(String stlabel) {
Parameter param = new Parameter(SUBSET_PREFIX + stlabel);
param.setPrompt("Selection criterion for subset " + stlabel);
param.setDescription(
new String[] {
"<p>Gives the selection criterion for the subset labelled",
"\"<code>" + stlabel + "</code>\".",
"This is a boolean expression which may be the name of",
"a boolean-valued column or any other boolean-valued expression.",
"Rows for which the expression evaluates true will be included",
"in the subset, and those for which it evaluates false will not.",
"</p>",
});
param.setUsage("<expr>");
return param;
}
