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
6 // This file is part of Open CASCADE Technology software library.
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.
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
17 #ifndef _CDM_MetaData_HeaderFile
18 #define _CDM_MetaData_HeaderFile
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
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;
35 class TCollection_ExtendedString;
36 class CDM_Application;
40 DEFINE_STANDARD_HANDLE(CDM_MetaData, Standard_Transient)
43 class CDM_MetaData : public Standard_Transient
49 Standard_EXPORT static Handle(CDM_MetaData) LookUp (const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath, const TCollection_ExtendedString& aFileName, const Standard_Boolean ReadOnly);
51 Standard_EXPORT static Handle(CDM_MetaData) LookUp (const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath, const TCollection_ExtendedString& aVersion, const TCollection_ExtendedString& aFileName, const Standard_Boolean ReadOnly);
53 Standard_EXPORT Standard_Boolean IsRetrieved() const;
55 Standard_EXPORT Handle(CDM_Document) Document() const;
57 //! returns the folder in which the meta-data has to be created
58 //! or has to be found.
59 Standard_EXPORT TCollection_ExtendedString Folder() const;
61 //! returns the name under which the meta-data has to be created
62 //! or has to be found.
63 Standard_EXPORT TCollection_ExtendedString Name() const;
65 //! returns the version under which the meta-data has to be found.
66 //! Warning: raises NoSuchObject from Standard if no Version has been defined
67 Standard_EXPORT TCollection_ExtendedString Version() const;
69 //! indicates that the version has to be taken into account when
70 //! searching the corresponding meta-data.
71 Standard_EXPORT Standard_Boolean HasVersion() const;
73 Standard_EXPORT TCollection_ExtendedString FileName() const;
75 Standard_EXPORT Standard_OStream& Print (Standard_OStream& anOStream) const;
76 Standard_OStream& operator << (Standard_OStream& anOStream);
78 Standard_EXPORT TCollection_ExtendedString Path() const;
80 Standard_EXPORT void UnsetDocument();
82 Standard_EXPORT Standard_Boolean IsReadOnly() const;
84 Standard_EXPORT void SetIsReadOnly();
86 Standard_EXPORT void UnsetIsReadOnly();
89 friend class CDM_Reference;
91 //! associates database information to a document which
92 //! has been stored. The name of the document is now the
93 //! name which has beenused to store the data.
94 Standard_EXPORT void CDM_Document::SetMetaData (const Handle(CDM_MetaData)& aMetaData);
96 Standard_EXPORT void CDM_Application::SetDocumentVersion (const Handle(CDM_Document)& aDocument, const Handle(CDM_MetaData)& aMetaData) const;
99 DEFINE_STANDARD_RTTI(CDM_MetaData,Standard_Transient)
109 Standard_EXPORT CDM_MetaData(const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath, const TCollection_ExtendedString& aFileName, const Standard_Boolean ReadOnly);
111 Standard_EXPORT CDM_MetaData(const TCollection_ExtendedString& aFolder, const TCollection_ExtendedString& aName, const TCollection_ExtendedString& aPath, const TCollection_ExtendedString& aVersion, const TCollection_ExtendedString& aFileName, const Standard_Boolean ReadOnly);
113 Standard_EXPORT void SetDocument (const Handle(CDM_Document)& aDocument);
115 Standard_EXPORT static const CDM_MetaDataLookUpTable& LookUpTable();
117 Standard_EXPORT Standard_Integer DocumentVersion (const Handle(CDM_Application)& anApplication);
119 Standard_Boolean myIsRetrieved;
120 CDM_DocumentPointer myDocument;
121 TCollection_ExtendedString myFolder;
122 TCollection_ExtendedString myName;
123 TCollection_ExtendedString myVersion;
124 Standard_Boolean myHasVersion;
125 TCollection_ExtendedString myFileName;
126 TCollection_ExtendedString myPath;
127 Standard_Integer myDocumentVersion;
128 Standard_Boolean myIsReadOnly;
139 #endif // _CDM_MetaData_HeaderFile