PropertyObject.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_PROPERTY_OBJECT_H
#define DATAQUAY_PROPERTY_OBJECT_H
 
#include <QString>
#include <QStringList>
#include <QHash>
#include <QVariant>
#include <QVariantList>
 
#include "Node.h"
 
namespace Dataquay
{
 
class Transaction;
class Store;
 
class PropertyObject
{
public:
    PropertyObject(Store *s, Uri myUri);
 
    PropertyObject(Store *s, QString myUri);
 
    PropertyObject(Store *s, Node myNode);
 
    PropertyObject(Store *s, QString propertyPrefix, Uri myUri);
 
    PropertyObject(Store *s, QString propertyPrefix, QString myUri);
 
    PropertyObject(Store *s, QString propertyPrefix, Node myNode);
 
    ~PropertyObject();
 
    Node getNode() const;
 
    Uri getObjectType() const;
 
    Uri getObjectType(Transaction *tx) const;
 
    bool hasProperty(QString name) const;
 
    bool hasProperty(Transaction *tx, QString name) const;
 
    QVariant getProperty(QString name) const;
 
    QVariant getProperty(Transaction *tx, QString name) const;
 
    QVariantList getPropertyList(QString name) const;
 
    QVariantList getPropertyList(Transaction *tx, QString name) const;
 
    Node getPropertyNode(QString name) const;
    
    Node getPropertyNode(Transaction *tx, QString name) const;
 
    Nodes getPropertyNodeList(QString name) const;
 
    Nodes getPropertyNodeList(Transaction *tx, QString name) const;
 
    QStringList getPropertyNames() const;
 
    QStringList getPropertyNames(Transaction *tx) const;
 
    void setProperty(QString name, QVariant value);
 
    void setProperty(QString name, Uri uri);
 
    void setProperty(QString name, Node node);
 
    void setProperty(Transaction *tx, QString name, QVariant value);
 
    void setProperty(Transaction *tx, QString name, Uri uri);
 
    void setProperty(Transaction *tx, QString name, Node node);
 
    void setPropertyList(QString name, QVariantList values);
 
    void setPropertyList(Transaction *tx, QString name, QVariantList values);
 
    void setPropertyList(QString name, Nodes nodes);
 
    void setPropertyList(Transaction *tx, QString name, Nodes nodes);
 
    void removeProperty(QString name);
 
    void removeProperty(Transaction *tx, QString name);
 
    Store *getStore(Transaction *tx) const;
 
    Uri getPropertyUri(QString name) const;
 
    static void setDefaultPropertyPrefix(QString prefix);
    
private:
    Store *m_store;
    QString m_pfx;
    Uri m_upfx;
    Node m_node;
    static QString m_defaultPrefix;
};
 
class CacheingPropertyObject
{
public:
    CacheingPropertyObject(Store *s, Uri myUri);
    CacheingPropertyObject(Store *s, QString myUri);
    CacheingPropertyObject(Store *s, QString propertyPrefix, Uri myUri);
    CacheingPropertyObject(Store *s, QString propertyPrefix, QString myUri);
    CacheingPropertyObject(Store *s, QString propertyPrefix, Node myUri);
 
    Uri getObjectType() const;
 
    bool hasProperty(QString name) const;
 
    QVariant getProperty(QString name) const;
    QVariantList getPropertyList(QString name) const;
    Node getPropertyNode(QString name) const;
    Nodes getPropertyNodeList(QString name) const;
    QStringList getPropertyNames() const;
 
    void setProperty(QString name, QVariant value);
    void setProperty(QString name, Uri value);
    void setProperty(QString name, Node node);
    void setPropertyList(QString name, QVariantList values);
    void setPropertyList(QString name, Nodes nodes);
 
    void removeProperty(QString name);
 
    Uri getPropertyUri(QString name) const;
 
private:
    PropertyObject m_po;
    typedef QHash<Uri, Nodes> Properties;
    mutable Properties m_cache; // note: value is never empty
    mutable bool m_cached;
    void encache() const;
};
 
}
 
#endif