public class MultipliedDesigner extends Designer
API
.
Logi Report ReportSet and its objects are stored in a tree
structure. An instance of MultipliedDesigner
can
retrieve each object in the ReportSet by its handle. The handle
of an object is named by its qualified and unique instance name.
A ReportSet is composed of one or more reports (also called tab or sheet) that are designed for the same purpose, or related purposes. Report developers can design, maintain, run and schedule these reports together or separately. The reports in the same ReportSet can share the same parameters and DataSets which reduces the number of queries to the DBMS.
A dataset is the set of data built from the result of a query, and can optionally have filters applied to it. A dataset contains not only DBFields, but also all formulas, summaries, and parameters that use the DBFields. A dataset has a name, which by default is the name of the resource on which it is created. When you create a data component, you specify whether to create a new dataset for it or use an existing one.
Logi Report reports are usually composed of multiple components. Components in Logi Report can be classified as follows:
A label is an object that contains a string. It is typically a brief description used to identify a field or other value nearby.
An image is a digital representation of a picture. Logi Report supports the following image formats: .bmp, .gif, .jpg, and .png.
A table is composed of rows and columns, and each contains several cells. Tables give you great control over how to present data, including placing fields, grouping them, and sorting them. With such a structure a table is a good way to show any two-dimensional dataset.
A crosstab summarizes data and presents the summaries in a compact row and column format.
A chart organizes and graphically presents data in a way that makes it easy for end users to see comparisons, trends, and patterns in data. It represents the report data in a visually straightforward form. A chart is based on the chart platform. On the platform, the chart paper, the legend, and labels make up the chart. You can create a chart that contains only simple DBFields, or a complicated chart that contains DBFields, groups, summaries, and even formulas. Normally, DBFields, summaries, and formulas in a report are represented in a chart using chart data markers, and groups are used to produce category names and data series names. DBFields can also be used as category names.
A banded object is a component that can present grouped data and detailed data. A banded object is composed of several banded panels(sections) with which you can easily organize data fields and other elements.
A tabular is a component designed to lay out other components. Unlike a table component, which is used to display a dataset, a tabular is a set of cells that can each display a data component.
A report that is inserted into another report is referred to as the subreport. Subreports are inserted and managed just like a component in a primary report, but a subreport itself is created and managed just like a primary report. You can specify relationships between the primary report and the subreport as well as have Logi Report pass values to the primary report or the subreport. A primary report can have more than one subreport. They can be in the same ReportSet as the primary report or can be in different ReportSets.
Formula fields are calculated from DBFields, other formulas, summaries, parameters and constants, so they can present information that DBFields can not do.
A summary is a special kind of formula. A summary generates a count, average, sum, standard deviation or other aggregation of a set of data values. A summary may apply to a defined group of data or can be a dynamic summary able to summarize on any group.
A parameter in Logi Report is a variable whose value is determined at runtime. The runtime parameters help you dynamically control your report results when used as parameters in a query.
Drawing objects can only be inserted into banded objects. You can add arcs, ovals, boxes, round boxes and lines to your report.
Some components can be bound with a dataset or inherit data from the dataset of their parents. These components are table, chart, crosstab, and banded object, and they are also referred to as data containers or data components.
Depending on the location of the libraries you either need a Designer API License Key or a Server Designer API License Key. If you are using Designer libraries you need report.jar and JREngine.jar (Designer API License Key) If you are using Server libraries you need JRSRMI.jar (Server Designer API License Key)
The following is one example of the usage of the MultipliedDesigner
. The code:
MultipliedDesigner dr = null; try { String path = "C:\\LogiReport\\Designer\\Demo\\Reports\\TutorialReports"; String catName = "TutorialReports.cat"; DesignerUserInfo userInfo=new DesignerUserInfo("UID", "designer API license key"); dr = new MultipliedDesigner(path, catName,Designer.CAT,userInfo); MultipliedCatalogAPI cat = dr.getCatalogAPI(); ...... } finally { dr.exit(); } // To create a new ReportSet (Page Report) with a banded object using the above MultipliedDesigner (dr) // 1. Create ReportSet reportset = dr.createReportSet(name); // 2. Add Dataset dataset = dr.addDataset(reportset, queryname, dsname, null, Designer.DATASET_TYPE_QUERY); // 3. Create a report tab inside the ReportSet report = dr.addReport(reportset, name); // 4. Insert a PagePanel into the report tab page = dr.insertPage(report); // 5. Insert the data component you want to use such as a banded object banded = dr.insertBandedObject(reportbody, true, true, true); // 6. Bind the dataset to the reportbody and set inherit from parent for the banded object dr.bindDataSet(reportbody, queryname); dr.set(banded, "dataInherit", true); // 7. Get handles so that you can start adding objects to the report handles = dr.getHandles(banded, Designer.PAGE); ...... // 8. Add groups to the banded object page GroupInfo ginfo = new GroupInfo(dbfield,GroupInfo.DESCENDING); group = dr.insertSectionGroup(handles[0], ginfo); ..... // 9. Exit and save changes dr.exit();
Modifier and Type | Field and Description |
---|---|
static int |
USE_AS_AGG
Logi Report Dynamic Formula's usage type
|
static int |
USE_AS_DETAIL
Logi Report Dynamic Formula's usage type
|
static int |
USE_AS_GROUP
Logi Report Dynamic Formula's usage type
|
ARC, AREA_ARRAY_2D, AREA_ARRAY_3D, AREA_PERCENT_2D, AREA_PERCENT_3D, AREA_STACK_2D, AREA_STACK_3D, AREACHART, BANDEDOBJECT, BANDEDOBJECT_FOOTER, BANDEDOBJECT_HEADER, BANDEDOBJECT_PAGEFOOTER, BANDEDOBJECT_PAGEHEADER, BAR_ARRAY_3D, BAR_PERCENT_2D, BAR_PERCENT_3D, BAR_PERCENT_AREA_STACK_2D, BAR_PERCENT_LINE_ARRAY_2D, BAR_PERCENT_LINE_STACK_2D, BAR_SIDEBYSIDE_2D, BAR_SIDEBYSIDE_3D, BAR_SIDEBYSIDE_AREA_STACK_2D, BAR_SIDEBYSIDE_LINE_ARRAY_2D, BAR_SIDEBYSIDE_LINE_STACK_2D, BAR_STACK_2D, BAR_STACK_3D, BAR_STACK_AREA_STACK_2D, BAR_STACK_LINE_ARRAY_2D, BAR_STACK_LINE_STACK_2D, BARCHART, BARCODEFIELD, BENCH_ARRAY_3D, BENCH_PERCENT_2D, BENCH_PERCENT_3D, BENCH_SIDEBYSIDE_2D, BENCH_SIDEBYSIDE_3D, BENCH_STACK_2D, BENCH_STACK_3D, BENCHARRAYCHART, BENCHCHART, BOX, BUBBLE_2D, CENTERBOTTOM, CENTERCENTER, CENTERTOP, CHART2DCOORDINATEPAPER, CHARTCOORDINATEPAPER, CHARTLABEL, CHARTLEGEND, CHARTPLATFORM, CODABAR, CODE_128, CODE_39, COLUMN, COMPUTEDCOLUMN, CROSSTAB, CTAGGFIELD, CTAGGINFO, CTDBFIELD, CTHDDBFIELD, CTHDTEXTFIELD, DATAOBJECT, DATASET, DATASET_TYPE_HDS, DATASET_TYPE_ONDEMAND, DATASET_TYPE_QUERY, DBFIELD, DETAIL, DIRECTION_BACKSIDE, DIRECTION_FORESIDE, DYNAMIC_AGGREGATION, DYNAMIC_FORMULA, EAN_13, EAN_8, FETCHDATE, FETCHTIME, FIELD_CATALOGPATH_ONDISK, FIELD_CATALOGPATH_ONSERVER, FIELD_REPORTPATH_ONDISK, FIELD_REPORTPATH_ONSERVER, FORMULA, GAUGE_BALLS_2D, GAUGE_BARS_2D, GAUGE_DIALS_2D, GROUP, GROUPFOOTER, GROUPHEADER, GROUPNAME, GROUPNUMBER, GROUPNUMBERS, IMAGE, JBROWSER, JHYPERLINK, JUSTIFYBOTTOM, JUSTIFYCENTER, JUSTIFYTOP, LABEL, LC, LC_BODY, LC_CONTENT, LC_REFRESHOBJECT, LEFT, LEFT_UNDERSIDE_POINT, LEFT_UPSIDE_POINT, LEFTBOTTOM, LEFTCENTER, LEFTTOP, LINE, LINE_ARRAY_2D, LINE_ARRAY_3D, LINE_ARRAY_LINE_ARRAY_2D, LINE_PERCENT_2D, LINE_STACK_2D, LINECHART, MEDIAFIELD, MODIFIEDDATE, MODIFIEDTIME, MULTI_VALUE_BOX, NEWSTYLETABLE, OVAL, PAGE, PAGEBREAK, PAGEEND, PAGEFOOTER, PAGEHEADER, PAGENOFM, PAGENUMBER, PAGENUMBERS, PAGESTART, PARAGRAPH, PARALLELDETAIL, PARAMETER, PIE_SIDEBYSIDE_2D, PIE_SIDEBYSIDE_3D, PIECHART, PRINTDATE, PRINTTIME, RADAR_2D, RECORDNUMBER, RENDER_BARCODE, RENDER_BUTTON, RENDER_CHECKBOX, RENDER_DROPDOWNLIST, RENDER_IMAGE, RENDER_IMAGEBUTTON, RENDER_LIST, RENDER_RADIOBTN, RENDER_RANK, RENDER_RESETBUTTON, RENDER_SUBMITBUTTON, RENDER_TEXT, RENDER_TEXTAREA, RENDER_TEXTFIELD, REPORT, REPORTBODY, REPORTFOOTER, REPORTHEADER, REPORTSET, REPORTSHEET, RIGHT, RIGHT_UNDERSIDE_POINT, RIGHT_UPSIDE_POINT, RIGHTBOTTOM, RIGHTCENTER, RIGHTTOP, ROUNDBOX, RPTDATASOURCE, SCATTER_POINTS_2D, SCATTER_SMOOTH_LINES_2D, SCATTER_STRAIGHT_LINES_2D, SHAPE, SIDEBYSIDEBARCHART, SQLSTATMENT, STACKEDBARCHART, STACKEDBENCH, STOCK_HIGH_LOW_2D, STOCK_HIGH_LOW_CLOSE_2D, STOCK_OPEN_HIGH_LOW_CLOSE_2D, SUBLINK, SUBPARAMLINK, SUBREPORT, SUBRETVALUE, SUMMARY, SURFACE_3D, SYSTEM_FIELD_FILTER, SYSTEM_FIELD_GLOBAL_PAGE_N_OF_M, SYSTEM_FIELD_GLOBAL_PAGE_NUM, SYSTEM_FIELD_GLOBAL_TOTAL_PAGE_NUM, SYSTEM_FIELD_GOTOFILTER, SYSTEM_FIELD_ONSCREENFILTER, SYSTEM_FIELD_QUERYFILTER, SYSTEM_FIELD_TASK_ID, SYSTEM_FIELD_TOTAL_FETCHED_RECORDS, SYSTEM_FIELD_TOTAL_RECORDS, TABLE, TABLE_COMMONCOLUMN, TABLE_DETAILCOLUMN, TABLE_DETAILSECTION, TABLE_FOOTERSECTION, TABLE_GROUP, TABLE_GROUP_FOOTERSECTION, TABLE_GROUP_HEADERSECTION, TABLE_GROUPCOLUMN, TABLE_HEADERSECTION, TABLE_SUMMARYCOLUMN, TABLECELL, TABULAR, TABULARCELL, TEXT, TEXTBOX, UDO, UPC_A, UPC_E, USERNAME, ZORDER_BACKWARD, ZORDER_BOTTOM, ZORDER_FORWARD, ZORDER_TOP
Constructor and Description |
---|
MultipliedDesigner(java.lang.String path,
java.lang.String name,
java.lang.String suffix,
DesignerUserInfo user)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addDynamicAggregation(java.lang.String reportHandle,
java.lang.String datasetHandle,
java.lang.String aggregationName,
java.lang.String basedFieldName,
java.lang.String function)
Adds a Dynamic Aggregation into the report.
|
java.lang.String |
addDynamicFormula(java.lang.String reportHandle,
java.lang.String datasetHandle,
java.lang.String formulaName,
java.lang.String expression,
int useType,
boolean isRawExpression)
Adds a dynamic formula into the report.
|
java.lang.String |
changeChartType(java.lang.String chartHandle,
int chartType) |
java.lang.String |
changeChartType(java.lang.String chartHandle,
int oldChartType,
int newChartType,
boolean relyAxisY2)
Set chart type
|
void |
clearBrowserFilter(java.lang.String dataContainerHandle)
Removes Report Browser filters from the specified DataContainer.
|
void |
clearDataContainerFilter(java.lang.String dataContainerHandle)
Removes Report filters from the specified DataContainer.
|
void |
clearDatasetFilter(java.lang.String datasetHandle)
Removes Report filters from the specified Dataset.
|
java.util.List<java.lang.String> |
compileDynamicFormulas(java.lang.String objHandle)
Compiles the Dynamic Formulas that are related to the specified object.
|
java.lang.String |
createUnifyReportSet(java.lang.String reportsetName,
java.lang.String reportTabName)
Creates a new unify reportset object.
|
java.lang.String |
createWebReportSet(java.lang.String reportsetName,
java.lang.String reportTabName)
Creates a new web report object.
|
boolean |
delete(java.lang.String handle)
Deletes an object from its parent node.
|
boolean |
deleteCrossTabAggregations(java.lang.String crossTab,
int columnDepth,
int rowDepth,
int[] index)
Deletes aggregations from a crosstab.
|
java.util.List<java.lang.String> |
getAvailableDynamicFormulas(java.lang.String handle)
Gets all available Dynamic Formulas for the specified object.
|
java.util.List<java.lang.String> |
getAvailableDynamicFormulas(java.lang.String handle,
java.lang.String propertyName)
Gets all available Dynamic Formulas that can be used to control an object's property values at runtime.
|
ExpressionNode |
getBrowserFilter(java.lang.String dataContainerHandle)
Gets a Logi Report Browser filter from the specified DataContainer.
|
MultipliedCatalogAPI |
getCatalogAPI()
Gets a MultipliedCatalogAPI instance with the specified catalog.
|
ChartDefinitionInfo |
getChartInfo(java.lang.String chartHandle) |
ExpressionNode |
getDataContainerFilter(java.lang.String dataContainerHandle)
Gets a Logi Report filter from the specified DataContainer.
|
ExpressionNode |
getDatasetFilter(java.lang.String datasetHandle)
Gets a Logi Report filter from the specified Dataset.
|
java.util.List<java.lang.String> |
getDynamicAggregationHandles(java.lang.String reportHandle,
java.lang.String datasetHandle)
Gets all Dynamic Aggregations defined for the specified report and dataset.
|
BVAggregationInfo |
getDynamicAggregationInfo(java.lang.String aggHandle)
Gets the Dynamic Aggregation information.
|
java.util.List<java.lang.String> |
getDynamicAggregationNames(java.lang.String reportHandle,
java.lang.String datasetHandle)
Gets all Dynamic Aggregations defined for the specified report and dataset.
|
java.util.List<java.lang.String> |
getDynamicFormulaHandles(java.lang.String reportHandle,
java.lang.String datasetHandle)
Gets all Dynamic Formulas defined for the specified report and dataset.
|
FormulaInfo |
getDynamicFormulaInfo(java.lang.String fmlHandle)
Gets the Dynamic Formula's information.
|
java.util.List<java.lang.String> |
getDynamicFormulaNames(java.lang.String reportHandle,
java.lang.String datasetHandle)
Gets all Dynamic Formulas defined for the specified report and dataset.
|
LCEditor |
getLCEditor()
Gets a Library Component(LC) editor.
|
java.lang.String |
insertChart(java.lang.String parent,
ChartInfo info,
int modeType)
Inserts a chart into a report.
|
java.lang.String |
InsertChartValue(java.lang.String chartHandle,
java.lang.String resourceName)
Insert chart value
|
java.lang.String |
insertCrossTab(java.lang.String parent,
CrossTabInfo info,
int modeType)
Inserts a crosstab into the report and set the properties in specified mode.
|
java.lang.String |
insertCrossTabAggregations(java.lang.String crossTab,
CTAggFieldInfo[] infos,
int columnDepth,
int rowDepth,
int index,
int mode)
Inserts aggregations into a crosstab
|
java.lang.String |
insertCrossTabColumns(java.lang.String crossTab,
CTRowColFieldInfo[] infos,
int index,
int mode)
Inserts columns into a crosstab and set the properties in specified mode.
|
java.lang.String |
insertCrossTabRows(java.lang.String crossTab,
CTRowColFieldInfo[] infos,
int index,
int mode)
Inserts rows into a crosstab and set the properties in specified mode.
|
boolean |
isPropertyControlledByOther(java.lang.String handle,
java.lang.String propertyName)
Indicates whether or not the specified property value is controlled by the runtime value.
|
boolean |
isUnifiedTemplate(java.lang.String objHandle)
Check whether the object is an unified template reportset or if it is in a unified template reportset or not.
|
boolean |
modifyDynamicAggregation(java.lang.String aggHandle,
BVAggregationInfo aggInfo)
Changes the information of a Dynamic Aggregation.
|
boolean |
modifyDynamicFormula(java.lang.String formulaHandle,
FormulaInfo formulaInfo,
int useType,
boolean isRawExpression)
Sets the Dynamic Formula's information.
|
java.lang.String |
removeChartValues(java.lang.String chartHandle)
Remove chart values
|
java.lang.String |
rotateChart(java.lang.String chartHandle)
rotate chart
|
boolean |
setBrowserFilter(java.lang.String dataContainerHandle,
ExpressionNode filterInfo)
Applys a Logi Report Browser filter to the data container.
|
java.lang.String |
setChartCategory(java.lang.String chartHandle,
java.lang.String resourceName)
Set chart category
|
java.lang.String |
setChartSeries(java.lang.String chartHandle,
java.lang.String resourceName)
Set chart series
|
java.lang.String |
setChartValuesOrder(java.lang.String chartHandle,
int fromIndex,
int toIndex)
Set chart values order
|
boolean |
setControlledByDynamicFormula(java.lang.String handle,
java.lang.String propertyName,
java.lang.String fmlDisplayName)
Sets the Dynamic Formula to control the property value at runtime.
|
boolean |
setControlledByExpression(java.lang.String handle,
java.lang.String propertyName,
java.lang.String expression)
Sets the expression to control the property value at runtime.
|
boolean |
setCTAggFieldHeight(java.lang.String crossTab,
int yDepth,
int index,
double height,
int mode)
Sets the specified aggregation's height in a crosstab.
|
boolean |
setCTAggFieldWidth(java.lang.String crossTab,
int xDepth,
int index,
double width,
int mode)
Sets the specified aggregation's width in a crosstab.
|
boolean |
setCTAggTitleHeight(java.lang.String crossTab,
int index,
double height,
int mode)
sets the height of a crosstab aggregation's title
|
boolean |
setCTAggTitleWidth(java.lang.String crossTab,
int index,
double width,
int mode)
sets the width of a crosstab aggregation's title
|
boolean |
setCTColHeaderHeight(java.lang.String crossTab,
int index,
double height,
int mode)
Sets the specified column header's cell height of a crosstab.
|
boolean |
setCTRowHeaderWidth(java.lang.String crossTab,
int index,
double width,
int mode)
Sets the specified row header's cell width of crosstab.
|
boolean |
setDataContainerFilter(java.lang.String dataContainerHandle,
ExpressionNode filterInfo)
Applys a Logi Report filter to the data container.
|
boolean |
setDatasetFilter(java.lang.String datasetHandle,
ExpressionNode filterInfo)
Applys a Logi Report filter to the Dataset.
|
boolean |
setLabelBelongTo(java.lang.String dbFieldHandle,
java.lang.String labelHandle)
Sets the bind relation between data field and label.
|
addDataset, addDisplayName, addDisplayName, addReport, appendTabularColumn, appendTabularRow, bindDataSet, canDeleted, canMergeTableCell, canMergeTabularCell, changeTabularCellHeight, changeTabularCellWidth, changeTabularHeight, changeTabularWidth, changeZOrder, close, closeReportSet, create, create, createReportSet, deleteBandedObject, deleteCrossTabAggregations, deleteCrossTabColumns, deleteCrossTabRows, deleteDetailPanel, deleteGroup, deletePage, deletePageController, deleteReport, deleteReport, deleteReportFile, deleteSectionFooterPanel, deleteSectionHeaderPanel, deleteTableColumns, deleteTabularColumn, deleteTabularRow, exit, exitAndSave, getAllDisplayNames, getAllResourceNames, getCatalogName, getChangedByFields, getChartLabel, getControlField, getControlFields, getDatasetBLFilter, getDataSetInfo, getDataSetInfos, getDBFields, getDisplayName, getFormats, getFormulae, getFormulas, getGeometries, getGeometries, getGroupInfo, getGroupNames, getGroups, getIndex, getKey, getMinSectionHeight, getObjectInfo, getObjectType, getParameter, getParent, getProcedures, getProcedures, getQueries, getQueries, getQueryName, getReporthome, getReportSortInfo, getSections, getSections, getSections, getSortInfo, getSQLs, getSQLs, getSummaries, getTableColumnHandle, getTableColumnIndex, getTableWidth, getTabularCell, getTabularColumnCells, getTabularRowCells, getUDS, getUDS, getUID, getUserID, getViews, hasPageSecurity, hideTableColumn, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insertBandedObject, insertChart, insertColumn, insertCrossTab, insertCrossTabAggregations, insertCrossTabColumns, insertCrossTabRows, insertDetailPanel, insertField, insertPage, insertPageBreak, insertPageStartEnd, insertSectionFooterPanel, insertSectionGroup, insertSectionHeaderPanel, insertSectionPanel, insertShape, insertSubReport, insertTable, insertTable, insertTableColumn, insertTableColumn, insertTableGroup, insertTabular, mergeTableCells, mergeTabularCells, moveCrossTabAggregations, moveCrossTabColumns, moveCrossTabRows, moveTableColumns, open, pivotCrossTab, pivotTable, quit, quit, removeDisplayName, removeTableGroup, resizeTable, resizeTabular, saveAs, saveSelfContainedReport, saveSelfReport, set, set, set, set, set, set, set, setControlFields, setCTAggFieldHeight, setCTAggFieldWidth, setCTAggTitleHeight, setCTAggTitleWidth, setCTColHeaderHeight, setCTRowHeaderWidth, setDataset, setDatasetBLFilter, setDefaultFormat, setPageWidth, setReporthome, setReportSortInfo, setSortInfo, setStyle, setStyle, setTableColumnWidth, setUserInfo, showTableColumn, splitTabularCell, updateDisplayName
clearError, clearMsg, clearWarning, closeLog, containPropName, getBool, getChildren, getColor, getDouble, getError, getFloat, getHandles, getHandles, getHandles, getHandles, getInstanceName, getInt, getLong, getPoint, getPropNames, getPropType, getQualifyName, getString, getStringArray, getUnit, getWarning, setLog, setLog, setLog, setPoint, setReference, setUnit, writeLog, writeLog
public static final int USE_AS_DETAIL
public static final int USE_AS_GROUP
public static final int USE_AS_AGG
public MultipliedDesigner(java.lang.String path, java.lang.String name, java.lang.String suffix, DesignerUserInfo user) throws ReadFailureException, UniverseFileException
path
- Indicates the path of the catalog file.name
- Indicates the name of the catalog file.user
- The DesignerUserInfo includes the product license of Design API.suffix
- Indicates the suffix of the catalog file. Design API can save a catalog
in binary or XML format. The suffix can be XMLCAT
or
CAT
.ReadFailureException
UniverseFileException
public MultipliedCatalogAPI getCatalogAPI()
getCatalogAPI
in class Designer
getError()
to check the error message.public java.lang.String createWebReportSet(java.lang.String reportsetName, java.lang.String reportTabName) throws DesignerErrorException
reportsetName
- indicates the reportset's name ended with web report file suffix, see API.WEBRPT
.reportTabName
- indicates the report tab's name.null
if the object failed to be inserted. Use API.getError()
to get the reason for the failure.DesignerErrorException
public java.lang.String createUnifyReportSet(java.lang.String reportsetName, java.lang.String reportTabName) throws DesignerErrorException
reportsetName
- indicates the reportset's name ended with unify report file suffix, see API.UNIFYRPT
.reportTabName
- indicates the report tab's name.null
if the object failed to be inserted. Use API.getError()
to get the reason for the failure.DesignerErrorException
public boolean isUnifiedTemplate(java.lang.String objHandle)
objHandle
- public java.lang.String insertChart(java.lang.String parent, ChartInfo info, int modeType) throws DesignerErrorException
parent
- the handle of the object in which the chart to be inserted.info
- The class defines the information of the chart.null if the object fails to be inserted and use API.getError()
to get the reason.
DesignerErrorException
public ChartDefinitionInfo getChartInfo(java.lang.String chartHandle)
public java.lang.String setChartCategory(java.lang.String chartHandle, java.lang.String resourceName)
chartHandle
- Indicates the handle of the chart to operationresourceName
- resource name to add to the chart categorynull
if the object failed to be set. Use API.getError()
to get the reason for the failure.public java.lang.String setChartSeries(java.lang.String chartHandle, java.lang.String resourceName)
chartHandle
- Indicates the handle of the chart to operationresourceName
- resource name to add to the chart seriesnull
if the object failed to be set. Use API.getError()
to get the reason for the failure.public java.lang.String InsertChartValue(java.lang.String chartHandle, java.lang.String resourceName)
chartHandle
- Indicates the handle of the chart to operationresourceName
- resource name to insert to the chart valuenull
if the object failed to be set. Use API.getError()
to get the reason for the failure.public java.lang.String setChartValuesOrder(java.lang.String chartHandle, int fromIndex, int toIndex)
chartHandle
- Indicates the handle of the chart to operationfromIndex
- original value indextoIndex
- destination value indexnull
if the object failed to be set. Use API.getError()
to get the reason for the failure.public java.lang.String removeChartValues(java.lang.String chartHandle)
chartHandle
- Indicates the handle of the chart to operationnull
if the object failed to be set. Use API.getError()
to get the reason for the failure.public java.lang.String rotateChart(java.lang.String chartHandle)
chartHandle
- Indicates the handle of the chart to operationnull
if the object failed to be set. Use API.getError()
to get the reason for the failure.public java.lang.String changeChartType(java.lang.String chartHandle, int oldChartType, int newChartType, boolean relyAxisY2)
chartHandle
- Indicates the handle of the chart to operationoldChartType
- old chart typenewChartType
- new chart typerelyAxisY2
- ischartType
- chart typenull
if the object failed to be set. Use API.getError()
to get the reason for the failure.public java.lang.String changeChartType(java.lang.String chartHandle, int chartType)
public java.lang.String insertCrossTab(java.lang.String parent, CrossTabInfo info, int modeType) throws DesignerErrorException
parent
- the handle of the object in which the crosstab to be inserted.info
- the Class defines a crosstab's information, such as its data, columns, rows, aggregations and also their properties.null
if the object failed to be inserted. Use API.getError()
to get the reason for the failure.DesignerErrorException
public java.lang.String insertCrossTabColumns(java.lang.String crossTab, CTRowColFieldInfo[] infos, int index, int mode) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab in which the columns to be inserted.infos
- The class defines the crosstab column's information, including the field mapping name and the properties.index
- All columns of the crosstab can be defined as a set of groups in the crosstab. The index is defined as the index of all
these groups, it starts from 0;null
if the object failed to be inserted. Use API.getError()
to get the reason for the failure.DesignerErrorException
public java.lang.String insertCrossTabRows(java.lang.String crossTab, CTRowColFieldInfo[] infos, int index, int mode) throws DesignerErrorException
crossTab
- the handle of the crosstab.infos
- The class defines the crosstab row's information, including the field mapping name and the properties.index
- All rows of the crosstab can be defined as a set of groups in the crosstab. The index is defined as the index of all
these groups, it starts from 0;null
if the object failed to be inserted. Use API.getError()
to get the reason for the failure.DesignerErrorException
public java.lang.String insertCrossTabAggregations(java.lang.String crossTab, CTAggFieldInfo[] infos, int columnDepth, int rowDepth, int index, int mode) throws DesignerErrorException
crossTab
- the handle of the crosstab and set the properties in specified mode.infos
- The class defines the crosstab aggregation's information, including the field mapping name, the function and the properties.columnDepth
- Indicates the group depth in column direction. It starts from 0.rowDepth
- Indicates the group depth in row direction. It starts from 0.index
- Inserts aggregations at the specified index. The index starts from 0.null
if the object failed to be inserted. Use API.getError()
to get the reason for the failure.DesignerErrorException
public boolean deleteCrossTabAggregations(java.lang.String crossTab, int columnDepth, int rowDepth, int[] index) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab.columnDepth
- Indicates the group depth in column direction. It starts from 0.rowDepth
- Indicates the group depth in row direction. It starts from 0.index
- indicates the indexes of the aggregations to be removed. The index starts from 0.true
if the aggregations are deleted successfully; false
otherwise.DesignerErrorException
public boolean setCTAggFieldHeight(java.lang.String crossTab, int yDepth, int index, double height, int mode) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab.yDepth
- indicates the index of the row on which the aggregation depends.
The yDepth starts from 0. The level 0 is the area of the column subtoal or the grand toatl;
the level 1 responds to the first element of the rows.index
- indicates the aggregation index in a crosstab's summary cell.
If the aggregations in one summary cell are wrapped into several lines,
specifies the horizontal line to be set. The index starts from 0.height
- Indicates the aggregation field's height value.
The unit of the value is set by API.setUnit(int)
, and the default is API.INCH
true
if the height is set successfully; false
otherwise.DesignerErrorException
public boolean setCTAggFieldWidth(java.lang.String crossTab, int xDepth, int index, double width, int mode) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab.xDepth
- indicates the index of the column on which the aggregation depends.
The xDepth starts from 0. The level 0 is the area of the row subtoal or the grand toatl;
the level 1 responds to the first element of the columns.index
- indicates the aggregation index in a crosstab's summary cell.
If the aggregations in one summary cell are wrapped into several lines,
specifies the vetical line to be set. The index starts from 0.height
- Indicates the aggregation field's height value.
The unit of the value is set by API.setUnit(int)
, and the default is API.INCH
true
if the width is set successfully; false
otherwise.DesignerErrorException
public boolean setCTAggTitleHeight(java.lang.String crossTab, int index, double height, int mode) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab.index
- indicates the index of the title to be settrue
if successful; false
otherwise.DesignerErrorException
public boolean setCTAggTitleWidth(java.lang.String crossTab, int index, double width, int mode) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab.index
- indicates the index of the title to be settrue
if successful; false
otherwise.DesignerErrorException
public boolean setCTColHeaderHeight(java.lang.String crossTab, int index, double height, int mode) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab.index
- indicates the index of the column to be set.height
- Indicates the height value of the specified column header's cell.
The unit of the value is set by API.setUnit(int)
, and the default is API.INCH
true
if successful; false
otherwise.DesignerErrorException
public boolean setCTRowHeaderWidth(java.lang.String crossTab, int index, double width, int mode) throws DesignerErrorException
crossTab
- Indicates the handle of the crosstab.index
- indicates the index of the row to be set.width
- Indicates the width value of the specified row header's cell.
The unit of the value is set by API.setUnit(int)
, and the default is API.INCH
true
if successful; false
otherwise.DesignerErrorException
public LCEditor getLCEditor()
public boolean setLabelBelongTo(java.lang.String dbFieldHandle, java.lang.String labelHandle) throws DesignerErrorException
dbFieldHandle
- the handle of data field.labelHandle
- the handle of label.true
if set the relation successfully, other wise return false
.DesignerErrorException
public boolean setControlledByExpression(java.lang.String handle, java.lang.String propertyName, java.lang.String expression)
handle
- The handle of the selected object.propertyName
- The property name.expression
- The expression statement.true
if it is set successfully; otherwise returns false
.public java.util.List<java.lang.String> getAvailableDynamicFormulas(java.lang.String handle)
handle
- The handle of the object.public java.util.List<java.lang.String> getDynamicFormulaNames(java.lang.String reportHandle, java.lang.String datasetHandle)
reportHandle
- The handle of the report.datasetHandle
- The handle of the dataset.
.public java.util.List<java.lang.String> getDynamicFormulaHandles(java.lang.String reportHandle, java.lang.String datasetHandle)
reportHandle
- The handle of the report.datasetHandle
- The handle of the dataset.
.public java.util.List<java.lang.String> getDynamicAggregationNames(java.lang.String reportHandle, java.lang.String datasetHandle)
reportHandle
- The handle of the report.datasetHandle
- The handle of the dataset.public java.util.List<java.lang.String> getDynamicAggregationHandles(java.lang.String reportHandle, java.lang.String datasetHandle)
reportHandle
- The handle of the report.datasetHandle
- The handle of the dataset.public java.util.List<java.lang.String> getAvailableDynamicFormulas(java.lang.String handle, java.lang.String propertyName)
handle
- The handle of the object.propertyName
- The name of the property.public boolean setControlledByDynamicFormula(java.lang.String handle, java.lang.String propertyName, java.lang.String fmlDisplayName)
handle
- The handle of the selected object.propertyName
- The property name.fmlDisplayName
- The display name of the dynamic formula.true
if it is set successfully; otherwise returns false
.public boolean isPropertyControlledByOther(java.lang.String handle, java.lang.String propertyName)
handle
- The handle of the selected object.propertyName
- The property name.true
if the specified property value is controlled by the runtime value; otherwise returns false
.public java.lang.String addDynamicAggregation(java.lang.String reportHandle, java.lang.String datasetHandle, java.lang.String aggregationName, java.lang.String basedFieldName, java.lang.String function) throws DisplayNameAlreadyExistsException
reportHandle
- Indicates the handle of the report.datasetHandle
- Indicates the handle of the dataset.aggregationName
- Indicates the display name of the aggregation.basedFieldName
- Indicates the qualified display name of the related field.function
- Indicates the function name of the aggregation.null
value will be returned.DisplayNameAlreadyExistsException
public BVAggregationInfo getDynamicAggregationInfo(java.lang.String aggHandle)
aggHandle
- The handle of the Aggregation.public java.lang.String addDynamicFormula(java.lang.String reportHandle, java.lang.String datasetHandle, java.lang.String formulaName, java.lang.String expression, int useType, boolean isRawExpression) throws DesignerErrorException
formulaName
- Indicates the display name of the formula.reportHandle
- Indicates the handle of the report.datasetHandle
- Indicates the handle of the dataset.expression
- Indicates the expression and function in String format.useType
- Indicates the element type that the formula will be used as.
You can specify to use the formula as a detail, group, or an aggregation object. Whether a dynamic formula can be used as a certain type depends on the following rules:
USE_AS_DETAIL
, any formula can be used as Detail.
USE_AS_GROUP
, any formula that references a DBField and not an aggregation can be used as Group.
USE_AS_AGG
, a formula that refers only to aggregations can be used as Aggregation.
For example, there are two aggregations Sum_Total and Sum_Quantity, and you can create a formula @"Sum_Total" / @"Sum_Quantity" and use it as an aggregation.
isRawExpression
- Specifies whether to create an uncompiled formula or not. If it is false
, the formula expression will be compiled and a javac thread will be started.
Notes:
"~", "`", "!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "-", "+", "=", "{", "}", "[", "]", "|", "\\", ":", ";", "\", " ' ", "<", ",", ">", ".", "?", "/"
Examples:
null
value will be returned.DesignerErrorException
public FormulaInfo getDynamicFormulaInfo(java.lang.String fmlHandle)
fmlHandle
- Indicates the handle of the Dynamic Formula. The handle is the unique ID of the object in the report.public boolean modifyDynamicFormula(java.lang.String formulaHandle, FormulaInfo formulaInfo, int useType, boolean isRawExpression) throws DesignerErrorException
formulaHandle
- Indicates the handle of the formula. The handle is the unique ID of the object in the report.formulaInfo
- Indicates the new formula's information.useType
- Indicates the element type that the formula will be used as.USE_AS_DETAIL
, any formula can be used as Detail.
USE_AS_GROUP
, any formula that references a DBField and not an aggregation can be used as Group.
USE_AS_AGG
, a formula that refers only to aggregations can be used as Aggregation.
For example, there are two aggregations Sum_Total and Sum_Quantity, and you can create a formula @"Sum_Total" / @"Sum_Quantity" and use it as an aggregation.
isRawExpression
- Specifies whether to create an uncompiled formula or not. If it is false
, the formula expression will be compiled and a javac thread will be started.
Notes:
"~", "`", "!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "-", "+", "=", "{", "}", "[", "]", "|", "\\", ":", ";", "\", " ' ", "<", ",", ">", ".", "?", "/"
Examples:
true
if it is changed successfully; false
otherwise.DesignerErrorException
public boolean modifyDynamicAggregation(java.lang.String aggHandle, BVAggregationInfo aggInfo) throws DesignerErrorException
aggHandle
- The handle of the Aggregation.aggInfo
- The new information of Aggregation.true
if it changes the Aggregation's definition successfully; otherwise returns false
.DesignerErrorException
public boolean delete(java.lang.String handle)
delete
in class Designer
handle
- handle of the object to be deleted.true
if the object is removed from its parent node successfully;
false
Otherwise.or getWarning() to get the reason if the object failed to be deleted.
public java.util.List<java.lang.String> compileDynamicFormulas(java.lang.String objHandle)
objHandle
- The handle of the specified object.
If the object is a report, it will compile all of the Dynamic Formulas in the report.public boolean setDataContainerFilter(java.lang.String dataContainerHandle, ExpressionNode filterInfo) throws DesignerErrorException
dataContainerHandle
- Indicates the handler string of the existing data container.filterInfo
- The class defines the Filter.DesignerErrorException
public ExpressionNode getDataContainerFilter(java.lang.String dataContainerHandle) throws DesignerErrorException
dataContainerHandle
- Indicates the handler string of the existing DataContainer.DesignerErrorException
public void clearDataContainerFilter(java.lang.String dataContainerHandle) throws DesignerErrorException
dataContainerHandle
- Indicates the handler string of the existing DataContainer.DesignerErrorException
public boolean setBrowserFilter(java.lang.String dataContainerHandle, ExpressionNode filterInfo) throws DesignerErrorException
dataContainerHandle
- Indicates the handler string of the existing data container.filterInfo
- The class defines the Filter.DesignerErrorException
public ExpressionNode getBrowserFilter(java.lang.String dataContainerHandle) throws DesignerErrorException
dataContainerHandle
- Indicates the handler string of the existing DataContainer.DesignerErrorException
public void clearBrowserFilter(java.lang.String dataContainerHandle) throws DesignerErrorException
dataContainerHandle
- Indicates the handler string of the existing DataContainer.DesignerErrorException
public boolean setDatasetFilter(java.lang.String datasetHandle, ExpressionNode filterInfo) throws DesignerErrorException
datasetHandle
- Indicates the handler string of the existing Data set.filterInfo
- The class defines the Filter.DesignerErrorException
public ExpressionNode getDatasetFilter(java.lang.String datasetHandle) throws DesignerErrorException
datasetHandle
- Indicates the handler string of the existing Dataset.DesignerErrorException
public void clearDatasetFilter(java.lang.String datasetHandle) throws DesignerErrorException
datasetHandle
- Indicates the handler string of the existing Dataset.DesignerErrorException