offapi/com/sun/star/chart2/data/XDatabaseDataProvider.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_chart2_data_XDatabaseDataProvider_idl__
  20 #define __com_sun_star_chart2_data_XDatabaseDataProvider_idl__
  21
  22 #include <com/sun/star/container/NoSuchElementException.idl>
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24 #include <com/sun/star/beans/UnknownPropertyException.idl>
  25 #include <com/sun/star/lang/XInitialization.idl>
  26 #include <com/sun/star/lang/XComponent.idl>
  27 #include <com/sun/star/sdbc/XConnection.idl>
  28 #include <com/sun/star/sdbc/XParameters.idl>
  29 #include <com/sun/star/sdbc/XRowSet.idl>
  30 #include <com/sun/star/chart2/data/XDataProvider.idl>
  31 #include <com/sun/star/chart2/data/XRangeXMLConversion.idl>
  32
  33
  34  module com {  module sun {  module star {  module chart2 { module data {
  35
  36
  37 /** identifies a XDataProvider for result sets.
  38
  39     @see XDataProvider
  40     @see DataProvider
  41  */
  42 interface XDatabaseDataProvider
  43 {
  44     /** For accessing data a component provides for being used by
  45         charts.
  46      */
  47     interface XDataProvider;
  48
  49     /** allows you to convert the ranges a data provider deals with
  50         internally into valid XML.
  51      */
  52     interface XRangeXMLConversion;
  53
  54     /** allows access to the properties of the instance.
  55     */
  56     interface com::sun::star::lang::XInitialization;
  57
  58     /** allows life-time control of the database data provider.
  59      */
  60     interface com::sun::star::lang::XComponent;
  61
  62     /** allows access to the properties of the instance.
  63     */
  64     interface com::sun::star::beans::XPropertySet;
  65
  66     interface com::sun::star::sdbc::XParameters;
  67     interface com::sun::star::sdbc::XRowSet;
  68
  69     /** is used for subreports and contains the names of columns of the parent report.
  70     <p> These columns are typically the foreign key fields of the parent report.
  71     The values of theses columns are used to identify the data for the subreport.
  72     Each time the parent report changes its current row, the subreport requeries
  73     it's data based on the values of the master fields.</p>
  74     <p>If the report is no sub report (e.g. its parent is not a report itself), this
  75     property is not evaluated.</p>
  76
  77     */
  78     [attribute,bound] sequence<string> MasterFields;
  79
  80     /**is used for subreports and contains the names of the columns of the subreport
  81     which are related to the master fields of the parent report.
  82     <p>Entries in this sequence can either denote column names in the sub report,
  83     or parameter names.<br/>
  84     For instance, you could base the report on the SQL statement
  85     <code>SELECT * FROM invoices WHERE cust_ref = :cid</code>, and add <code>cid</code>
  86     to the DetailFields property. In this case, the parameter will be filled from
  87     the corresponding master field.<br/>
  88     Alternatively, you could simply base your report on the table <code>invoices</code>,
  89     and add the column name <code>cust_ref</code> to the DetailFields. In this case,
  90     and implicit filter clause <code>WHERE cust_ref = :&lt;new_param_name&gt;</code> will
  91     be created, and the artificial parameter will be filled from the corresponding
  92     master field.<br/>
  93     If a string in this property denotes both a column name and a parameter name, it
  94     is undefined which way it is interpreted, but implementations of the service are required
  95     to either decide for the parameter or the column, and proceed as usual.
  96     </p>
  97     <p>The columns specified herein typically represent a part of the primary key
  98     fields or their aliases of the detail report.</p>
  99     <p>If the report is no sub report (e.g. its parent is not a report itself), this
 100     property is not evaluated.</p>
 101     *
 102     */
 103     [attribute,bound] sequence<string> DetailFields;
 104
 105     /** is the command which should be executed, the type of command depends
 106     on the CommandType.
 107     <p>In case of a #CommandType of CommandType::COMMAND,
 108     means in case the #Command specifies an SQL statement, the inherited
 109     com::sun::star::sdbc::RowSet::EscapeProcessing
 110     becomes relevant:<br/>
 111     It then can be to used to specify whether the SQL statement should be analyzed on the
 112     client side before sending it to the database server.<br/>
 113     The default value for com::sun::star::sdbc::RowSet::EscapeProcessing
 114     is `TRUE`. By switching it to `FALSE`, you can pass backend-specific SQL statements,
 115     which are not standard SQL, to your database.</p>
 116
 117
 118     @see com::sun::star::sdb::CommandType
 119     */
 120     [attribute,bound] string Command;
 121
 122     /** specifies the type of the command to be executed to retrieve a result set.
 123
 124         <p>#Command needs to be interpreted depending on the value of this property.</p>
 125
 126         <p>This property is only meaningful together with the #Command
 127         property, thus either <em>both</em> or <em>none</em> of them are present.</p>
 128
 129         @see com::sun::star::sdb::CommandType
 130      */
 131     [attribute,bound] long CommandType;
 132
 133     /** specifies an additional filter to optionally use.
 134
 135         <p>The Filter string has to form a SQL WHERE-clause, <em>without</em> the WHERE-string itself.</p>
 136
 137         <p>If a #DataSourceName, #Command and #CommandType
 138         are specified, a RowSet can be created with this information. If the results provided by the
 139         row set are to be additionally filtered, the Filter property can be used.</p>
 140
 141         <p>Note that the Filter property does not make sense if a resultSet has been specified
 142         in the DataAccessDescriptor.</p>
 143
 144         @see com::sun::star::sdb::RowSet
 145         @see ResultSet
 146     */
 147     [attribute,bound] string Filter;
 148
 149     /** indicates whether the filter should be applied or not,
 150         default is `FALSE`.
 151      */
 152     [attribute,bound] boolean ApplyFilter;
 153
 154     /** additional having clause for the row set
 155      */
 156     [attribute,bound] string HavingClause
 157     {
 158         set raises (com::sun::star::beans::UnknownPropertyException);
 159     };
 160
 161     /** additional group by for the row set
 162      */
 163     [attribute,bound] string GroupBy
 164     {
 165         set raises (com::sun::star::beans::UnknownPropertyException);
 166     };
 167
 168     /** is a additional sort order definition for a row set.
 169      */
 170     [attribute,bound] string Order;
 171
 172     /** specifies if the #Command should be analyzed on the client side before sending it
 173         to the database server.
 174
 175         <p>The default value of this property is `TRUE`. By switching it to `FALSE`, you can pass
 176         backend-specific SQL statements, which are not standard SQL, to your database.</p>
 177
 178         <p>This property is usually present together with the #Command and
 179         #CommandType properties, and is evaluated if and only if #CommandType
 180         equals CommandType::COMMAND.</p>
 181     */
 182     [attribute,bound] boolean EscapeProcessing;
 183
 184     /** specifies the maximal count of rows which should be fetched.
 185         <p>A value of zero implies that no limit exists.</p>
 186     */
 187     [attribute,bound] long RowLimit;
 188
 189     /** specifies the active connection which is used to create the resulting report.
 190     */
 191     [attribute,bound] com::sun::star::sdbc::XConnection ActiveConnection
 192     {
 193         set raises (com::sun::star::lang::IllegalArgumentException);
 194     };
 195     /** is the name of the data source to use, this could be a named data source
 196         or the URL of a data access component.
 197      */
 198     [attribute,bound] string DataSourceName;
 199 };
 200
 201
 202  }; }; }; };  };
 203
 204 #endif
 205
 206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */