[occt.git] / src / CDF / CDF_MetaDataDriver.cdl

-- Created on: 1997-11-17
-- Created by: Jean-Louis Frenkel
-- Copyright (c) 1997-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.


deferred class MetaDataDriver from CDF inherits Transient from Standard


uses
    Document from CDM, MetaData from CDM,
    ExtendedString from TCollection,
    ReferenceIterator from PCDM
    
raises 
    NotImplemented from Standard
is

    Initialize;

    ---Category: virtual methods

    HasVersionCapability(me: mutable)
    ---Purpose: returns true if the MetaDataDriver can manage different
    --          versions of a Data.
    --          By default, returns Standard_False.
    returns Boolean from Standard
    is virtual;

    CreateDependsOn(me: mutable; aFirstData: MetaData from CDM;
                                aSecondData: MetaData from CDM)
    ---Purpose: Creates a "Depends On"  relation between two Datas.
    --          By default does nothing
    is virtual;
    
    CreateReference(me: mutable; aFrom, aTo: MetaData from CDM; aReferenceIdentifier: Integer from Standard; aToDocumentVersion: Integer from Standard)
    is virtual;
    
    HasVersion(me: mutable; aFolder, aName: ExtendedString from TCollection)
    returns Boolean from Standard
    ---Purpose: by default return Standard_True.
    is virtual;
    
    BuildFileName(me: mutable; aDocument: Document from CDM)
    returns ExtendedString from TCollection
    is deferred;

    SetName(me: mutable; aDocument: Document from CDM; aName: ExtendedString from TCollection)
    returns ExtendedString from TCollection
    is virtual;
    ---Purpose: this methods  is usefull if the name  of an  object --
    --           depends on  the metadatadriver. For  example a Driver
    --           -- based  on the operating  system can choose to  add
    --           the extension of file to create to the object.
    
---Category: Deferred methods

    ---Overview: inquiring can be made either using a folder, a name and eventually
    --           a version 
    --           or a path which is the concatenation of a folder, a name  and eventually
    --           a version.
    Find(me: mutable; aFolder, aName, aVersion: ExtendedString from TCollection)
    returns Boolean from Standard
    ---Purpose: should indicate whether meta-data exist in the DBMS corresponding 
    --          to the Data.
    --          aVersion may be NULL;
    is deferred;
    
    HasReadPermission(me: mutable; aFolder, aName, aVersion: ExtendedString from TCollection)
    returns Boolean from Standard
    is deferred;
    
    MetaData(me: mutable; aFolder, aName, aVersion: ExtendedString from TCollection)
    returns MetaData from CDM
    ---Purpose: should return the MetaData stored in the DBMS with the meta-data
    --          corresponding to the Data. If the MetaDataDriver has version management capabilities
    --          the version has to be set in the returned MetaData.
    --          aVersion may be NULL
    --          MetaData is called by GetMetaData
    --          If the version is  set to NULL, MetaData should return
    --          the last version of the metadata 
    is deferred;
    
    LastVersion(me: mutable; aMetaData: MetaData from CDM)
    returns MetaData from CDM
    is virtual;
    ---Purpose: by default returns aMetaDATA
	    
--    MetaData(me: mutable; aPath: ExtendedString from TCollection)
--    returns MetaData from CDM
    ---Purpose: should return the MetaData stored in the DBMS with the meta-data
    --          corresponding to the path. If the MetaDataDriver has version management capabilities
    --          the version has to be set in the returned MetaData.
    --          MetaData is called by GetMetaData
    --          If the version is not included in the path , MetaData should return
    --          the last version of the metadata 
--    is deferred;
    

    CreateMetaData(me: mutable; aDocument: Document from CDM;
    	         aFileName: ExtendedString from TCollection)
    ---Purpose:  should create meta-data corresponding to aData and maintaining a meta-link
    --           between these meta-data and aFileName
    --           CreateMetaData is called by CreateData
    returns  MetaData from CDM
    ---Purpose: If the metadata-driver 
    --          has version capabilities, version must be set in the returned Data.
    is deferred;
    
    FindFolder(me: mutable; aFolder: ExtendedString from TCollection)
    returns Boolean from Standard
    is deferred;

   DefaultFolder(me: mutable) returns ExtendedString from TCollection
   is deferred;
   
   
---Category:  methods about references.

    ReferenceIterator(me: mutable)
    returns ReferenceIterator from PCDM
    is virtual;
    

    Find(me: mutable; aFolder, aName: ExtendedString from TCollection)
    returns Boolean from Standard;
    ---Purpose: calls Find with an empty version

    MetaData(me: mutable; aFolder, aName: ExtendedString from TCollection)
    returns MetaData from CDM;
    ---Purpose: calls MetaData with an empty version
    

end MetaDataDriver from CDF;
Commit	Line	Data
b311480e	1	-- Created on: 1997-11-17
	2	-- Created by: Jean-Louis Frenkel
	3	-- Copyright (c) 1997-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	5	--
	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
