jet.web.dhtml

Interface DHTMLDataInfo

public interface DHTMLDataInfo

DHTML APIs provide APIs for users. With DHTML APIs, users can easily embed the DHTML pages or components into their own JSPs. All the methods in this interface can be invoked by remote server (RMI).

Support the running of multiple report sets in one session, and a report set can include one or more reports.

Descriptions of some key terms:

sessionId: the key for the session in the server (generated by the server automatically when you log in), and users can invoke DHTMLUtil.getSessionID(HttpServletRequest request) to get the key.

rptSetId: the key for the report set in DHTML (generated automatically after the report set has been run), and users can invoke DHTMLUtil.getRptSetId(HttpServletRequest request) to get the key.

rptName: the key for the report in DHTML (retrieved from the report set after the report set has been run), and users can invoke DHTMLUtil.getRptName(HttpServletRequest request) to get the key.

Note of using this DHTML API:

You must follow a certain order for the method which use the parameters "sessionId", "rptSetId" and "rptName" in dhtml.jsp. For example: getSortColumns(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, boolean isDateSet) must be called after the code "Map tmpmap = DHTMLUtil.runReport(request, params);", because the parameters are offered after the report set has been run. If the wrong order is used, a jsp error will be generated. And there is no specified order for the other api methods that do not use the parameters.

Method Summary

