blob: 03015ceff8d517155a65e4df25addfc7d9d680dc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: statementcomposer.hxx,v $
* $Revision: 1.3 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef CONNECTIVITY_STATEMENTCOMPOSER_HXX
#define CONNECTIVITY_STATEMENTCOMPOSER_HXX
/** === begin UNO includes === **/
#include <com/sun/star/sdbc/XConnection.hpp>
#include <com/sun/star/sdb/XSingleSelectQueryComposer.hpp>
/** === end UNO includes === **/
#include <boost/noncopyable.hpp>
#include <memory>
#include "connectivity/dbtoolsdllapi.hxx"
//........................................................................
namespace dbtools
{
//........................................................................
//====================================================================
//= StatementComposer
//====================================================================
struct StatementComposer_Data;
/** a class which is able to compose queries (SELECT statements) from a command and a command type
*/
class OOO_DLLPUBLIC_DBTOOLS StatementComposer : public ::boost::noncopyable
{
::std::auto_ptr< StatementComposer_Data > m_pData;
public:
/** constructs an instance
@param _rxConnection
the connection to work with. Must not be <NULL/>.
*/
StatementComposer(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const ::rtl::OUString& _rCommand,
const sal_Int32 _nCommandType,
const sal_Bool _bEscapeProcessing
);
~StatementComposer();
/** controls whether or not the instance disposes its XSingleSelectQueryComposer upon
destruction
Unless you explicitly call this method with the parameter being <TRUE/>,
the XSingleSelectQueryComposer will be disposed when the StatementComposer
instance is destroyed.
*/
void setDisposeComposer( bool _bDoDispose );
bool getDisposeComposer() const;
void setFilter( const ::rtl::OUString& _rFilter );
void setOrder( const ::rtl::OUString& _rOrder );
/** returns the composer which has been fed with the current settings
@throws ::com::sun::star::sdbc::SQLException
if such an exception occurs while creating the composer
*/
::com::sun::star::uno::Reference< ::com::sun::star::sdb::XSingleSelectQueryComposer >
getComposer();
/** returns the composer statement
Effectively, this is equivalent to calling getComposer, and asking the composer
for its Query attribute.
@throws ::com::sun::star::sdbc::SQLException
if such an exception occurs while creating the composer
*/
::rtl::OUString
getQuery();
private:
StatementComposer(); // not implemented
};
//........................................................................
} // namespace dbtools
//........................................................................
#endif // CONNECTIVITY_STATEMENTCOMPOSER_HXX
|
