offapi/com/sun/star/sdb/SingleSelectQueryAnalyzer.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: SingleSelectQueryAnalyzer.idl,v $
  10  * $Revision: 1.5 $
  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_sdb_SingleSelectQueryAnalyzer_idl__
  31 #define __com_sun_star_sdb_SingleSelectQueryAnalyzer_idl__
  32
  33 #ifndef __com_sun_star_sdb_XSingleSelectQueryAnalyzer_idl__
  34 #include <com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbcx {
  38 interface XTablesSupplier;
  39 interface XColumnsSupplier;
  40 };};};};
  41
  42  module com {  module sun {  module star {  module sdb {
  43
  44  interface XParametersSupplier;
  45 /** represents a service for analyzing a single select statement.
  46
  47     <p>
  48     It hides the complexity of parsing and evaluating a single select statement and provides
  49     sophisticated methods for accessing a statements filter, group by, having and order
  50     criteria, as well as the corresponding select columns and tables.
  51     If supported, it even gives access to the parameters.
  52     </p>
  53
  54     @see com::sun::star::sdb::SingleSelectQueryComposer
  55  */
  56 service SingleSelectQueryAnalyzer
  57 {
  58     interface XSingleSelectQueryAnalyzer;
  59
  60     /** access to the selected tables.
  61
  62         <p>The selected tables are those present in the <code>FROM</code> part
  63         of a <code>SELECT</code> statement.</p>
  64
  65         <p>Note that OpenOffice.org since version 2.0.4 also supports queries which are
  66         based on other queries. For example, given that you have a database containing
  67         a query named <code>All Orders</code>, the SQL statement <code>SELECT * FROM "All Orders"</code>
  68         is perfectly valid when used with a <type>SingleSelectQueryAnalyzer</type>.</p>
  69
  70         <p>In this case, the name container returned by <member scope="com::sun::star::sdbcx">XTablesSupplier::getTables</member>
  71         will in fact not return a <type>Table</type>, but a <type>Query</type> object. Semantically, however,
  72         this object still acts as a table in the SQL statement.</p>
  73
  74         @see XSingleSelectQueryAnalyzer::getQueryWithSubstitution
  75      */
  76     interface com::sun::star::sdbcx::XTablesSupplier;
  77
  78     /** access the selected columns.
  79      */
  80     interface com::sun::star::sdbcx::XColumnsSupplier;
  81
  82     /** access to the parameters which are used in the where clause.
  83      */
  84     [optional] interface com::sun::star::sdb::XParametersSupplier;
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 /*===========================================================================
  92 ===========================================================================*/
  93 #endif