Modifier and Type	Method and Description
String[]	getAllAvailableBLColNamesForRsd(String RptSetId, String RptName, String engineKey, String dataSetName) Gets all available BLColumns' names when running DHTML result.
String[]	getBusinessCubeNames(String rptSetId, String engineKeyword) Deprecated. Gets the names of business cube tree.
chart.ChartDefinition	getChartDefinition(String sessionId, String rptSetId, String rptName, String subRptKey, String comName) Gets the chart definition.
Map	getChartDefinitionInfo(String sessionId, String rptSetId, String rptName, String subRptKey, String comName) Gets the chart definition information.
Vector	getChartGroupInfo(String sessionId, String rptSetId, String rptName, String subRptKey, String comName) Gets the chart group information.
String[][]	getColNamesForConditionFormat(String rptSetId, String rptName, String subRptKey, String comName) Gets all columns' mapping names and display names for Condition Format.
int	getComponentColumnValues(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, String column, int index, int size, List result) Gets the specify values of components column.
List	getComponentDisplayAndRealValues(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, String column, int index, int size, String displayFormat, Locale locale, boolean isCurrent, boolean appLyDataTimeZone) Gets the value list that includes display values and real values in the specified component. Can be used to show the column values -- the column values in filter more value dialog, etc. And carry out the value page function.
String	getComponentTypeByInstName(String rptSetId, String rptName, String subRptKey, String compName) Gets the component type string.
String[]	getCrossTabDimensionInstName(String rptSetId, String rptName, String subRptKey, String comName) Gets the crosstab CTHdDbFileld instance name.
int	getDatasetColumnValues(String sessionId, String rptSetId, String rptName, String subRptKey, String datasetName, String column, int index, int size, List result) Gets the specified values of datasets column.
int	getDatasetDisplayAndRealValues(String sessionId, String rptSetId, String rptName, String subRptKey, String datasetName, String column, int index, int size, List result, String displayFormat, Locale locale) Gets the value list that includes the display values and the real values in the specified dataset.
String	getDataSetName(String sessionId, String rptSetId, String rptName, String subRptKey, String comName) Gets the dataset's name of the specified component.
String[]	getDetailReportDataSourceNames(String sessionId, String rptSetId, String rptName, String dsid) Gets the data sources' names which are used in the detail report.
Vector	getDisplayAndRealValueByInpput(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, String column, String displayFormat, String inputFormat, String inputValue, Locale locale, boolean isDataSet, boolean isMulti) Gets the display value by a string value user input. Such as the input value is 1,234,567.89, the real value should be 1234567.89, the display value is $1,234,567.89.
String	getDisplayNameByInstName(String rptSetId, String rptName, String subRptKey, String compName) Gets the display name by the instance name.
String	getDisplayPattern(int sqlType, Locale locale) Gets the display pattern of the specified sql type column.
String	getDisplayPattern(String userName, int sqlType, Locale locale) Gets the display pattern of the specified sql type column with the specified user.
String	getDisplayPattern(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, String column, boolean isDataSet, Locale locale) Gets the display pattern of the specified column. Such as the total in database is 1234567.89, user wants to see 1,234,567.89. And the display pattern is defined in the related DBField in the report; or user sets.
String	getDisplayPattern(String sessionId, String rptSetId, String rptName, String subRptKey, String component, String column, Locale locale) Gets the display pattern of the specified column. Such as the total in database is 1234567.89, but user wants to see 1,234,567.89. And the display pattern is defined in the related DBField in the report; or user sets.
String	getDisplayValueByReal(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, String column, String displayFormat, String realValue, Locale locale, boolean isDataSet) Gets the display value by real value with the specified display pattern. Such as the real value is 1234567.89, user wants to see 1,234,567.89.
Vector<jet.web.dhtml.DHTMLDrillFilterInfo>	getDrillFilter(String RptSetId, String RptName, String subRptKey, String comName) Gets the component's drill filter.
String	getFilterableElement(String sessionId, String rptSetId, String rptName, String comName, String bindcolumn, String dsid) Gets the filter select with the specified column name. The bindcolumn is defined by the "Bind Column" property of the label.
String[][]	getFilterColumns(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, boolean isDateSet) Gets all columns' mapping names and display names for filter action.
String[]	getFilterComponents(String rptSetId, String rptName, String subRptKey) Gets all components' names for filter action.
Vector	getFilterConditions(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, boolean isDataset) Gets the filter conditions.
String[]	getFilterDataSets(String rptSetId, String rptName, String subRptKey) Gets all datasets' names for filter action.
String	getInputPattern(int sqlType, Locale locale) Gets the input pattern of the specified sql type column.
String	getInputPattern(String userName, int sqlType, Locale locale) Gets the input pattern of the specified sql type column with the specified user.
String	getInputPattern(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, String column, boolean isDataSet, Locale locale) Gets the input pattern of the specified column. Such as the total which user wants to input 1,234,567.89, in database is 1234567.89.
String	getInputPattern(String sessionId, String rptSetId, String rptName, String subRptKey, String component, String column, Locale locale) Gets the input pattern of the specified column. Such as the total in database is 1234567.89, but user wants to input 1,234,567.89.
List	getLinkPathInfo(String sessionId, String rptSetId, String rptName) Gets the report link path information.
String[]	getResetComponents(String rptSetId, String rptName) Gets all components' names for reset action.
String[][]	getSortColumns(String sessionId, String rptSetId, String rptName, String subRptKey, String comName, boolean isDateSet) Gets all columns' mapping names and display names for sort action.
String[]	getSortComponents(String rptSetId, String rptName, String subRptKey) Gets all components' names for sort action.
String[][]	getSortConditions(String sessionId, String rptSetId, String rptName, String subRptKey, String comName) Gets the sort conditions.
String[]	getSortDataSets(String rptSetId, String rptName, String subRptKey) Gets all datasets' names for sort action.
String	getTopNCompName(String dsid, String sessionId, String rptSetId, String rptName) Gets the data container name of the specified element.
int	getTopNType(String sessionId, String rptSetId, String rptName, String comName) Gets the topN type of the specified component.
void	setDisplayPattern(int sqlType, String pattern, Locale locale) Sets the display pattern of the specified sql type column. Such as the total in database is 1234567.89, but user wants to see 1,234,567.89. Then user should setDisplayPattern(SQL_FLOAT, "#,###,###.##", China);
void	setDisplayPattern(String userName, int sqlType, String pattern, Locale locale) Sets the display pattern of the specified sql type column with the specified user. Such as the total in database is 1234567.89, but user wants to see 1,234,567.89. Then user should setDisplayPattern("admin", SQL_FLOAT, "#,###,###.##", China);
void	setDisplayPattern(String sessionId, String rptSetId, String rptName, String subRptKey, String component, String column, String pattern, Locale locale) Sets the display pattern of the specified column. Such as the total in database is 1234567.89, but user wants to see 1,234,567.89.
void	setInputPattern(int sqlType, String pattern, Locale locale) Sets the input pattern of the specified sql type column. Such as the total in database is 1234567.89, but user wants to input 1,234,567.89. Then user should setInputPattern(SQL_FLOAT, "#,###,###.##", China);
void	setInputPattern(String userName, int sqlType, String pattern, Locale locale) Sets the input pattern of the specified sql type column with the specified user. Such as the total in database is 1234567.89, but user wants to input 1,234,567.89. Then user should setInputPattern("admin", SQL_FLOAT, "#,###,###.##", China);
void	setInputPattern(String sessionId, String rptSetId, String rptName, String subRptKey, String component, String column, String pattern, Locale locale) Sets the input pattern of the specified column. Such as the total in database is 1234567.89, but user wants to input 1,234,567.89.

Method Detail

getSortColumns

String[][] getSortColumns(String sessionId,
                          String rptSetId,
                          String rptName,
                          String subRptKey,
                          String comName,
                          boolean isDateSet)
                   throws jet.rptservice.api.exception.JRScheduleException

Gets all columns' mapping names and display names for sort action.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the dataset name or the component name.

isDateSet - if comName is dataset name then it is true, otherwise false.

Returns:

all sort columns' names.
For example [["mappingName1","dispalyName1"],["mappingName2","dispalyName2"]]. The first is mapping name; the second is display name.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getFilterColumns

String[][] getFilterColumns(String sessionId,
                            String rptSetId,
                            String rptName,
                            String subRptKey,
                            String comName,
                            boolean isDateSet)
                     throws jet.rptservice.api.exception.JRScheduleException

Gets all columns' mapping names and display names for filter action.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the dataset name or the component name.

isDateSet - if comName is dataset name then it is true, otherwise false.

Returns:

all filter columns' names.
For example [["mappingName1","displayName1"],["mappingName2","displayName2"]]. The first is mapping name; the second is display name.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getSortComponents

String[] getSortComponents(String rptSetId,
                           String rptName,
                           String subRptKey)
                    throws jet.rptservice.api.exception.JRScheduleException

Gets all components' names for sort action.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

Returns:

all components' names. Includes banded object(s), group panel(s), table(s) in the report.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getFilterComponents

String[] getFilterComponents(String rptSetId,
                             String rptName,
                             String subRptKey)
                      throws jet.rptservice.api.exception.JRScheduleException

Gets all components' names for filter action.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

Returns:

all components' names. Includes banded object(s), table(s) in the report.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getBusinessCubeNames

String[] getBusinessCubeNames(String rptSetId,
                              String engineKeyword)

Deprecated. Gets the names of business cube tree.

Parameters:

rptSetId - the report set id.

subRptKey - the key of the engine.

Returns:

the names of business cube tree.

getColNamesForConditionFormat

String[][] getColNamesForConditionFormat(String rptSetId,
                                         String rptName,
                                         String subRptKey,
                                         String comName)
                                  throws jet.rptservice.api.exception.JRScheduleException

Gets all columns' mapping names and display names for Condition Format.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

Returns:

all columns' names.
For example [["mappingName1","dispalyName1"],["mappingName2","dispalyName2"]]. The first is mapping name; the second is display name.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getSortDataSets

String[] getSortDataSets(String rptSetId,
                         String rptName,
                         String subRptKey)

Gets all datasets' names for sort action.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

Returns:

all DataSets' names. Not published.

getFilterDataSets

String[] getFilterDataSets(String rptSetId,
                           String rptName,
                           String subRptKey)

Gets all datasets' names for filter action.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

Returns:

all Datasets' names. Not publish.

getDatasetColumnValues

int getDatasetColumnValues(String sessionId,
                           String rptSetId,
                           String rptName,
                           String subRptKey,
                           String datasetName,
                           String column,
                           int index,
                           int size,
                           List result)

Gets the specified values of datasets column.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

datasetName - the dataset name.

column - the column mapping name.

index - the beginning index, inclusive.

size - get values' length.

result - use must new a vector then return result it will change.

Returns:

real value index. Always 0.
-1: failed
if index != 0 but it return 0 That means the value has updated
if index != 0 but it return value < index that means the index is out of Range, return some of the last values.

getComponentColumnValues

