1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdb_SingleSelectQueryAnalyzer_idl__
28#define __com_sun_star_sdb_SingleSelectQueryAnalyzer_idl__
29
30#ifndef __com_sun_star_sdb_XSingleSelectQueryAnalyzer_idl__
31#include <com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdbcx {
35interface XTablesSupplier;
36interface XColumnsSupplier;
37};};};};
38
39 module com {  module sun {  module star {  module sdb {
40
41 interface XParametersSupplier;
42/** represents a service for analyzing a single select statement.
43
44	<p>
45	It hides the complexity of parsing and evaluating a single select statement and provides
46	sophisticated methods for accessing a statements filter, group by, having and order
47	criteria, as well as the corresponding select columns and tables.
48	If supported, it even gives access to the parameters.
49	</p>
50
51	@see com::sun::star::sdb::SingleSelectQueryComposer
52 */
53service SingleSelectQueryAnalyzer
54{
55	interface XSingleSelectQueryAnalyzer;
56
57	/** access to the selected tables.
58
59        <p>The selected tables are those present in the <code>FROM</code> part
60        of a <code>SELECT</code> statement.</p>
61
62        <p>Note that OpenOffice.org since version 2.0.4 also supports queries which are
63        based on other queries. For example, given that you have a database containing
64        a query named <code>All Orders</code>, the SQL statement <code>SELECT * FROM "All Orders"</code>
65        is perfectly valid when used with a <type>SingleSelectQueryAnalyzer</type>.</p>
66
67        <p>In this case, the name container returned by <member scope="com::sun::star::sdbcx">XTablesSupplier::getTables</member>
68        will in fact not return a <type>Table</type>, but a <type>Query</type> object. Semantically, however,
69        this object still acts as a table in the SQL statement.</p>
70
71        @see XSingleSelectQueryAnalyzer::getQueryWithSubstitution
72	 */
73	interface com::sun::star::sdbcx::XTablesSupplier;
74
75	/** access the selected columns.
76	 */
77	interface com::sun::star::sdbcx::XColumnsSupplier;
78
79	/** access to the parameters which are used in the where clause.
80	 */
81	[optional] interface com::sun::star::sdb::XParametersSupplier;
82};
83
84//=============================================================================
85
86}; }; }; };
87
88/*===========================================================================
89===========================================================================*/
90#endif
91