Open CASCADE Technology 6.6.0
Public Member Functions | Protected Member Functions
CDF_MetaDataDriver Class Reference

#include <CDF_MetaDataDriver.hxx>

Inheritance diagram for CDF_MetaDataDriver:
Inheritance graph
[legend]

Public Member Functions

virtual Standard_Boolean HasVersionCapability ()
 returns true if the MetaDataDriver can manage different
versions of a Data.
By default, returns Standard_False.

virtual void CreateDependsOn (const Handle< CDM_MetaData > &aFirstData, const Handle< CDM_MetaData > &aSecondData)
 Creates a "Depends On" relation between two Datas.
By default does nothing

virtual void CreateReference (const Handle< CDM_MetaData > &aFrom, const Handle< CDM_MetaData > &aTo, const Standard_Integer aReferenceIdentifier, const Standard_Integer aToDocumentVersion)
virtual Standard_Boolean HasVersion (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
 by default return Standard_True.

virtual TCollection_ExtendedString BuildFileName (const Handle< CDM_Document > &aDocument)=0
virtual TCollection_ExtendedString SetName (const Handle< CDM_Document > &aDocument, const TCollection_ExtendedString &aName)
 this methods is usefull if the name of an object --
depends on the metadatadriver. For example a Driver

virtual Standard_Boolean Find (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion)=0
 should indicate whether meta-data exist in the DBMS corresponding
to the Data.
aVersion may be NULL;

virtual Standard_Boolean HasReadPermission (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion)=0
virtual Handle_CDM_MetaData MetaData (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion)=0
 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

virtual Handle_CDM_MetaData LastVersion (const Handle< CDM_MetaData > &aMetaData)
 by default returns aMetaDATA
//! 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;

virtual Handle_CDM_MetaData CreateMetaData (const Handle< CDM_Document > &aDocument, const TCollection_ExtendedString &aFileName)=0
 should create meta-data corresponding to aData and maintaining a meta-link
between these meta-data and aFileName
CreateMetaData is called by CreateData
//! If the metadata-driver
has version capabilities, version must be set in the returned Data.

virtual Standard_Boolean FindFolder (const TCollection_ExtendedString &aFolder)=0
virtual TCollection_ExtendedString DefaultFolder ()=0
virtual
Handle_PCDM_ReferenceIterator 
ReferenceIterator ()
Standard_Boolean Find (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
 calls Find with an empty version

Handle_CDM_MetaData MetaData (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
 calls MetaData with an empty version

Protected Member Functions

 CDF_MetaDataDriver ()

Constructor & Destructor Documentation

CDF_MetaDataDriver::CDF_MetaDataDriver ( ) [protected]

Member Function Documentation

virtual TCollection_ExtendedString CDF_MetaDataDriver::BuildFileName ( const Handle< CDM_Document > &  aDocument) [pure virtual]

Implemented in FWOSDriver_Driver.

virtual void CDF_MetaDataDriver::CreateDependsOn ( const Handle< CDM_MetaData > &  aFirstData,
const Handle< CDM_MetaData > &  aSecondData 
) [virtual]
virtual Handle_CDM_MetaData CDF_MetaDataDriver::CreateMetaData ( const Handle< CDM_Document > &  aDocument,
const TCollection_ExtendedString aFileName 
) [pure virtual]
virtual void CDF_MetaDataDriver::CreateReference ( const Handle< CDM_MetaData > &  aFrom,
const Handle< CDM_MetaData > &  aTo,
const Standard_Integer  aReferenceIdentifier,
const Standard_Integer  aToDocumentVersion 
) [virtual]
virtual TCollection_ExtendedString CDF_MetaDataDriver::DefaultFolder ( ) [pure virtual]

Implemented in FWOSDriver_Driver.

Standard_Boolean CDF_MetaDataDriver::Find ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName 
)
virtual Standard_Boolean CDF_MetaDataDriver::Find ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName,
const TCollection_ExtendedString aVersion 
) [pure virtual]

Implemented in FWOSDriver_Driver.

virtual Standard_Boolean CDF_MetaDataDriver::FindFolder ( const TCollection_ExtendedString aFolder) [pure virtual]

Implemented in FWOSDriver_Driver.

virtual Standard_Boolean CDF_MetaDataDriver::HasReadPermission ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName,
const TCollection_ExtendedString aVersion 
) [pure virtual]

Implemented in FWOSDriver_Driver.

virtual Standard_Boolean CDF_MetaDataDriver::HasVersion ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName 
) [virtual]
virtual Standard_Boolean CDF_MetaDataDriver::HasVersionCapability ( ) [virtual]
virtual Handle_CDM_MetaData CDF_MetaDataDriver::LastVersion ( const Handle< CDM_MetaData > &  aMetaData) [virtual]
virtual Handle_CDM_MetaData CDF_MetaDataDriver::MetaData ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName,
const TCollection_ExtendedString aVersion 
) [pure virtual]
Handle_CDM_MetaData CDF_MetaDataDriver::MetaData ( const TCollection_ExtendedString aFolder,
const TCollection_ExtendedString aName 
)
virtual Handle_PCDM_ReferenceIterator CDF_MetaDataDriver::ReferenceIterator ( ) [virtual]
virtual TCollection_ExtendedString CDF_MetaDataDriver::SetName ( const Handle< CDM_Document > &  aDocument,
const TCollection_ExtendedString aName 
) [virtual]

-- based on the operating system can choose to add
the extension of file to create to the object.

Reimplemented in FWOSDriver_Driver.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines