albaStorage.h

Go to the documentation of this file.

/*=========================================================================
 
 Program: ALBA (Agile Library for Biomedical Applications)
 Module: albaStorage
 Authors: Marco Petrone
 
 Copyright (c) BIC
 All rights reserved. See Copyright.txt or
 
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef __albaStorage_h__
#define __albaStorage_h__
 
#include "albaObject.h"
#include "albaString.h"
#include <set>
 
//----------------------------------------------------------------------------
// forward declarations :
//----------------------------------------------------------------------------
class albaStorageElement;
class albaStorable;
class albaObserver;
 
class ALBA_EXPORT albaStorage: public albaObject
{
public:
  albaAbstractTypeMacro(albaStorage,albaObject);
 
  enum STORAGE_IO_ERRORS {IO_OK=0,IO_GENERIC_ERROR,IO_WRONG_OBJECT_TYPE,IO_LAST_ERROR};
 
  albaStorage();
  virtual ~albaStorage() {}
 
  virtual void SetURL(const char *name);
 
  void ForceParserURL();
 
  const char *GetURL();
  
  const char *GetPareserURL();
 
  int Store();
  
  int Restore();
  
  void SetDocument (albaStorable *doc);
 
  albaStorable *GetDocument();
 
  virtual int ResolveInputURL(const char * url, albaString &filename, albaObserver *observer = NULL)=0;
 
  //virtual bool ResolveOutputURL(const albaCString url, albaString &filename)=0;
 
  virtual int StoreToURL(const char *filename, const char *url=NULL) = 0;
 
  virtual int ReleaseURL(const char *url) = 0;
 
  virtual void GetTmpFile(albaString &filename);
 
  void ReleaseTmpFile(const char *filename);
 
  bool IsFileInDirectory(const char *filename);
 
  virtual void SetTmpFolder(const char *folder) {m_TmpFolder=folder;}
 
  virtual const char* GetTmpFolder() {return m_TmpFolder;}
 
  void SetErrorCode(int err) {m_ErrorCode=err;}
  int GetErrorCode() {return m_ErrorCode;}
 
  bool NeedsUpgrade() {return m_NeedsUpgrade;};
 
protected:
  virtual int InternalStore()=0;
 
  virtual int InternalRestore()=0;
 
  virtual int OpenDirectory(const char *dir_name)=0;
 
  bool                 m_NeedsUpgrade; 
  albaStorable         *m_Document;        
  albaStorageElement   *m_DocumentElement; 
 
  albaString           m_URL;          
  albaString           m_ParserURL;    
  albaID               m_TmpFileId;    
  albaString           m_TmpFolder;    
  
  std::set<albaString> m_TmpFileNames; 
  std::set<albaString> m_FilesDictionary; 
  int                 m_ErrorCode;    
};
#endif // _albaStorage_h_