<html> <head> <title>Interface XDatabaseDataProvider</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XDatabaseDataProvider-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Methods' Summary</td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub">Methods' Details</td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">chart2</a> :: <a href="module-ix.html" class="namechain">data</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XDatabaseDataProvider</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XDatabaseDataProvider</strong> ┣ <a href="XDataProvider.html">XDataProvider</a> ┣ <a href="XRangeXMLConversion.html">XRangeXMLConversion</a> ┣ ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XInitialization.html">XInitialization</a> ┣ ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a> ┣ ::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/XPropertySet.html">XPropertySet</a> ┣ ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XParameters.html">XParameters</a> ┗ ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XRowSet.html">XRowSet</a> ┗ ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XResultSet.html">XResultSet</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XDataProvider.html">XDataProvider</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>For accessing data a component provides for being used by charts. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XRangeXMLConversion.html">XRangeXMLConversion</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows you to convert the ranges a data provider deals with internally into valid XML. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XInitialization.html">XInitialization</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows access to the properties of the instance. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows life-time control of the database data provider. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/XPropertySet.html">XPropertySet</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows access to the properties of the instance. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XParameters.html">XParameters</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>is used for parameter setting, commonly implemented in conjunction with PreparedStatements. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XRowSet.html">XRowSet</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>enhances the functionality of a result set. It allows implementation of a special behavior for a result set and notifies an application on certain row set events such as a change in its value. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>identifies a <a href="XDataProvider.html">XDataProvider</a> for result sets. </dd> <dt><b>See also</b></dt> <dd><a href="XDataProvider.html">XDataProvider</a>, <a href="DataProvider.html">DataProvider</a></dd> </dl> </td> </tr> </table> <hr> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#MasterFields">MasterFields</a></td> <td class="imsum_right">is used for subreports and contains the names of columns of the parent report. </td> </tr> <tr> <td class="imsum_left"><a href="#DetailFields">DetailFields</a></td> <td class="imsum_right">is used for subreports and contains the names of the columns of the subreport which are related to the master fields of the parent report. </td> </tr> <tr> <td class="imsum_left"><a href="#Command">Command</a></td> <td class="imsum_right">is the command which should be executed, the type of command depends on the CommandType. </td> </tr> <tr> <td class="imsum_left"><a href="#CommandType">CommandType</a></td> <td class="imsum_right">specifies the type of the command to be executed to retrieve a result set. </td> </tr> <tr> <td class="imsum_left"><a href="#Filter">Filter</a></td> <td class="imsum_right">specifies an addtional filter to optinally use. </td> </tr> <tr> <td class="imsum_left"><a href="#ApplyFilter">ApplyFilter</a></td> <td class="imsum_right">indicates whether the filter should be applied or not, default is <b>false</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#HavingClause">HavingClause</a></td> <td class="imsum_right">additional having clause for the row set </td> </tr> <tr> <td class="imsum_left"><a href="#GroupBy">GroupBy</a></td> <td class="imsum_right">additional group by for the row set </td> </tr> <tr> <td class="imsum_left"><a href="#Order">Order</a></td> <td class="imsum_right">is a additional sort order definition for a rowset. </td> </tr> <tr> <td class="imsum_left"><a href="#EscapeProcessing">EscapeProcessing</a></td> <td class="imsum_right">specifies if the <a href="#Command">Command</a> should be analyzed on the client side before sending it to the database server. </td> </tr> <tr> <td class="imsum_left"><a href="#RowLimit">RowLimit</a></td> <td class="imsum_right">specifies the maximal count of rows which should be fetched. </td> </tr> <tr> <td class="imsum_left"><a href="#ActiveConnection">ActiveConnection</a></td> <td class="imsum_right">specifies the active connection which is used to create the resulting report. </td> </tr> <tr> <td class="imsum_left"><a href="#DataSourceName">DataSourceName</a></td> <td class="imsum_right">is the name of the datasource to use, this could be a named datasource or the URL of a data access component. </td> </tr> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="MasterFields" class="membertitle">MasterFields</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] sequence< string > <b>MasterFields</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is used for subreports and contains the names of columns of the parent report. </dd> <dd><p> These columns are typically the foreign key fields of the parent report. The values of theses columns are used to identify the data for the subreport. Each time the parent report changes it's current row, the subreport requeries it's data based on the values of the master fields.</p> <p>If the report is no sub report (e.g. it's parent is not a report itself), this property is not evaluated.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DetailFields" class="membertitle">DetailFields</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] sequence< string > <b>DetailFields</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is used for subreports and contains the names of the columns of the subreport which are related to the master fields of the parent report. </dd> <dd><p>Entries in this sequence can either denote column names in the sub report, or paramater names.<br/> For instance, you could base the report on the SQL statement <code>SELECT * FROM invoices WHERE cust_ref = :cid</code>, and add <code>cid</code> to the DetailFields property. In this case, the parameter will be filled from the corresponding master field.<br/> Alternatively, you could simply base your report on the table <code>invoices</code>, and add the column name <code>cust_ref</code> to the DetailFields. In this case, and implicit filter clause <code>WHERE cust_ref = :<new_param_name></code> will be created, and the artificial parameter will be filled from the corresponding master field.<br/> If a string in this property denotes both a column name and a parameter name, it is undefined which way it is interpreted, but implementations of the service are required to either decide for the paramter or the column, and proceed as usual. </p> <p>The columns specified herein typically represent a part of the primary key fields or their aliases of the detail report.</p> <p>If the report is no sub report (e.g. it's parent is not a report itself), this property is not evaluated.</p> * </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Command" class="membertitle">Command</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Command</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the command which should be executed, the type of command depends on the CommandType. </dd> <dd><p>In case of a <a href="#CommandType">CommandType</a> of ::CommandType::COMMAND, means in case the <a href="#Command">Command</a> specifies an SQL statement, the inherited ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/RowSet.html">RowSet</a>::<a href="../../sdbc/RowSet.html#EscapeProcessing">EscapeProcessing</a> becomes relevant:<br/> It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.<br/> The default value for ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/RowSet.html">RowSet</a>::<a href="../../sdbc/RowSet.html#EscapeProcessing">EscapeProcessing</a> is <b>true</b>. By switching it to <b>false</b>, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/CommandType.html">CommandType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CommandType" class="membertitle">CommandType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>CommandType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the type of the command to be executed to retrieve a result set. </dd> <dd><p><a href="#Command">Command</a> needs to be interpreted depending on the value of this property.</p> <p>This property is only meaningfull together with the <a href="#Command">Command</a> property, thus either <em>both</em> or <em>none</em> of them are present.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/CommandType.html">CommandType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Filter" class="membertitle">Filter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Filter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies an addtional filter to optinally use. </dd> <dd><p>The Filter string has to form a SQL WHERE-clause, <em>without</em> the WHERE-string itself.</p> <p>If a <a href="#DataSourceName">DataSourceName</a>, <a href="#Command">Command</a> and <a href="#CommandType">CommandType</a> are specified, a ::RowSet can be created with this information. If the results provided by the row set are to be additionally filtered, the Filter property can be used.</p> <p>Note that the Filter property does not make sense if a <a href="#ResultSet">ResultSet</a> has been specified in the DataAccessDescriptor.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>, <a href="#ResultSet">ResultSet</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ApplyFilter" class="membertitle">ApplyFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>ApplyFilter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates whether the filter should be applied or not, default is <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HavingClause" class="membertitle">HavingClause</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>HavingClause</b><dl> <dd>set raises (::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>additional having clause for the row set </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GroupBy" class="membertitle">GroupBy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>GroupBy</b><dl> <dd>set raises (::com::sun::star::<a href="../../beans/module-ix.html">beans</a>::<a href="../../beans/UnknownPropertyException.html">UnknownPropertyException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>additional group by for the row set </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Order" class="membertitle">Order</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>Order</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is a additional sort order definition for a rowset. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EscapeProcessing" class="membertitle">EscapeProcessing</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] boolean <b>EscapeProcessing</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies if the <a href="#Command">Command</a> should be analyzed on the client side before sending it to the database server. </dd> <dd><p>The default value of this property is <b>true</b>. By switching it to <b>false</b>, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> <p>This property is usually present together with the <a href="#Command">Command</a> and <a href="#CommandType">CommandType</a> properties, and is evaluated if and only if <a href="#CommandType">CommandType</a> equals ::CommandType::COMMAND.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RowLimit" class="membertitle">RowLimit</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] long <b>RowLimit</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the maximal count of rows which should be fetched. </dd> <dd><p>A value of zero implies that no limit exists.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ActiveConnection" class="membertitle">ActiveConnection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] ::com::sun::star::<a href="../../sdbc/module-ix.html">sdbc</a>::<a href="../../sdbc/XConnection.html">XConnection</a> <b>ActiveConnection</b><dl> <dd>set raises (::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies the active connection which is used to create the resulting report. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DataSourceName" class="membertitle">DataSourceName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ bound ] string <b>DataSourceName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the name of the datasource to use, this could be a named datasource or the URL of a data access component. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
1876
