/src/libtomahawk/database/DatabaseCommand_GenericSelect.h
http://github.com/tomahawk-player/tomahawk · C Header · 90 lines · 37 code · 14 blank · 39 comment · 0 complexity · 87592fcc698536cac73266199ed9a6a7 MD5 · raw file
- /* === This file is part of Tomahawk Player - <http://tomahawk-player.org> ===
- *
- * Copyright 2010-2011, Leo Franchi <lfranchi@kde.org>
- *
- * Tomahawk is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * Tomahawk 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with Tomahawk. If not, see <http://www.gnu.org/licenses/>.
- */
- #ifndef DATABASECOMMAND_GENERICSELECT_H
- #define DATABASECOMMAND_GENERICSELECT_H
- #include <QVariantMap>
- #include "DatabaseCommand.h"
- #include "Typedefs.h"
- #include <QStringList>
- #include <QMetaType>
- #include "DllMacro.h"
- namespace Tomahawk
- {
- /**
- * This dbcmd takes a generic SELECT command that operates on the database and returns a list of query_ptrs
- * that match.
- *
- * In order for the conversion to query_ptr to work, the SELECT command should select the following items:
- *
- * track query:
- * track.name, artist.name [, optional extra values ]
- *
- * artist query:
- * artist.id, artist.name [, optional extra values ]
- *
- * album query:
- * album.id, album.name, artist.id, artist.name [, optional extra values ]
- *
- * Any extra values in the resultset will be returned as a QVariantList attached to the "data" property of each query_ptr
- *
- * Notes:
- * * Do not trail your SQL command with ;
- * * Do not use the LIMIT command if you pass limitResults > -1
- *
- */
- class DLLEXPORT DatabaseCommand_GenericSelect : public DatabaseCommand
- {
- Q_OBJECT
- public:
- enum QueryType {
- Track,
- Artist,
- Album
- };
- explicit DatabaseCommand_GenericSelect( const QString& sqlSelect, QueryType type, int limitResults = -1, QObject* parent = 0 );
- explicit DatabaseCommand_GenericSelect( const QString& sqlSelect, QueryType type, bool rawData, QObject* parent = 0 );
- virtual void exec( DatabaseImpl* lib );
- virtual bool doesMutates() const { return false; }
- virtual QString commandname() const { return "genericselect"; }
- signals:
- void tracks( const QList< Tomahawk::query_ptr >& tracks );
- void artists( const QList< Tomahawk::artist_ptr >& artists );
- void albums( const QList< Tomahawk::album_ptr >& albums );
- void rawData( const QList< QStringList >& data );
- private:
- QString m_sqlSelect;
- QueryType m_queryType;
- int m_limit;
- bool m_raw;
- };
- }
- #endif // DATABASECOMMAND_GENERICSELECT_H