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

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