summaryrefslogtreecommitdiffstats
path: root/src/sql/qsqlresult.cpp
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-07-10 15:24:15 -0500
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-07-10 15:24:15 -0500
commitbd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch)
tree7a520322212d48ebcb9fbe1087e7fca28b76185c /src/sql/qsqlresult.cpp
downloadqt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz
qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip
Add Qt3 development HEAD version
Diffstat (limited to 'src/sql/qsqlresult.cpp')
-rw-r--r--src/sql/qsqlresult.cpp368
1 files changed, 368 insertions, 0 deletions
diff --git a/src/sql/qsqlresult.cpp b/src/sql/qsqlresult.cpp
new file mode 100644
index 0000000..1ec963f
--- /dev/null
+++ b/src/sql/qsqlresult.cpp
@@ -0,0 +1,368 @@
+/****************************************************************************
+**
+** Implementation of QSqlResult class
+**
+** Created : 2000-11-03
+**
+** Copyright (C) 2005-2008 Trolltech ASA. All rights reserved.
+**
+** This file is part of the sql module of the Qt GUI Toolkit.
+**
+** This file may be used under the terms of the GNU General
+** Public License versions 2.0 or 3.0 as published by the Free
+** Software Foundation and appearing in the files LICENSE.GPL2
+** and LICENSE.GPL3 included in the packaging of this file.
+** Alternatively you may (at your option) use any later version
+** of the GNU General Public License if such license has been
+** publicly approved by Trolltech ASA (or its successors, if any)
+** and the KDE Free Qt Foundation.
+**
+** Please review the following information to ensure GNU General
+** Public Licensing requirements will be met:
+** http://trolltech.com/products/qt/licenses/licensing/opensource/.
+** If you are unsure which license is appropriate for your use, please
+** review the following information:
+** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
+** or contact the sales department at sales@trolltech.com.
+**
+** This file may be used under the terms of the Q Public License as
+** defined by Trolltech ASA and appearing in the file LICENSE.QPL
+** included in the packaging of this file. Licensees holding valid Qt
+** Commercial licenses may use this file in accordance with the Qt
+** Commercial License Agreement provided with the Software.
+**
+** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
+** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
+** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
+** herein.
+**
+**********************************************************************/
+
+#include "qsqlresult.h"
+#include "private/qsqlextension_p.h"
+
+#ifndef QT_NO_SQL
+
+class QSqlResultPrivate
+{
+public:
+ const QSqlDriver* sqldriver;
+ int idx;
+ QString sql;
+ bool active;
+ bool isSel;
+ QSqlError error;
+ QSqlExtension * ext;
+};
+
+/*!
+ \class QSqlResult
+ \brief The QSqlResult class provides an abstract interface for
+ accessing data from SQL databases.
+
+ \ingroup database
+ \module sql
+
+ Normally you would use QSqlQuery instead of QSqlResult since QSqlQuery
+ provides a generic wrapper for database-specific implementations of
+ QSqlResult.
+
+ \sa QSql
+*/
+
+
+/*!
+ Protected constructor which creates a QSqlResult using database \a
+ db. The object is initialized to an inactive state.
+*/
+
+QSqlResult::QSqlResult( const QSqlDriver * db ): forwardOnly( FALSE )
+{
+ d = new QSqlResultPrivate();
+ d->sqldriver = db;
+ d->idx = QSql::BeforeFirst;
+ d->isSel = FALSE;
+ d->active = FALSE;
+ d->ext = new QSqlExtension();
+}
+
+/*!
+ Destroys the object and frees any allocated resources.
+*/
+
+QSqlResult::~QSqlResult()
+{
+ if ( d->ext )
+ delete d->ext;
+ delete d;
+}
+
+/*!
+ Sets the current query for the result to \a query. The result must
+ be reset() in order to execute the query on the database.
+*/
+
+void QSqlResult::setQuery( const QString& query )
+{
+ d->sql = query;
+}
+
+/*!
+ Returns the current SQL query text, or QString::null if there is none.
+*/
+
+QString QSqlResult::lastQuery() const
+{
+ return d->sql;
+}
+
+/*!
+ Returns the current (zero-based) position of the result.
+*/
+
+int QSqlResult::at() const
+{
+ return d->idx;
+}
+
+
+/*!
+ Returns TRUE if the result is positioned on a valid record (that
+ is, the result is not positioned before the first or after the
+ last record); otherwise returns FALSE.
+*/
+
+bool QSqlResult::isValid() const
+{
+ return ( d->idx != QSql::BeforeFirst && \
+ d->idx != QSql::AfterLast ) ? TRUE : FALSE;
+}
+
+/*!
+ \fn bool QSqlResult::isNull( int i )
+
+ Returns TRUE if the field at position \a i is NULL; otherwise
+ returns FALSE.
+*/
+
+
+/*!
+ Returns TRUE if the result has records to be retrieved; otherwise
+ returns FALSE.
+*/
+
+bool QSqlResult::isActive() const
+{
+ return d->active;
+}
+
+/*!
+ Protected function provided for derived classes to set the
+ internal (zero-based) result index to \a at.
+
+ \sa at()
+*/
+
+void QSqlResult::setAt( int at )
+{
+ d->idx = at;
+}
+
+
+/*!
+ Protected function provided for derived classes to indicate
+ whether or not the current statement is a SQL SELECT statement.
+ The \a s parameter should be TRUE if the statement is a SELECT
+ statement, or FALSE otherwise.
+*/
+
+void QSqlResult::setSelect( bool s )
+{
+ d->isSel = s;
+}
+
+/*!
+ Returns TRUE if the current result is from a SELECT statement;
+ otherwise returns FALSE.
+*/
+
+bool QSqlResult::isSelect() const
+{
+ return d->isSel;
+}
+
+/*!
+ Returns the driver associated with the result.
+*/
+
+const QSqlDriver* QSqlResult::driver() const
+{
+ return d->sqldriver;
+}
+
+
+/*!
+ Protected function provided for derived classes to set the
+ internal active state to the value of \a a.
+
+ \sa isActive()
+*/
+
+void QSqlResult::setActive( bool a )
+{
+ d->active = a;
+}
+
+/*!
+ Protected function provided for derived classes to set the last
+ error to the value of \a e.
+
+ \sa lastError()
+*/
+
+void QSqlResult::setLastError( const QSqlError& e )
+{
+ d->error = e;
+}
+
+
+/*!
+ Returns the last error associated with the result.
+*/
+
+QSqlError QSqlResult::lastError() const
+{
+ return d->error;
+}
+
+/*!
+ \fn int QSqlResult::size()
+
+ Returns the size of the result or -1 if it cannot be determined.
+*/
+
+/*!
+ \fn int QSqlResult::numRowsAffected()
+
+ Returns the number of rows affected by the last query executed.
+*/
+
+/*!
+ \fn QVariant QSqlResult::data( int i )
+
+ Returns the data for field \a i (zero-based) as a QVariant. This
+ function is only called if the result is in an active state and is
+ positioned on a valid record and \a i is non-negative.
+ Derived classes must reimplement this function and return the value
+ of field \a i, or QVariant() if it cannot be determined.
+*/
+
+/*!
+ \fn bool QSqlResult::reset( const QString& query )
+
+ Sets the result to use the SQL statement \a query for subsequent
+ data retrieval. Derived classes must reimplement this function and
+ apply the \a query to the database. This function is called only
+ after the result is set to an inactive state and is positioned
+ before the first record of the new result. Derived classes should
+ return TRUE if the query was successful and ready to be used,
+ or FALSE otherwise.
+*/
+
+/*!
+ \fn bool QSqlResult::fetch( int i )
+
+ Positions the result to an arbitrary (zero-based) index \a i. This
+ function is only called if the result is in an active state. Derived
+ classes must reimplement this function and position the result to the
+ index \a i, and call setAt() with an appropriate value. Return TRUE
+ to indicate success, or FALSE to signify failure.
+*/
+
+/*!
+ \fn bool QSqlResult::fetchFirst()
+
+ Positions the result to the first record in the result. This
+ function is only called if the result is in an active state.
+ Derived classes must reimplement this function and position the result
+ to the first record, and call setAt() with an appropriate value.
+ Return TRUE to indicate success, or FALSE to signify failure.
+*/
+
+/*!
+ \fn bool QSqlResult::fetchLast()
+
+ Positions the result to the last record in the result. This
+ function is only called if the result is in an active state.
+ Derived classes must reimplement this function and position the result
+ to the last record, and call setAt() with an appropriate value.
+ Return TRUE to indicate success, or FALSE to signify failure.
+*/
+
+/*!
+ Positions the result to the next available record in the result.
+ This function is only called if the result is in an active state.
+ The default implementation calls fetch() with the next index.
+ Derived classes can reimplement this function and position the result
+ to the next record in some other way, and call setAt() with an
+ appropriate value. Return TRUE to indicate success, or FALSE to
+ signify failure.
+*/
+
+bool QSqlResult::fetchNext()
+{
+ return fetch( at() + 1 );
+}
+
+/*!
+ Positions the result to the previous available record in the
+ result. This function is only called if the result is in an active
+ state. The default implementation calls fetch() with the previous
+ index. Derived classes can reimplement this function and position the
+ result to the next record in some other way, and call setAt() with
+ an appropriate value. Return TRUE to indicate success, or FALSE to
+ signify failure.
+*/
+
+bool QSqlResult::fetchPrev()
+{
+ return fetch( at() - 1 );
+}
+
+/*!
+ Returns TRUE if you can only scroll forward through a result set;
+ otherwise returns FALSE.
+*/
+bool QSqlResult::isForwardOnly() const
+{
+ return forwardOnly;
+}
+
+/*!
+ Sets forward only mode to \a forward. If forward is TRUE only
+ fetchNext() is allowed for navigating the results. Forward only
+ mode needs far less memory since results do not have to be cached.
+ forward only mode is off by default.
+
+ \sa fetchNext()
+*/
+void QSqlResult::setForwardOnly( bool forward )
+{
+ forwardOnly = forward;
+}
+
+// XXX BCI HACK - remove in 4.0
+/*! \internal */
+void QSqlResult::setExtension( QSqlExtension * ext )
+{
+ if ( d->ext )
+ delete d->ext;
+ d->ext = ext;
+}
+
+/*! \internal */
+QSqlExtension * QSqlResult::extension()
+{
+ return d->ext;
+}
+#endif // QT_NO_SQL