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
|
/***************************************************************************
* kexidbschema.h
* This file is part of the KDE project
* copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
* This program 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
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
***************************************************************************/
#ifndef KROSS_KEXIDB_KEXIDBSCHEMA_H
#define KROSS_KEXIDB_KEXIDBSCHEMA_H
#include <qstring.h>
#include <api/object.h>
#include <api/class.h>
#include <kexidb/drivermanager.h>
#include <kexidb/schemadata.h>
#include <kexidb/tableschema.h>
#include <kexidb/queryschema.h>
namespace Kross { namespace KexiDB {
// Forward-declarations.
class KexiDBFieldList;
class KexiDBQuerySchema;
/**
* The KexiDBSchema object provides common functionality for schemas
* like KexiDBTableSchema or KexiDBQuerySchema.
*
* Example (in Python) ;
* @code
* # Get the tableschema from a KexiDBConnection object.
* tableschema = connection.tableSchema("dept")
* # Print some information.
* print "table=%s description=%s" % (tableschema.name(), tableschema.description())
* # Get the "SELECT * FROM dept;" queryschema for the table.
* queryschema = tableschema.query()
* # Walk through the fields/columns the queryschema has and print the fieldnames.
* for field in queryschema.fieldlist().fields():
* print "fieldname=%s" % field.name()
* # Execute the query. The returned KexiDBCursor object could be used then to iterate through the result.
* cursor = connection.executeQuerySchema(queryschema)
* @endcode
*/
template<class T>
class KexiDBSchema : public Kross::Api::Class<T>
{
public:
KexiDBSchema(const QString& name, ::KexiDB::SchemaData* schema, ::KexiDB::FieldList* fieldlist);
virtual ~KexiDBSchema();
private:
/** Returns the name of the schema. */
const QString name() const;
/** Set the name of the schema. */
void setName(const QString& name);
/** Returns the caption of the schema. */
const QString caption() const;
/** Set the caption of the schema. */
void setCaption(const QString& caption);
/** Returns a description of the schema. */
const QString description() const;
/** Set a description of the schema. */
void setDescription(const QString& description);
/** Returns the KexiDBFieldList object this schema has. */
KexiDBFieldList* fieldlist() const;
protected:
::KexiDB::SchemaData* m_schema;
::KexiDB::FieldList* m_fieldlist;
};
/**
* The KexiDBTableSchema object implements a KexiDBSchema for tables.
*/
class KexiDBTableSchema : public KexiDBSchema<KexiDBTableSchema>
{
public:
KexiDBTableSchema(::KexiDB::TableSchema* tableschema);
virtual ~KexiDBTableSchema();
virtual const QString getClassName() const;
::KexiDB::TableSchema* tableschema();
private:
/** Return the KexiDBQuerySchema object that represents a
"SELECT * FROM this_KexiDBTableSchema_object" SQL-statement. */
KexiDBQuerySchema* query();
};
/**
* The KexiDBTableSchema object implements a KexiDBSchema for queries.
*/
class KexiDBQuerySchema : public KexiDBSchema<KexiDBQuerySchema>
{
public:
KexiDBQuerySchema(::KexiDB::QuerySchema* queryschema);
virtual ~KexiDBQuerySchema();
virtual const QString getClassName() const;
::KexiDB::QuerySchema* queryschema();
private:
/** Returns the SQL-statement of this query schema. */
const QString statement() const;
/** Set the SQL-statement of this query schema. */
void setStatement(const QString& statement);
/** Set the where-expression. */
bool setWhereExpression(const QString& whereexpression);
};
}}
#endif
|
