CTK/Libs/XNAT/Core/ctkXnatObject.h

/*=============================================================================

  Plugin: org.commontk.xnat

  Copyright (c) University College London,
    Centre for Medical Image Computing

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=============================================================================*/

#ifndef ctkXnatObject_h
#define ctkXnatObject_h

#include "ctkXNATCoreExport.h"

#include <QList>
#include <QObject>
#include <QString>
#include <QSharedPointer>
#include <QMetaType>

class ctkXnatConnection;
class ctkXnatObjectPrivate;

//----------------------------------------------------------------------------
/// \ingroup XNATCore
/// ctkXnatObject is the base class of the objects that represent the nodes in
/// the XNAT data hierarchy.
class CTK_XNAT_CORE_EXPORT ctkXnatObject
{

public:

  typedef QSharedPointer<ctkXnatObject> Pointer;
  typedef QWeakPointer<ctkXnatObject> WeakPointer;

  /// Destructs the ctkXnatObject.
  virtual ~ctkXnatObject();

  /// Gets the ID of the object.
  QString id() const;

  /// Gets the resource URI of the object that can be used to access it through
  /// the REST API.
  QString uri() const;

  /// Gets the name of the object.
  QString name() const;

  /// Gets the description of the object.
  QString description() const;

  /// Gets the value of the property with the given name.
  QString property(const QString& name) const;

  /// Sets the value of the property with the given name.
  void setProperty(const QString& name, const QVariant& value);

  /// Gets the list of the properties of the object.
  QList<QString> properties();
  
  /// Gets the parent of the object in the data hierarchy. The returned pointer
  /// is 0 for the ctkXnatServer objects and different for any other type of
  /// XNAT objects.
  ctkXnatObject::Pointer parent() const;

  /// Gets the children of the object.
  QList<ctkXnatObject::Pointer> children() const;

  /// Adds an object to the children of the current one.
  void addChild(Pointer& child);

  /// Removes the object from the children of the current object.
  void removeChild(Pointer& child);

  /// Tells if the children and the properties of the objects have been fetched.
  bool isFetched() const;

  /// Resets the object so that its properties and children needs to be fetched
  /// again at the next request.
  virtual void reset();

  /// Fetches the children and the properties of the object.
  void fetch();

  /// Removes the object from the XNAT server.
  virtual void remove();

  virtual void download(const QString&);
  virtual void upload(const QString&);

protected:

  /// Constructs the ctkXnatObject.
  ctkXnatObject();

  /// Constructs the ctkXnatObject with the given private part.
  ctkXnatObject(ctkXnatObjectPrivate& dd);

  /// Gets the object that represents the connection to the XNAT server
  /// that stores the current object.
  virtual ctkXnatConnection* connection() const;

  /// Sets the ID of the object.
  void setId(const QString& id);

  /// Sets the resource URI of the object that can be used to access it through
  /// the REST API.
  void setUri(const QString& uri);

  /// Sets the name of the object.
  void setName(const QString& name);

  /// Sets the description of the object.
  void setDescription(const QString& description);

  /// The private implementation part of the object.
  const QScopedPointer<ctkXnatObjectPrivate> d_ptr;

private:

  friend class ctkXnatConnection;

  /// The implementation of the fetch mechanism, called by the fetch() function.
  virtual void fetchImpl() = 0;

  Q_DECLARE_PRIVATE(ctkXnatObject)
  Q_DISABLE_COPY(ctkXnatObject)
};

Q_DECLARE_METATYPE(ctkXnatObject::Pointer)

#endif