int getComponentColumnValues(String sessionId,
                             String rptSetId,
                             String rptName,
                             String subRptKey,
                             String comName,
                             String column,
                             int index,
                             int size,
                             List result)

Gets the specify values of components column.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the component name

column - the column mapping name.

index - the beginning index, inclusive.

size - will get how many values.

result - use must new a vector then return result it will change.

Returns:

real value index. Always 0.
-1: is failed
if index !=0 but it return 0 That is values has updated
if index !=0 but it return value < index that the index outRange.return last some values.

getDatasetDisplayAndRealValues

int getDatasetDisplayAndRealValues(String sessionId,
                                   String rptSetId,
                                   String rptName,
                                   String subRptKey,
                                   String datasetName,
                                   String column,
                                   int index,
                                   int size,
                                   List result,
                                   String displayFormat,
                                   Locale locale)

Gets the value list that includes the display values and the real values in the specified dataset.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

datasetName - data set name.

column - column mapping

index - the beginning index, inclusive.

the - size of we will get values

result - will save result values list, it will be filled by this interface.

display - pattern

locale - locale info

Returns:

real value index. -1: is failed if index !=0 but it return 0 That is values has updated if index !=0 but it return value < index that the index outRange.return last some values. Not published.

getComponentDisplayAndRealValues

List getComponentDisplayAndRealValues(String sessionId,
                                      String rptSetId,
                                      String rptName,
                                      String subRptKey,
                                      String comName,
                                      String column,
                                      int index,
                                      int size,
                                      String displayFormat,
                                      Locale locale,
                                      boolean isCurrent,
                                      boolean appLyDataTimeZone)

Gets the value list that includes display values and real values in the specified component.
Can be used to show the column values -- the column values in filter more value dialog, etc.
And carry out the value page function.

An example of the method:

%serverhome%/public_html/dhtmljsp/selectvalues.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the component name.

column - the column mapping name.

index - the beginning index, inclusive.

size - the size of values.

displayFormat - the display pattern.

locale - the locale information.

isCurrent - whether they are current or original values.

Returns:

the value list.

getDisplayPattern

String getDisplayPattern(String sessionId,
                         String rptSetId,
                         String rptName,
                         String subRptKey,
                         String comName,
                         String column,
                         boolean isDataSet,
                         Locale locale)
                  throws jet.rptservice.api.exception.JRScheduleException

Gets the display pattern of the specified column.
Such as the total in database is 1234567.89, user wants to see 1,234,567.89.
And the display pattern is defined in the related DBField in the report; or user sets.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the dataset name or the component name.

column - the column mapping name.

isDataSet - if comName is dataset name then it is true, otherwise false.

locale - the locale information.

Returns:

the display pattern.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getInputPattern

String getInputPattern(String sessionId,
                       String rptSetId,
                       String rptName,
                       String subRptKey,
                       String comName,
                       String column,
                       boolean isDataSet,
                       Locale locale)
                throws jet.rptservice.api.exception.JRScheduleException

Gets the input pattern of the specified column.
Such as the total which user wants to input 1,234,567.89, in database is 1234567.89.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the dataset name or the component name.

column - the column mapping name.

isDataSet - if comName is dataset name then it is true, otherwise false.

locale - the locale information.

Returns:

the input pattern.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getDisplayValueByReal

String getDisplayValueByReal(String sessionId,
                             String rptSetId,
                             String rptName,
                             String subRptKey,
                             String comName,
                             String column,
                             String displayFormat,
                             String realValue,
                             Locale locale,
                             boolean isDataSet)
                      throws ParseException,
                             jet.rptservice.api.exception.JRScheduleException

Gets the display value by real value with the specified display pattern.
Such as the real value is 1234567.89, user wants to see 1,234,567.89.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the dataset name or the component name.

column - the column mapping name.

displayFormat - the display pattern.

realValue - the real value.

locale - the locale information.

isDataSet - if comName is dataset name

Returns:

the display value.

Throws:

ParseException

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getDisplayAndRealValueByInpput

Vector getDisplayAndRealValueByInpput(String sessionId,
                                      String rptSetId,
                                      String rptName,
                                      String subRptKey,
                                      String comName,
                                      String column,
                                      String displayFormat,
                                      String inputFormat,
                                      String inputValue,
                                      Locale locale,
                                      boolean isDataSet,
                                      boolean isMulti)
                               throws ParseException,
                                      jet.rptservice.api.exception.JRScheduleException

