entity.h

Go to the documentation of this file.

/* This file is part of the Nepomuk-KDE libraries
   Copyright (c) 2007-2010 Sebastian Trueg <trueg@kde.org>

   This library 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 library 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 library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef _NEPOMUK_ENTITY_H_
#define _NEPOMUK_ENTITY_H_

#include <QtCore/QUrl>
#include <QtCore/QString>
#include <QtCore/QSharedData>
#include <QtCore/QHash>

#include <Soprano/Node>

#include <kglobal.h>
#include <klocale.h>

#include "nepomuk_export.h"

class QIcon;


namespace Nepomuk {
    namespace Types {
        class EntityPrivate;

        class NEPOMUK_EXPORT Entity
        {
        public:
            Entity( const Entity& );

            virtual ~Entity();

            Entity& operator=( const Entity& );

            QString name() const;

            QUrl uri() const;

            QString label( const QString& language = KGlobal::locale()->language() );

            QString label( const QString& language = KGlobal::locale()->language() ) const;

            QString comment( const QString& language = KGlobal::locale()->language() );

            QString comment( const QString& language = KGlobal::locale()->language() ) const;

            QIcon icon();

            QIcon icon() const;

            bool isValid() const;

            bool isAvailable();

            bool isAvailable() const;

            void reset( bool recursive = false );

            bool userVisible() const;

            operator QUrl() const { return uri(); }

            bool operator==( const Entity& other ) const;

            bool operator==( const QUrl& other ) const;

            bool operator!=( const Entity& other ) const;

            bool operator!=( const QUrl& other ) const;

        protected:
            Entity();

            QExplicitlySharedDataPointer<EntityPrivate> d;
        };

        inline uint qHash( const Entity& c )
        {
            return qHash( c.uri() );
        }
    }
}

#ifndef DISABLE_NEPOMUK_LEGACY

namespace Nepomuk {

    class Ontology;

    class KDE_DEPRECATED NEPOMUK_EXPORT Entity
    {
    public:
        Entity( const Entity& );
        ~Entity();

        Entity& operator=( const Entity& );

        const Ontology* definingOntology() const;

        QString name() const;

        QUrl uri() const;

        QString label( const QString& language = QString() ) const;
        QString comment( const QString& language = QString() ) const;

    protected:
        Entity();

    private:
        class Private;
        QSharedDataPointer<Private> d;

        friend class OntologyManager;
    };
}

#endif // DISABLE_NEPOMUK_LEGACY

#endif // _NEPOMUK_ENTITY_H_