offapi/com/sun/star/chart2/XDataInterpreter.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDataInterpreter.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef com_sun_star_chart2_XDataInterpreter_idl
  31 #define com_sun_star_chart2_XDataInterpreter_idl
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_PropertyValue_idl__
  37 #include <com/sun/star/beans/PropertyValue.idl>
  38 #endif
  39
  40 #include <com/sun/star/chart2/InterpretedData.idl>
  41 #include <com/sun/star/chart2/data/XDataSource.idl>
  42 #include <com/sun/star/chart2/XDataSeries.idl>
  43
  44 module com
  45 {
  46 module sun
  47 {
  48 module star
  49 {
  50 module chart2
  51 {
  52
  53 /** offers tooling to interpret different data sources in a structural
  54     and chart-type-dependent way.
  55  */
  56 interface XDataInterpreter  : ::com::sun::star::uno::XInterface
  57 {
  58     /** Interprets the given data.
  59
  60         @param aArguments
  61             Arguments that tell the template how to slice the given
  62             range.  The properties should be defined in a separate
  63             service.
  64
  65             <p>For standard parameters that may be used, see the
  66             service <type>StandardDiagramCreationParameters</type>.
  67             </p>
  68
  69         @param aSeriesToReUse
  70             use all the data series given here for the result before
  71             creating new ones.
  72      */
  73     InterpretedData interpretDataSource(
  74         [in] data::XDataSource xSource,
  75         [in] sequence< com::sun::star::beans::PropertyValue > aArguments,
  76         [in] sequence< XDataSeries > aSeriesToReUse );
  77
  78     /** Re-interprets the data given in <code>aInterpretedData</code>
  79         while keeping the number of data series and the categories.
  80
  81         <p>the data passed in
  82         <member>InterpretedData::UnusedData</member> may be used to be
  83         added to existing <type>DataSeries</type>.</p>
  84      */
  85     InterpretedData reinterpretDataSeries( [in] InterpretedData aInterpretedData );
  86
  87     /** parses the given data and states, if a
  88         <member>reinterpretDataSeries</member> call can be done
  89         without data loss.
  90
  91         <p>if this method returns <TRUE/>, a call to
  92         <member>reinterpretDataSeries</member> should leave the
  93         <member>InterpretedData::UnusedData</member> list
  94         untouched.</p>
  95
  96         @return
  97             <TRUE/>, if the data given in
  98             <code>aInterpretedData</code> has a similar structure than
  99             the one required is used as output of the data interpreter.
 100      */
 101     boolean isDataCompatible( [in] InterpretedData aInterpretedData );
 102
 103     /** Try to reverse the operation done in
 104         <member>interpretDataSource</member>.
 105
 106         <p>In case <code>aInterpretedData</code> is the result of
 107         <member>interpretDataSource</member>( <code>xSource</code> ),
 108         the result of this method should be <code>xSource</code>.</p>
 109      */
 110     data::XDataSource mergeInterpretedData( [in] InterpretedData aInterpretedData );
 111 };
 112
 113 } ; // chart2
 114 } ; // com
 115 } ; // sun
 116 } ; // star
 117
 118
 119 #endif