Gets the display value by a string value user input.
Such as the input value is 1,234,567.89, the real value should be 1234567.89, the display value is $1,234,567.89.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the component name.

column - the column mapping name.

displayFormat - the display pattern.

inputFormat - the input pattern.

inputValue - user input value

locale - the locale information.

isDataSet - if comName is dataset name.

isMulti - if the input value is multi-value input, for example "1,5,7"

Returns:

a list that includes display and real values. for example {[display0,real0],[display1,real1]...}

Throws:

ParseException

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getResetComponents

String[] getResetComponents(String rptSetId,
                            String rptName)

Gets all components' names for reset action.

Parameters:

rptSetId - the report set id.

rptName - the report name.

Returns:

all components' names. Includes banded object(s), group panel(s), table(s) in the report.

getChartDefinition

chart.ChartDefinition getChartDefinition(String sessionId,
                                         String rptSetId,
                                         String rptName,
                                         String subRptKey,
                                         String comName)

Gets the chart definition.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

Returns:

the chart definition, if the component is not chart, will return null.

getChartGroupInfo

Vector getChartGroupInfo(String sessionId,
                         String rptSetId,
                         String rptName,
                         String subRptKey,
                         String comName)

Gets the chart group information.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

Returns:

the chart GroupInfo, if the component is not chart, will return null.

getSortConditions

String[][] getSortConditions(String sessionId,
                             String rptSetId,
                             String rptName,
                             String subRptKey,
                             String comName)

Gets the sort conditions.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

Returns:

the sort conditions.

For example [["mappingName1","true"],["mappingName2","false"]]

The first is the mapping name;

the second is the order: true is ascending; false is descending.

getFilterConditions

Vector getFilterConditions(String sessionId,
                           String rptSetId,
                           String rptName,
                           String subRptKey,
                           String comName,
                           boolean isDataset)

Gets the filter conditions. This method should be used with the V9 early version.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

isDataset - if comName is dataset name then it is true, otherwise false.

Returns:

the filter conditions.

Vector which contains:

String columnName = (String)condition.get(1);

String operate = (String)condition.get(2);

String logic = (String)condition.get(4);

Object values = condition.get(3);
values maybe a string, means the condition is a single value;
a Vector, means the condition is a multi-value (each value is a string).

getTopNCompName

String getTopNCompName(String dsid,
                       String sessionId,
                       String rptSetId,
                       String rptName)

Gets the data container name of the specified element.

Parameters:

dsid - ID of the result object, it can be null.

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the data container name, which will be null if the specified element does not exist. Such as the banded object, group panel, table, or crosstab in the report.

getTopNType

int getTopNType(String sessionId,
                String rptSetId,
                String rptName,
                String comName)

Gets the topN type of the specified component.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the component name.

Returns:

EnumerationConstant.SELECTTYPE_ALL;

EnumerationConstant.SELECTTYPE_BOTTOMN;

EnumerationConstant.SELECTTYPE_TOPN.

See Also:

EnumerationConstant

getComponentTypeByInstName

String getComponentTypeByInstName(String rptSetId,
                                  String rptName,
                                  String subRptKey,
                                  String compName)
                           throws jet.rptservice.api.exception.JRScheduleException

Gets the component type string.

Parameters:

rptSetId - the report set id.

rptName - the report name.

comName - the component instance name.

Returns:

"CrossTab";

"Chart";

"NewTable";

"Table";

"GroupPanel";

"GroupHeader";

"GroupFooter";

"DetailPanel";

"SectionObject";

"PagePanel";

"TableDetail";

"SectionPageHeader";

"SectionPageFooter";

"TableHeader";

"TableFooter";

otherwise: null.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getCrossTabDimensionInstName

String[] getCrossTabDimensionInstName(String rptSetId,
                                      String rptName,
                                      String subRptKey,
                                      String comName)
                               throws jet.rptservice.api.exception.JRScheduleException

Gets the crosstab CTHdDbFileld instance name.

Parameters:

rptSetId - the report set id.

rptName - the report name.

comName - the component name.

Returns:

