Calc/Features/DataPilot drill-down on data field

Description

When a cell within the data field is double-clicked, it inserts a new sheet containing a subset of rows from the original data source that constitutes the result data displayed in that cell. For instance, when the data field function is selected to be SUM, then the number that is shown in the data field cell must be identical to the sum of all the data field values in the constituent rows displayed in the inserted sheet.

The area that can provide a drill-down sheet spans from the top-left cell in the data field to the bottom-right corner of the data pilot output, including the Total Result row and column. When the cell being double-clicked contains no constituent rows, then no new sheet will be inserted.

API Change

This functionality introduces the following new API.

[cpp,N] module com { module sun { module star { module sheet {

interface XDataPilotTable2: com::sun::star::sheet::XDataPilotTable {

   sequence< sequence< any > > getDrillDownData( [in] com::sun::star::table::CellAddress aAddr );

};

}; }; }; };

[cpp,N] module com { module sun { module star { module sheet {

interface XDrillDownDataSupplier: com::sun::star::uno::XInterface {

   sequence< sequence< any > > getDrillDownData( 
       [in] sequence< com::sun::star::sheet::DataPilotFieldFilter > aFilters );

};

}; }; }; };

[cpp,N] module com { module sun { module star { module sheet {

struct DataPilotFieldFilter {

   /** Field name. */
   string FieldName;

   /** String value that needs to match against. */
   string MatchValue;

};

}; }; }; };

The com.sun.star.sheet.DataPilotSource service will support the XDrillDownDataSupplier interface to provide a 2-dimensional array data consisting of a subset of the original data source table that satisfies a given set of filtering criteria. A sequence of DataPilotFieldFilter provides desired filtering criteria to getDrillDownData() method. This interface is intended for an external UNO package so that it can overwrite the interface to provide constituent rows when requested.

The interface com.sun.star.sheet.XDataPilotTable2 extends the existing com.sun.star.sheet.XDataPilotTable interface to provide additional method getDrillDownData() so that the client code can obtain constituent rows from the data pilot table.