include/svx/dataaccessdescriptor.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SVX_DATAACCESSDESCRIPTOR_HXX
  21 #define INCLUDED_SVX_DATAACCESSDESCRIPTOR_HXX
  22
  23 #include <com/sun/star/beans/PropertyValue.hpp>
  24 #include <com/sun/star/beans/XPropertySet.hpp>
  25 #include <svx/svxdllapi.h>
  26 #include <memory>
  27
  28 namespace svx
  29 {
  30     class ODADescriptorImpl;
  31
  32     //= DataAccessDescriptorProperty
  33     enum class DataAccessDescriptorProperty
  34     {
  35         DataSource,           /// data source name            (string)
  36         DatabaseLocation,     /// database file URL           (string)
  37         ConnectionResource,   /// database driver URL         (string)
  38         Connection,           /// connection                  (XConnection)
  39
  40         Command,              /// command                     (string)
  41         CommandType,          /// command type                (long)
  42         EscapeProcessing,     /// escape processing           (boolean)
  43         Filter,               /// additional filter           (string)
  44         Cursor,               /// the cursor                  (XResultSet)
  45
  46         ColumnName,           /// column name                 (string)
  47         ColumnObject,         /// column object               (XPropertySet)
  48
  49         Selection,            /// selection                   (sequence< any >)
  50         BookmarkSelection,    /// selection are bookmarks?    (boolean)
  51
  52         Component             /// component name              (XContent)
  53     };
  54
  55     //= ODataAccessDescriptor
  56
  57     /** class encapsulating the css::sdb::DataAccessDescriptor service.
  58     */
  59     class SAL_WARN_UNUSED SVX_DLLPUBLIC ODataAccessDescriptor
  60     {
  61     protected:
  62         std::unique_ptr<ODADescriptorImpl>      m_pImpl;
  63
  64     public:
  65         ODataAccessDescriptor();
  66         ODataAccessDescriptor( const ODataAccessDescriptor& _rSource );
  67         ODataAccessDescriptor( ODataAccessDescriptor&& _rSource );
  68         ODataAccessDescriptor( const css::uno::Reference< css::beans::XPropertySet >& _rValues );
  69         ODataAccessDescriptor( const css::uno::Sequence< css::beans::PropertyValue >& _rValues );
  70
  71         // allows to construct a descriptor from an Any containing either an XPropertySet or a property value sequence
  72         ODataAccessDescriptor( const css::uno::Any& _rValues );
  73
  74         ODataAccessDescriptor& operator=(const ODataAccessDescriptor& _rSource);
  75         ODataAccessDescriptor& operator=(ODataAccessDescriptor&& _rSource);
  76
  77         ~ODataAccessDescriptor();
  78
  79         /** returns the descriptor as property value sequence
  80             <p>If you call this method more than once, without writing any values between both calls, the same object
  81             is returned. If you wrote values, a new object is returned.</p>
  82         */
  83         css::uno::Sequence< css::beans::PropertyValue >
  84                     createPropertyValueSequence();
  85
  86         /** initialized the descriptor from the property values given
  87             The descriptor will clear all its current settings before
  88             initializing with the new ones.
  89         */
  90         void        initializeFrom(
  91                         const css::uno::Sequence< css::beans::PropertyValue >& _rValues);
  92
  93         /// checks whether or not a given property is present in the descriptor
  94         bool        has(DataAccessDescriptorProperty _eWhich) const;
  95
  96         /** erases the given property from the descriptor
  97         */
  98         void        erase(DataAccessDescriptorProperty _eWhich);
  99
 100         /** empties the descriptor
 101         */
 102         void        clear();
 103
 104         /// return the value of a given property
 105         const   css::uno::Any& operator [] ( DataAccessDescriptorProperty _eWhich ) const;
 106
 107         /** return the (modifiable) value of a given property
 108             <p>This operator is not allowed to be called if the descriptor is readonly.</p>
 109         */
 110                 css::uno::Any& operator [] ( DataAccessDescriptorProperty _eWhich );
 111
 112         /** returns either the data source name if given or the database location
 113         */
 114         OUString getDataSource() const;
 115
 116         /** set the data source name, if it is not file URL
 117             @param  _sDataSourceNameOrLocation
 118                 the data source name or database location
 119         */
 120         void setDataSource(const OUString& _sDataSourceNameOrLocation);
 121     };
 122
 123 }
 124
 125 #endif // INCLUDED_SVX_DATAACCESSDESCRIPTOR_HXX
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */