Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: chart2 :: data ::

unpublished interface XDataProvider
Usage Restrictions
not published
Description
An application that provides data for a chart must implement this interface.

Methods' Summary
createDataSourcePossible If true is returned, a call to createDataSource with the same arguments must return a valid XDataSequence object. If false is returned, createDataSource throws an exception.  
createDataSource Creates a data source object that matches the given range representation string.  
detectArguments Tries to find out with what parameters the passed DataSource most probably was created.  
createDataSequenceByRangeRepresentationPossible If true is returned, a call to createDataSequenceByRangeRepresentation with the same argument must return a valid XDataSequence object. If false is returned, createDataSequenceByRangeRepresentation throws an exception.  
createDataSequenceByRangeRepresentation creates a single data sequence for the given data range.  
getRangeSelection Returns a component that is able to change a given range representation to another one. This usually is a controller-component that uses the GUI to allow a user to select a new range.  
Methods' Details
createDataSourcePossible
boolean
createDataSourcePossible( [in] sequence< ::com::sun::star::beans::PropertyValue >  aArguments );

Description
If true is returned, a call to createDataSource with the same arguments must return a valid XDataSequence object. If false is returned, createDataSource throws an exception.
createDataSource
XDataSource
createDataSource( [in] sequence< ::com::sun::star::beans::PropertyValue >  aArguments )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Creates a data source object that matches the given range representation string.

This can be used for creating the necessary data for a new chart out of a previously selected range of cells in a spreadsheet.

Parameter aArguments
Arguments that tell the data provider how to slice the given range. The properties should be defined in a separate service.

For spreadsheets and textdocument tables there exists a service TabularDataProviderArguments describing valid values for this list.

Returns
a data source containing DataSequences that span the entire region given in aArguments.
Throws
::com::sun::star::lang::IllegalArgumentException may be raised by the XDataProvider if it is unable to interpret the arguments passed in aArguments appropriately.
detectArguments
sequence< ::com::sun::star::beans::PropertyValue >
detectArguments( [in] XDataSource  xDataSource );

Description
Tries to find out with what parameters the passed DataSource most probably was created.

if xDataSource is a data source that was created with createDataSource, the arguments returned here should be the same than the ones passed to the function. Of course, this cannot be guaranteed. However, if detection is ambiguous, the returned arguments should be empty.

This method may merge representation strings together if adjacent ranges appear successively in the range identifiers. E.g., if the first range refers to "$Sheet1.$A$1:$A$8" and the second range refers to "$Sheet1.$B$1:$B$8", those should be merged together to "$Sheet1.$A$1:$B$8".

Parameter xDataSource
A data source containing all data used in a chart.
Returns
Arguments that when being passed to createDataSource should in an ideal case return the same data source as xDataSource.
createDataSequenceByRangeRepresentationPossible
boolean
createDataSequenceByRangeRepresentationPossible( [in] string  aRangeRepresentation );

Description
If true is returned, a call to createDataSequenceByRangeRepresentation with the same argument must return a valid XDataSequence object. If false is returned, createDataSequenceByRangeRepresentation throws an exception.
createDataSequenceByRangeRepresentation
XDataSequence
createDataSequenceByRangeRepresentation( [in] string  aRangeRepresentation )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
creates a single data sequence for the given data range.
Parameter aRangeRepresentation
is a string that can be interpreted by the component that implements this interface. The representation string is of a form that may be used in the user interface.
Throws
com::sun::star::lang::IllegalArgumentException if the given range does not contain a valid range representation for a one-dimensional range of data.
See also
createDataSource
getRangeSelection
::com::sun::star::sheet::XRangeSelection
getRangeSelection();

Description
Returns a component that is able to change a given range representation to another one. This usually is a controller-component that uses the GUI to allow a user to select a new range.

This method may return nothing, if it does not support range selection or if there is no current controller available that offers the functionality.

Returns
The component for selecting a new range. It must support ::XComponent, in order to inform the receiver about its lifetime.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.