7fd59977	21
	22	deferred class MetaDataDriver from CDF inherits Transient from Standard
	23
	24
	25	uses
	26	Document from CDM, MetaData from CDM,
	27	ExtendedString from TCollection,
	28	ReferenceIterator from PCDM
	29
	30	raises
	31	NotImplemented from Standard
	32	is
	33
	34	Initialize;
	35
	36	---Category: virtual methods
	37
	38	HasVersionCapability(me: mutable)
	39	---Purpose: returns true if the MetaDataDriver can manage different
	40	-- versions of a Data.
	41	-- By default, returns Standard_False.
	42	returns Boolean from Standard
	43	is virtual;
	44
	45	CreateDependsOn(me: mutable; aFirstData: MetaData from CDM;
	46	aSecondData: MetaData from CDM)
	47	---Purpose: Creates a "Depends On" relation between two Datas.
	48	-- By default does nothing
	49	is virtual;
	50
	51	CreateReference(me: mutable; aFrom, aTo: MetaData from CDM; aReferenceIdentifier: Integer from Standard; aToDocumentVersion: Integer from Standard)
	52	is virtual;
	53
	54	HasVersion(me: mutable; aFolder, aName: ExtendedString from TCollection)
	55	returns Boolean from Standard
	56	---Purpose: by default return Standard_True.
	57	is virtual;
	58
	59	BuildFileName(me: mutable; aDocument: Document from CDM)
	60	returns ExtendedString from TCollection
	61	is deferred;
	62
	63	SetName(me: mutable; aDocument: Document from CDM; aName: ExtendedString from TCollection)
	64	returns ExtendedString from TCollection
	65	is virtual;
	66	---Purpose: this methods is usefull if the name of an object --
	67	-- depends on the metadatadriver. For example a Driver
	68	-- -- based on the operating system can choose to add
	69	-- the extension of file to create to the object.
	70
	71	---Category: Deferred methods
	72
	73	---Overview: inquiring can be made either using a folder, a name and eventually
	74	-- a version
	75	-- or a path which is the concatenation of a folder, a name and eventually
	76	-- a version.
	77	Find(me: mutable; aFolder, aName, aVersion: ExtendedString from TCollection)
	78	returns Boolean from Standard
	79	---Purpose: should indicate whether meta-data exist in the DBMS corresponding
	80	-- to the Data.
	81	-- aVersion may be NULL;
	82	is deferred;
	83
	84	HasReadPermission(me: mutable; aFolder, aName, aVersion: ExtendedString from TCollection)
85	returns Boolean from Standard
86	is deferred;
87
88	MetaData(me: mutable; aFolder, aName, aVersion: ExtendedString from TCollection)
89	returns MetaData from CDM
90	---Purpose: should return the MetaData stored in the DBMS with the meta-data
91	-- corresponding to the Data. If the MetaDataDriver has version management capabilities
92	-- the version has to be set in the returned MetaData.
93	-- aVersion may be NULL
94	-- MetaData is called by GetMetaData
95	-- If the version is set to NULL, MetaData should return
96	-- the last version of the metadata
97	is deferred;
98
99	LastVersion(me: mutable; aMetaData: MetaData from CDM)
100	returns MetaData from CDM
101	is virtual;
102	---Purpose: by default returns aMetaDATA
103
104	-- MetaData(me: mutable; aPath: ExtendedString from TCollection)
105	-- returns MetaData from CDM
106	---Purpose: should return the MetaData stored in the DBMS with the meta-data
107	-- corresponding to the path. If the MetaDataDriver has version management capabilities
108	-- the version has to be set in the returned MetaData.
109	-- MetaData is called by GetMetaData
110	-- If the version is not included in the path , MetaData should return
111	-- the last version of the metadata
112	-- is deferred;
113
114
115
116
117	CreateMetaData(me: mutable; aDocument: Document from CDM;
118	aFileName: ExtendedString from TCollection)
119	---Purpose: should create meta-data corresponding to aData and maintaining a meta-link
120	-- between these meta-data and aFileName
121	-- CreateMetaData is called by CreateData
122	returns MetaData from CDM
123	---Purpose: If the metadata-driver
124	-- has version capabilities, version must be set in the returned Data.
125	is deferred;
126
127	FindFolder(me: mutable; aFolder: ExtendedString from TCollection)
128	returns Boolean from Standard
129	is deferred;
130
131	DefaultFolder(me: mutable) returns ExtendedString from TCollection
132	is deferred;
133
134
135	---Category: methods about references.
136
137	ReferenceIterator(me: mutable)
138	returns ReferenceIterator from PCDM
139	is virtual;
140
141
142	Find(me: mutable; aFolder, aName: ExtendedString from TCollection)
143	returns Boolean from Standard;
144	---Purpose: calls Find with an empty version
145
146	MetaData(me: mutable; aFolder, aName: ExtendedString from TCollection)
147	returns MetaData from CDM;
148	---Purpose: calls MetaData with an empty version
149
150
151	end MetaDataDriver from CDF;