the crosstab CTHdDbFileld instance name.
If the component is not a crosstab, or the crosstab has no CTHdDbFileld, return null.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getDetailReportDataSourceNames

String[] getDetailReportDataSourceNames(String sessionId,
                                        String rptSetId,
                                        String rptName,
                                        String dsid)

Gets the data sources' names which are used in the detail report. The report is defined by the "Link" property of the field.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

dsid - ID of the result object.

Returns:

the data sources' names.

getDisplayNameByInstName

String getDisplayNameByInstName(String rptSetId,
                                String rptName,
                                String subRptKey,
                                String compName)
                         throws jet.rptservice.api.exception.JRScheduleException

Gets the display name by the instance name.

Parameters:

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component instance name.

Returns:

the display name.
If the display name is not defined or "", will be instance name.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getLinkPathInfo

List getLinkPathInfo(String sessionId,
                     String rptSetId,
                     String rptName)

Gets the report link path information.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

Returns:

the report link path information.

setDisplayPattern

void setDisplayPattern(int sqlType,
                       String pattern,
                       Locale locale)

Sets the display pattern of the specified sql type column.
Such as the total in database is 1234567.89, but user wants to see 1,234,567.89.
Then user should setDisplayPattern(SQL_FLOAT, "#,###,###.##", China);

Parameters:

sqlType - the SQL type which defined in java.sql.Types.

pattern - the display pattern.

locale - the locale information.

getDisplayPattern

String getDisplayPattern(int sqlType,
                         Locale locale)

Gets the display pattern of the specified sql type column.

Parameters:

sqlType - the SQL type which defined in java.sql.Types.

locale - the locale information.

Returns:

the display pattern.

setInputPattern

void setInputPattern(int sqlType,
                     String pattern,
                     Locale locale)

Sets the input pattern of the specified sql type column.
Such as the total in database is 1234567.89, but user wants to input 1,234,567.89.
Then user should setInputPattern(SQL_FLOAT, "#,###,###.##", China);

Parameters:

sqlType - the SQL type which defined in java.sql.Types.

pattern - the input pattern.

locale - the locale information.

getInputPattern

String getInputPattern(int sqlType,
                       Locale locale)

Gets the input pattern of the specified sql type column.

Parameters:

sqlType - the SQL type which defined in java.sql.Types.

locale - the locale information.

Returns:

the input pattern.

setDisplayPattern

void setDisplayPattern(String userName,
                       int sqlType,
                       String pattern,
                       Locale locale)

Sets the display pattern of the specified sql type column with the specified user.
Such as the total in database is 1234567.89, but user wants to see 1,234,567.89.
Then user should setDisplayPattern("admin", SQL_FLOAT, "#,###,###.##", China);

Parameters:

userName - the user name.

sqlType - the SQL type which defined in java.sql.Types.

pattern - the display pattern.

locale - the locale information.

getDisplayPattern

String getDisplayPattern(String userName,
                         int sqlType,
                         Locale locale)

Gets the display pattern of the specified sql type column with the specified user.

Parameters:

userName - the user name.

sqlType - the SQL type which defined in java.sql.Types.

locale - the locale information.

Returns:

the display pattern.

setInputPattern

void setInputPattern(String userName,
                     int sqlType,
                     String pattern,
                     Locale locale)

Sets the input pattern of the specified sql type column with the specified user.
Such as the total in database is 1234567.89, but user wants to input 1,234,567.89.
Then user should setInputPattern("admin", SQL_FLOAT, "#,###,###.##", China);

Parameters:

userName - the user name.

sqlType - the SQL type which defined in java.sql.Types.

pattern - the input pattern.

locale - the locale information.

getInputPattern

String getInputPattern(String userName,
                       int sqlType,
                       Locale locale)

Gets the input pattern of the specified sql type column with the specified user.

Parameters:

userName - the user name.

sqlType - the SQL type which defined in java.sql.Types.

locale - the locale information.

Returns:

the input pattern.

setDisplayPattern

void setDisplayPattern(String sessionId,
                       String rptSetId,
                       String rptName,
                       String subRptKey,
                       String component,
                       String column,
                       String pattern,
                       Locale locale)
                throws jet.rptservice.api.exception.JRScheduleException

