summaryrefslogtreecommitdiff
path: root/include/connectivity/TTableHelper.hxx
blob: 72c7577e53b28ae0a9900ba7a458482e37e3e7e4 (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/* -*- 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_TTABLEHELPER_HXX
#define INCLUDED_CONNECTIVITY_TTABLEHELPER_HXX

#include <memory>
#include <sal/config.h>

#include <map>

#include <connectivity/dbtoolsdllapi.hxx>
#include <connectivity/sdbcx/VTable.hxx>
#include <connectivity/sdbcx/VKey.hxx>
#include <connectivity/StdTypeDefs.hxx>
#include <com/sun/star/sdb/tools/XTableRename.hpp>
#include <com/sun/star/sdb/tools/XTableAlteration.hpp>
#include <com/sun/star/sdb/tools/XKeyAlteration.hpp>
#include <com/sun/star/sdb/tools/XIndexAlteration.hpp>

namespace connectivity
{
    typedef sal_Int32   OrdinalPosition;
    struct ColumnDesc
    {
        OUString sName;
        OUString aField6;
        OUString sField12; // REMARKS
        OUString sField13;
        sal_Int32       nField5
                    ,   nField7
                    ,   nField9
                    ,   nField11;

        OrdinalPosition nOrdinalPosition;

        ColumnDesc( const OUString& _rName
            , sal_Int32     _nField5
            , const OUString& _aField6
            , sal_Int32     _nField7
            , sal_Int32     _nField9
            , sal_Int32     _nField11
            , const OUString& _sField12
            , const OUString& _sField13
            ,OrdinalPosition _nPosition )
            :sName( _rName )
            ,aField6(_aField6)
            ,sField12(_sField12)
            ,sField13(_sField13)
            ,nField5(_nField5)
            ,nField7(_nField7)
            ,nField9(_nField9)
            ,nField11(_nField11)
            ,nOrdinalPosition( _nPosition )
        {
        }
    };
    typedef connectivity::sdbcx::OTable OTable_TYPEDEF;

    typedef std::map<OUString, std::shared_ptr<sdbcx::KeyProperties>> TKeyMap;

    struct OTableHelperImpl;

    class OOO_DLLPUBLIC_DBTOOLS OTableHelper : public OTable_TYPEDEF
    {
        ::std::unique_ptr<OTableHelperImpl> m_pImpl;

        void refreshPrimaryKeys(TStringVector& _rKeys);
        void refreshForeignKeys(TStringVector& _rKeys);

    protected:
        /** creates the column collection for the table
            @param  _rNames
                The column names.
        */
        virtual sdbcx::OCollection* createColumns(const TStringVector& _rNames) = 0;

        /** creates the key collection for the table
            @param  _rNames
                The key names.
        */
        virtual sdbcx::OCollection* createKeys(const TStringVector& _rNames) = 0;

        /** creates the index collection for the table
            @param  _rNames
                The index names.
        */
        virtual sdbcx::OCollection* createIndexes(const TStringVector& _rNames) = 0;

        /** this function is called upon disposing the component
        */
        virtual void SAL_CALL disposing() override;

        /** The default returns "RENAME TABLE " or "RENAME VIEW " depending on the type.
        *
        * \return The start of the rename statement.
        */
        virtual OUString getRenameStart() const;

        virtual ~OTableHelper() override;

    public:
        virtual void refreshColumns() override;
        virtual void refreshKeys() override;
        virtual void refreshIndexes() override;

        const ColumnDesc* getColumnDescription(const OUString& _sName) const;

    public:
        OTableHelper(   sdbcx::OCollection* _pTables,
                        const css::uno::Reference< css::sdbc::XConnection >& _xConnection,
                        bool _bCase);
        OTableHelper(   sdbcx::OCollection* _pTables,
                        const css::uno::Reference< css::sdbc::XConnection >& _xConnection,
                        bool _bCase,
                        const OUString& Name,
                        const OUString& Type,
                        const OUString& Description = OUString(),
                        const OUString& SchemaName = OUString(),
                        const OUString& CatalogName = OUString()
            );

        virtual css::uno::Reference< css::sdbc::XDatabaseMetaData> getMetaData() const override;
        css::uno::Reference< css::sdbc::XConnection> getConnection() const;

        // XRename
        virtual void SAL_CALL rename( const OUString& newName ) override;

        // XAlterTable
        virtual void SAL_CALL alterColumnByIndex( sal_Int32 index, const css::uno::Reference< css::beans::XPropertySet >& descriptor ) override;
        // XNamed
        virtual OUString SAL_CALL getName() override;

        // helper method to get key properties
        std::shared_ptr<sdbcx::KeyProperties> getKeyProperties(const OUString& _sName) const;
        void addKey(const OUString& _sName,const std::shared_ptr<sdbcx::KeyProperties>& _aKeyProperties);

        virtual OUString getTypeCreatePattern() const;

        css::uno::Reference< css::sdb::tools::XTableRename>      getRenameService() const;
        css::uno::Reference< css::sdb::tools::XTableAlteration>  getAlterService() const;
        css::uno::Reference< css::sdb::tools::XKeyAlteration>    getKeyService() const;
        css::uno::Reference< css::sdb::tools::XIndexAlteration>  getIndexService() const;
    };
}
#endif // INCLUDED_CONNECTIVITY_TTABLEHELPER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */