File indexing completed on 2024-05-05 04:49:16

 /****************************************************************************************
  * Copyright (c) 2007 Maximilian Kossick <maximilian.kossick@googlemail.com>            *
  * Copyright (c) 2007 Nikolaj Hald Nielsen <nhn@kde.org>                                *
  * Copyright (c) 2008 Casey Link <unnamedrambler@gmail.com>                             *
  *                                                                                      *
  * This program 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 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 General Public License for more details.             *
  *                                                                                      *
  * You should have received a copy of the GNU General Public License along with         *
  * this program.  If not, see <http://www.gnu.org/licenses/>.                           *
  ****************************************************************************************/
 
 #ifndef SERVICECOLLECTION_H
 #define SERVICECOLLECTION_H
 
 #include "amarok_export.h"
 #include "core/collections/Collection.h"
 #include "core-impl/collections/support/MemoryCollection.h"
 #include "ServiceBase.h"
 
 #include <QIcon>
 
 #include <QtGlobal>
 #include <QSharedPointer>
 
 typedef QMap<int, Meta::TrackPtr> TrackIdMap;
 typedef QMap<int, Meta::ArtistPtr> ArtistIdMap;
 typedef QMap<int, Meta::AlbumPtr> AlbumIdMap;
 typedef QMap<int, Meta::GenrePtr> GenreIdMap;
 
 namespace Collections {
 
 /**
  *  This is a specialized collection that can be used by services who dynamically
  *  fetch their data from somewhere ( a web service, an external program, etc....)
  */
 
 class AMAROK_EXPORT ServiceCollection : public Collections::Collection
 {
     Q_OBJECT
     public:
         explicit ServiceCollection( ServiceBase * service = nullptr );
         ServiceCollection( ServiceBase * service, const QString &id, const QString &prettyName );
         ~ServiceCollection() override;
 
         Collections::QueryMaker* queryMaker() override;
 
         QString collectionId() const override;
         QString prettyName() const override;
         QIcon icon() const override { return QIcon::fromTheme(QStringLiteral("action-view-services-scripted-amarok")); }
 
         CollectionLocation* location() override;
 
         void emitUpdated();
 
         virtual QStringList query( const QString &query ) { Q_UNUSED( query ); return QStringList(); }
         virtual int insert( const QString &statement, const QString &table ) { Q_UNUSED( statement ); Q_UNUSED( table ); return 0; }
 
         virtual QString escape( const QString &text ) const { Q_UNUSED( text ); return QString(); }
 
 
         Meta::TrackPtr trackById( int id );
         Meta::AlbumPtr albumById( int id );
         Meta::ArtistPtr artistById( int id );
         Meta::GenrePtr genreById( int id );
 
         //Override some stuff to be able to handle id mappings
 
         void addTrack( const Meta::TrackPtr &trackPtr );
         void addArtist( const Meta::ArtistPtr &artistPtr );
         void addAlbum( const Meta::AlbumPtr &albumPtr );
         void addGenre( const Meta::GenrePtr &genrePtr );
 
         //TODO:
         //void setTrackMap( TrackMap map ) { m_trackMap = map; }
         //void setArtistMap( ArtistMap map ) { m_artistMap = map; }
         //void setAlbumMap( AlbumMap map ) { m_albumMap = map; }
         //void setGenreMap( GenreMap map ) { m_genreMap = map; }
 
         ServiceBase * service();
 
         //convenience functions for subclasses
         void acquireWriteLock() { m_mc->acquireWriteLock(); }
         void acquireReadLock() { m_mc->acquireReadLock(); }
         void releaseLock() { m_mc->releaseLock(); }
         GenreMap genreMap() const { return m_mc->genreMap(); }
         void setGenreMap( const GenreMap &map ) { m_mc->setGenreMap( map ); }
         ArtistMap artistMap() const { return m_mc->artistMap(); }
         void setArtistMap( const ArtistMap &map ) { m_mc->setArtistMap( map ); }
         TrackMap trackMap() const { return m_mc->trackMap(); }
         void setTrackMap( const TrackMap &map ) { m_mc->setTrackMap( map ); }
         AlbumMap albumMap() const { return m_mc->albumMap(); }
         void setAlbumMap( const AlbumMap &map ) { m_mc->setAlbumMap( map ); }
 
     private:
         ServiceBase * m_service;
         QSharedPointer<MemoryCollection> m_mc;
 
         QString m_collectionId;
         QString m_prettyName;
 
         TrackIdMap m_trackIdMap;
         ArtistIdMap m_artistIdMap;
         AlbumIdMap m_albumIdMap;
         GenreIdMap m_genreIdMap;
 };
 
 } //namespace Collections
 
 #endif