model.h

/*
 * This file is part of the syndication library
 *
 * Copyright (C) 2006 Frank Osterfeld <osterfeld@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 SYNDICATION_RDF_MODEL_H
#define SYNDICATION_RDF_MODEL_H

#include <syndication/rdf/document.h>
#include <syndication/rdf/resource.h>
#include <syndication/rdf/statement.h>

#include <syndication/rdf/literal.h>
#include <syndication/rdf/node.h>
#include <syndication/rdf/property.h>
#include <syndication/rdf/sequence.h>
#include <boost/shared_ptr.hpp>
#include <syndication/ksyndication_export.h>

#include <QtCore/QString>

template <class T> class QList;

namespace Syndication {
namespace RDF {

class SYNDICATION_EXPORT Model
{
    friend class ::Syndication::RDF::Document;
    friend class ::Syndication::RDF::Document::Private;
    friend class ::Syndication::RDF::Resource;
    friend class ::Syndication::RDF::Resource::ResourcePrivate;
    friend class ::Syndication::RDF::Statement;
    friend class ::Syndication::RDF::Statement::StatementPrivate;

    public:

        Model();

        Model(const Model& other);

        virtual ~Model();

        Model& operator=(const Model& other);

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

        virtual ResourcePtr createResource(const QString& uri=QString());

        virtual PropertyPtr createProperty(const QString& uri);

        virtual SequencePtr createSequence(const QString& uri=QString());

        virtual LiteralPtr createLiteral(const QString& text);

        virtual StatementPtr addStatement(ResourcePtr subject,
                                          PropertyPtr predicate,
                                          NodePtr object);

        virtual void removeStatement(ResourcePtr subject,
                                     PropertyPtr predicate,
                                     NodePtr object);

        virtual void removeStatement(StatementPtr statement);

        virtual bool isEmpty() const;

        virtual QList<ResourcePtr> resourcesWithType(ResourcePtr type) const;

        virtual QList<StatementPtr> statements() const;

        virtual NodePtr nodeByID(uint id) const;

        virtual ResourcePtr resourceByID(uint id) const;

        virtual PropertyPtr propertyByID(uint id) const;

        virtual LiteralPtr literalByID(uint id) const;
//@cond PRIVATE
        virtual bool resourceHasProperty(const Resource* resource,
                                         PropertyPtr property) const;

        virtual StatementPtr resourceProperty(const Resource* resource,
                                              PropertyPtr property) const;

        virtual QList<StatementPtr> resourceProperties(const Resource* resource,
                                              PropertyPtr property) const;

//@endcond
        virtual QString debugInfo() const;

    private:
        class ModelPrivate;
        boost::shared_ptr<ModelPrivate> d;
};


} // namespace RDF
} // namespace Syndication

#endif // SYNDICATION_RDF_MODEL_H