src/CDM/CDM_MetaData.hxx

   1 // Created on: 1997-10-22
   2 // Created by: Jean-Louis Frenkel
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _CDM_MetaData_HeaderFile
  18 #define _CDM_MetaData_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Boolean.hxx>
  24 #include <CDM_DocumentPointer.hxx>
  25 #include <TCollection_ExtendedString.hxx>
  26 #include <Standard_Integer.hxx>
  27 #include <Standard_Transient.hxx>
  28 #include <CDM_Document.hxx>
  29 #include <CDM_Application.hxx>
  30 #include <Standard_OStream.hxx>
  31 #include <CDM_MetaDataLookUpTable.hxx>
  32 class Standard_NoSuchObject;
  33 class CDM_Reference;
  34 class CDM_Document;
  35 class TCollection_ExtendedString;
  36 class CDM_Application;
  37
  38
  39 class CDM_MetaData;
  40 DEFINE_STANDARD_HANDLE(CDM_MetaData, Standard_Transient)
  41
  42
  43 class CDM_MetaData : public Standard_Transient
  44 {
  45
  46 public:
  47
  48   Standard_EXPORT static Handle(CDM_MetaData) LookUp (CDM_MetaDataLookUpTable& theLookUpTable,
  49                                                       const TCollection_ExtendedString& aFolder,
  50                                                       const TCollection_ExtendedString& aName,
  51                                                       const TCollection_ExtendedString& aPath,
  52                                                       const TCollection_ExtendedString& aFileName,
  53                                                       const Standard_Boolean ReadOnly);
  54
  55   Standard_EXPORT static Handle(CDM_MetaData) LookUp (CDM_MetaDataLookUpTable& theLookUpTable,
  56                                                       const TCollection_ExtendedString& aFolder,
  57                                                       const TCollection_ExtendedString& aName,
  58                                                       const TCollection_ExtendedString& aPath,
  59                                                       const TCollection_ExtendedString& aVersion,
  60                                                       const TCollection_ExtendedString& aFileName,
  61                                                       const Standard_Boolean ReadOnly);
  62
  63   Standard_EXPORT Standard_Boolean IsRetrieved() const;
  64
  65   Standard_EXPORT Handle(CDM_Document) Document() const;
  66
  67   //! returns the folder in which the meta-data has to be created
  68   //! or has to be found.
  69   Standard_EXPORT TCollection_ExtendedString Folder() const;
  70
  71   //! returns the name under which the meta-data has to be created
  72   //! or has to be found.
  73   Standard_EXPORT TCollection_ExtendedString Name() const;
  74
  75   //! returns the version under which the meta-data has to be found.
  76   //! Warning: raises NoSuchObject from Standard if no Version has been defined
  77   Standard_EXPORT TCollection_ExtendedString Version() const;
  78
  79   //! indicates that the version has to be taken into account when
  80   //! searching the corresponding meta-data.
  81   Standard_EXPORT Standard_Boolean HasVersion() const;
  82
  83   Standard_EXPORT TCollection_ExtendedString FileName() const;
  84
  85   Standard_EXPORT Standard_OStream& Print (Standard_OStream& anOStream) const;
  86 Standard_OStream& operator << (Standard_OStream& anOStream);
  87
  88   Standard_EXPORT TCollection_ExtendedString Path() const;
  89
  90   Standard_EXPORT void UnsetDocument();
  91
  92   Standard_EXPORT Standard_Boolean IsReadOnly() const;
  93
  94   Standard_EXPORT void SetIsReadOnly();
  95
  96   Standard_EXPORT void UnsetIsReadOnly();
  97
  98   //! Dumps the content of me into the stream
  99   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
 100
 101
 102 friend class CDM_Reference;
 103 friend
 104   //! associates database  information to  a document which
 105   //! has been stored.  The name of the  document is now the
 106   //! name which has beenused to store the data.
 107   Standard_EXPORT void CDM_Document::SetMetaData (const Handle(CDM_MetaData)& aMetaData);
 108 friend
 109   Standard_EXPORT void CDM_Application::SetDocumentVersion (const Handle(CDM_Document)& aDocument, const Handle(CDM_MetaData)& aMetaData) const;
 110
 111
 112   DEFINE_STANDARD_RTTIEXT(CDM_MetaData,Standard_Transient)
 113
 114 private:
 115
 116   CDM_MetaData (const TCollection_ExtendedString& aFolder,
 117                 const TCollection_ExtendedString& aName,
 118                 const TCollection_ExtendedString& aPath,
 119                 const TCollection_ExtendedString& aFileName,
 120                 const Standard_Boolean ReadOnly);
 121
 122   CDM_MetaData (const TCollection_ExtendedString& aFolder,
 123                 const TCollection_ExtendedString& aName,
 124                 const TCollection_ExtendedString& aPath,
 125                 const TCollection_ExtendedString& aVersion,
 126                 const TCollection_ExtendedString& aFileName,
 127                 const Standard_Boolean ReadOnly);
 128
 129   void SetDocument (const Handle(CDM_Document)& aDocument);
 130
 131   Standard_Integer DocumentVersion (const Handle(CDM_Application)& anApplication);
 132
 133 private:
 134
 135   Standard_Boolean myIsRetrieved;
 136   CDM_DocumentPointer myDocument;
 137   TCollection_ExtendedString myFolder;
 138   TCollection_ExtendedString myName;
 139   TCollection_ExtendedString myVersion;
 140   Standard_Boolean myHasVersion;
 141   TCollection_ExtendedString myFileName;
 142   TCollection_ExtendedString myPath;
 143   Standard_Integer myDocumentVersion;
 144   Standard_Boolean myIsReadOnly;
 145
 146
 147 };
 148
 149
 150
 151
 152
 153
 154
 155 #endif // _CDM_MetaData_HeaderFile