Sets the display pattern of the specified column.
Such as the total in database is 1234567.89, but user wants to see 1,234,567.89.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

component - the component name.

column - the column mapping name.

pattern - the display pattern.

locale - the locale information.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getDisplayPattern

String getDisplayPattern(String sessionId,
                         String rptSetId,
                         String rptName,
                         String subRptKey,
                         String component,
                         String column,
                         Locale locale)
                  throws jet.rptservice.api.exception.JRScheduleException

Gets the display pattern of the specified column.
Such as the total in database is 1234567.89, but user wants to see 1,234,567.89.
And the display pattern is defined in the related DBField in the report; or user sets.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

component - the component name.

column - the column mapping name.

locale - the locale information.

Returns:

the display pattern.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

setInputPattern

void setInputPattern(String sessionId,
                     String rptSetId,
                     String rptName,
                     String subRptKey,
                     String component,
                     String column,
                     String pattern,
                     Locale locale)
              throws jet.rptservice.api.exception.JRScheduleException

Sets the input pattern of the specified column.
Such as the total in database is 1234567.89, but user wants to input 1,234,567.89.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKeythe - key of the engine.

component - the component name.

column - the column mapping name.

pattern - the input pattern.

locale - the locale information.

Throws:

jet.rptservice.api.exception.JRScheduleException

getInputPattern

String getInputPattern(String sessionId,
                       String rptSetId,
                       String rptName,
                       String subRptKey,
                       String component,
                       String column,
                       Locale locale)
                throws jet.rptservice.api.exception.JRScheduleException

Gets the input pattern of the specified column.
Such as the total in database is 1234567.89, but user wants to input 1,234,567.89.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKeythe - key of the engine.

component - the component name.

column - the column mapping name.

locale - the locale information.

Returns:

the input pattern.

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException

getFilterableElement

String getFilterableElement(String sessionId,
                            String rptSetId,
                            String rptName,
                            String comName,
                            String bindcolumn,
                            String dsid)

Gets the filter select with the specified column name.
The bindcolumn is defined by the "Bind Column" property of the label.

An example of the method:

%serverhome%/public_html/dhtmljsp/actionjsp/filterable.jsp.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

comName - the component name.

bindcolumn - the column mapping name.

dsid - ID of the result object.

Returns:

HTML select which contains 10 of the column values, clear option, topN option, customized option, and more option.

getChartDefinitionInfo

Map getChartDefinitionInfo(String sessionId,
                           String rptSetId,
                           String rptName,
                           String subRptKey,
                           String comName)

Gets the chart definition information.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

Returns:

the chart definition information containing "dataSplitSize", "category", "series", "y1Datasets"(value is map), and "y2Datasets"(value is map).
If the component is not chart, returns the blank map.

getDataSetName

String getDataSetName(String sessionId,
                      String rptSetId,
                      String rptName,
                      String subRptKey,
                      String comName)
               throws Exception

Gets the dataset's name of the specified component.

Parameters:

sessionId - the user session id.

rptSetId - the report set id.

rptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

Returns:

the dataset's name.

Throws:

Exception.

Exception

getAllAvailableBLColNamesForRsd

String[] getAllAvailableBLColNamesForRsd(String RptSetId,
                                         String RptName,
                                         String engineKey,
                                         String dataSetName)
                                  throws Exception

Gets all available BLColumns' names when running DHTML result.

Parameters:

rptSetId - the report set id.

rptName - the report name.

engineKey - the key of the engine.

dataSetName - the dataSet name.

Returns:

all available BLColumns' names.

Throws:

Exception.

Exception

getDrillFilter

Vector<jet.web.dhtml.DHTMLDrillFilterInfo> getDrillFilter(String RptSetId,
                                                          String RptName,
                                                          String subRptKey,
                                                          String comName)
                                                   throws jet.rptservice.api.exception.JRScheduleException

Gets the component's drill filter.

Parameters:

RptSetId - the report set id.

RptName - the report name.

subRptKey - the key of the engine.

comName - the component name.

Returns:

Vector<@see jet.web.dhtml.DHTMLDrillFilterInfo>

Throws:

JRScheduleException.

jet.rptservice.api.exception.JRScheduleException