com.mindoo.remote.api.symphony.spreadsheet
Interface IRemoteDataPilotTable

public interface IRemoteDataPilotTable

This class represents a DataPilot table reports on a sheet.

Creation and access

• To create a DataPilot table, use the Add method in the DataPilotTables class and dataPilotTableWizard method in the Sheet class.
• To get a DataPilot table of a sheet, use the Item method in DataPilotTables.

Usage

Datapilot table is a reporting tool that sorts and sums independent of the original data layout in the spreadsheet, it provides access to row fields (used as row), column fields (used as column), data fields (used as data), and hidden fields.

To add fields in the DataPilot table, use addFields method.

Method Summary

void	addFields(java.lang.String[] rowfields, java.lang.String[] colfields, java.lang.String[] datafields, java.lang.String[] pageFields, int function) This method adds row fields, column fields, page fields and data fields in a DataPilot table.
IRemoteSymphonyApplication	getApplication() This property represents the Lotus Symphony application.
IRemoteDataPilotFields	getColumnFields() This property returns all the column fields of a DataPilot table.
IRemoteDataPilotFields	getDataFields() This property returns all the data fields of a DataPilot table.
IRemoteDataPilotFields	getHiddenFields() This property returns the hidden fields of a DataPilot table.
java.lang.String	getName() This property returns or sets the name of the DataPilot table.
IRemoteDataPilotFields	getPageFields() This property returns the page fields of a DataPilot table.
IRemoteDataPilotFields	getRowFields() This property returns all the row fields of a DataPilot table.
void	refreshTable() This method refreshes the DataPilot table.
void	remove() This method deletes a DataPilot table.
void	setName(java.lang.String name) This property returns or sets the name of the DataPilot table.

Method Detail

getApplication

IRemoteSymphonyApplication getApplication()
                                          throws RemoteEclipseAPIException

This property represents the Lotus Symphony application.

Returns:

application

Throws:

RemoteEclipseAPIException

getColumnFields

IRemoteDataPilotFields getColumnFields()
                                       throws RemoteEclipseAPIException

This property returns all the column fields of a DataPilot table.

Usage

Column fields are those fields that are used in a column. They can also be transformed from row fields, hidden fields, or data fields by setting Orientation property to Constant.SYMPHONY_PILOT_ORIENTATION_COLUMN.

To add column fields, use the addFields method in the DataPilotTable class.

Returns:

fields

Throws:

RemoteEclipseAPIException

getDataFields

IRemoteDataPilotFields getDataFields()
                                     throws RemoteEclipseAPIException

This property returns all the data fields of a DataPilot table.

Usage

Data fields are those fields that used as data. They can also be transformed from row fields, hidden fields, page fields or column fields by setting Orientation property to Constant.SYMPHONY_PILOT_ORIENTATION_DATA.

To add data fields, use the addFields method in the DataPilotTable class.

Returns:

fields

Throws:

RemoteEclipseAPIException

getHiddenFields

IRemoteDataPilotFields getHiddenFields()
                                       throws RemoteEclipseAPIException

This property returns the hidden fields of a DataPilot table.

Usage

Hidden fields are those fields in the source range that haven not been added to row fields, column fields, data fields or page fields. They can also be transformed from row fields, column fields, data fields, or page fields by setting Orientation property to Constant.SYMPHONY_PILOT_ORIENTATION_HIDDEN.

When the number of data fields is less than two, a default field named "Data" is added into the hidden fields.

Returns:

fields

Throws:

RemoteEclipseAPIException

getPageFields

IRemoteDataPilotFields getPageFields()
                                     throws RemoteEclipseAPIException

This property returns the page fields of a DataPilot table.

Usage

Page fields are those fields used in the table's "page" area, where single values from the field can be selected. They can also be transformed from row fields, column fields, data fields, or hidden fields by setting Orientation property to Constant.SYMPHONY_PILOT_ORIENTATION_PAGE.

To add page fields, use the addFields method in the DataPilotTable class.

Returns:

fields

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

This property returns or sets the name of the DataPilot table.

Returns:

name

Throws:

RemoteEclipseAPIException

setName

void setName(java.lang.String name)
             throws RemoteEclipseAPIException

This property returns or sets the name of the DataPilot table.

Parameters:

name -

Throws:

RemoteEclipseAPIException

getRowFields

IRemoteDataPilotFields getRowFields()
                                    throws RemoteEclipseAPIException

This property returns all the row fields of a DataPilot table.

Usage

Row fields are those fields that are used in a row. They can also be transformed from data fields, hidden fields, page fields, or column fields by setting Orientation property to Constant.SYMPHONY_PILOT_ORIENTATION_ROW .

To add row fields, use the addFields method in the DataPilotTable class.

Returns:

fields

Throws:

RemoteEclipseAPIException

addFields

void addFields(java.lang.String[] rowfields,
               java.lang.String[] colfields,
               java.lang.String[] datafields,
               java.lang.String[] pageFields,
               int function)
               throws RemoteEclipseAPIException

This method adds row fields, column fields, page fields and data fields in a DataPilot table.

Parameters:

rowfields - Specifies a field name or an array of field names to be added as rows. Each field must be a column of the DataPilot table's source range. The value of this parameter can be null.

colfields - Specifies a field name or an array of field names to be added as columns. Each field must be a column of the DataPilot table's source range. The value of this parameter can be null.

datafields - Specifies a field name or an array of field names to be added as data. Each field must be a column of the DataPilot table's source range. The value of this parameter can be null.

pageFields - Specifies a field name or an array of field names to be added as page fields. Each field must be a column of the DataPilot table's source range. The value of this parameter can be null.

function - Summarizes the DataPilot table field, and is a general function constant type.

Throws:

RemoteEclipseAPIException

refreshTable

void refreshTable()
                  throws RemoteEclipseAPIException

This method refreshes the DataPilot table.

Throws:

RemoteEclipseAPIException

remove

void remove()
            throws RemoteEclipseAPIException

This method deletes a DataPilot table.

Throws:

RemoteEclipseAPIException