Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 105 insertions, 0 deletions

diff --git a/include/connectivity/statementcomposer.hxx b/include/connectivity/statementcomposer.hxx
new file mode 100644
index 0000000000..88fa61f553
--- /dev/null
+++ b/include/connectivity/statementcomposer.hxx
@@ -0,0 +1,105 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef INCLUDED_CONNECTIVITY_STATEMENTCOMPOSER_HXX
+#define INCLUDED_CONNECTIVITY_STATEMENTCOMPOSER_HXX
+
+#include <rtl/ustring.hxx>
+
+#include <memory>
+#include <connectivity/dbtoolsdllapi.hxx>
+
+namespace com::sun::star::sdbc { class XConnection; }
+namespace com::sun::star::sdb { class XSingleSelectQueryComposer; }
+namespace com::sun::star::uno { template <typename > class Reference; }
+
+
+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
+    {
+        ::std::unique_ptr< StatementComposer_Data >   m_pData;
+
+    public:
+        /** constructs an instance
+
+            @param _rxConnection
+                the connection to work with. Must not be <NULL/>.
+        */
+        StatementComposer(
+            const css::uno::Reference< css::sdbc::XConnection >& _rxConnection,
+            const OUString&  _rCommand,
+            const sal_Int32  _nCommandType,
+            const 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 );
+
+        void    setFilter( const OUString& _rFilter );
+        void    setHavingClause( const OUString& _rHavingClause );
+        void    setOrder( const OUString& _rOrder );
+
+        /** returns the composer which has been fed with the current settings
+
+            @throws css::sdbc::SQLException
+                if such an exception occurs while creating the composer
+        */
+        css::uno::Reference< css::sdb::XSingleSelectQueryComposer > const &
+                getComposer();
+
+        /** returns the composer statement
+
+            Effectively, this is equivalent to calling getComposer, and asking the composer
+            for its Query attribute.
+
+            @throws css::sdbc::SQLException
+                if such an exception occurs while creating the composer
+        */
+        OUString
+                getQuery();
+
+    private:
+        StatementComposer(const StatementComposer&) = delete;
+        StatementComposer& operator=(const StatementComposer&) = delete;
+        StatementComposer() = delete;
+    };
+
+
+} // namespace dbtools
+
+
+#endif // INCLUDED_CONNECTIVITY_STATEMENTCOMPOSER_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */