ObjectStorer.h

Go to the documentation of this file.

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
 
/*
    Dataquay
 
    A C++/Qt library for simple RDF datastore management.
    Copyright 2009-2012 Chris Cannam.
  
    Permission is hereby granted, free of charge, to any person
    obtaining a copy of this software and associated documentation
    files (the "Software"), to deal in the Software without
    restriction, including without limitation the rights to use, copy,
    modify, merge, publish, distribute, sublicense, and/or sell copies
    of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
    Except as contained in this notice, the name of Chris Cannam
    shall not be used in advertising or otherwise to promote the sale,
    use or other dealings in this Software without prior written
    authorization.
*/
 
#ifndef DATAQUAY_OBJECT_STORER_H
#define DATAQUAY_OBJECT_STORER_H
 
#include "../Node.h"
 
#include "ObjectMapperDefs.h"
 
#include <QHash>
 
class QObject;
 
namespace Dataquay
{
 
class Store;
class TypeMapping;
 
class ObjectStorer
{
public:
    typedef QHash<QObject *, Node> ObjectNodeMap;
 
    ObjectStorer(Store *s);
    ~ObjectStorer();
 
    Store *getStore();
 
    void setTypeMapping(const TypeMapping &);
 
    const TypeMapping &getTypeMapping() const;
 
    enum PropertyStorePolicy {
 
        StoreIfChanged,
 
        StoreAlways
    };
 
    void setPropertyStorePolicy(PropertyStorePolicy policy);
 
    PropertyStorePolicy getPropertyStorePolicy() const;
 
    void setBlankNodePolicy(BlankNodePolicy policy);
 
    BlankNodePolicy getBlankNodePolicy() const;
 
    enum FollowOption {
        FollowNone             = 0, // the default
        FollowObjectProperties = 1,
        FollowParent           = 2,
        FollowSiblings         = 4,
        FollowChildren         = 8
        // there is no FollowAll; it generally isn't a good idea
    };
    typedef int FollowPolicy;
 
    void setFollowPolicy(FollowPolicy policy);
    FollowPolicy getFollowPolicy() const;
 
    Uri store(QObject *o);
 
    Uri store(QObject *o, ObjectNodeMap &map);
 
    void store(QObjectList o);
 
    void store(QObjectList o, ObjectNodeMap &map);
 
    void removeObject(Node node);
 
    struct StoreCallback {
        virtual ~StoreCallback() { }
        
        virtual void stored(ObjectStorer *, ObjectNodeMap &, QObject *, Node) = 0;
    };
 
    void addStoreCallback(StoreCallback *callback);
 
private:
    ObjectStorer(const ObjectStorer &);
    ObjectStorer &operator=(const ObjectStorer &);
 
    class D;
    D *m_d;
};
 
}
 
#endif