OCC Main Page | ApplicationFramework | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ApplicationFramework
TKCDF
CDF


CDF_MetaDataDriver Class Reference

#include <CDF_MetaDataDriver.hxx>

Inheritance diagram for CDF_MetaDataDriver:

Inheritance graph
[legend]

Public Member Functions

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

virtual Standard_EXPORT 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 Standard_EXPORT void CreateReference (const Handle(CDM_MetaData)&aFrom, const Handle(CDM_MetaData)&aTo, const Standard_Integer aReferenceIdentifier, const Standard_Integer aToDocumentVersion)
virtual Standard_EXPORT Standard_Boolean HasVersion (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
 by default return Standard_True.

virtual Standard_EXPORT TCollection_ExtendedString BuildFileName (const Handle(CDM_Document)&aDocument)=0
virtual Standard_EXPORT 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
-- based on the operating system can choose to add
the extension of file to create to the object.

virtual Standard_EXPORT 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_EXPORT Standard_Boolean HasReadPermission (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName, const TCollection_ExtendedString &aVersion)=0
virtual Standard_EXPORT 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 Standard_EXPORT 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 Standard_EXPORT 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_EXPORT Standard_Boolean FindFolder (const TCollection_ExtendedString &aFolder)=0
virtual Standard_EXPORT TCollection_ExtendedString DefaultFolder ()=0
virtual Standard_EXPORT Handle_PCDM_ReferenceIterator ReferenceIterator ()
Standard_EXPORT Standard_Boolean Find (const TCollection_ExtendedString &aFolder, const TCollection_ExtendedString &aName)
 calls Find with an empty version

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

Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Protected Member Functions

Standard_EXPORT CDF_MetaDataDriver ()

Constructor & Destructor Documentation

Standard_EXPORT CDF_MetaDataDriver::CDF_MetaDataDriver  )  [protected]
 


Member Function Documentation

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

Implemented in FWOSDriver_Driver.

virtual Standard_EXPORT void CDF_MetaDataDriver::CreateDependsOn const Handle(CDM_MetaData)&  aFirstData,
const Handle(CDM_MetaData)&  aSecondData
[virtual]
 

virtual Standard_EXPORT Handle_CDM_MetaData CDF_MetaDataDriver::CreateMetaData const Handle(CDM_Document)&  aDocument,
const TCollection_ExtendedString &  aFileName
[pure virtual]
 

Implemented in FWOSDriver_Driver.

virtual Standard_EXPORT void CDF_MetaDataDriver::CreateReference const Handle(CDM_MetaData)&  aFrom,
const Handle(CDM_MetaData)&  aTo,
const Standard_Integer  aReferenceIdentifier,
const Standard_Integer  aToDocumentVersion
[virtual]
 

virtual Standard_EXPORT TCollection_ExtendedString CDF_MetaDataDriver::DefaultFolder  )  [pure virtual]
 

Implemented in FWOSDriver_Driver.

Standard_EXPORT Standard_Boolean CDF_MetaDataDriver::Find const TCollection_ExtendedString &  aFolder,
const TCollection_ExtendedString &  aName
 

virtual Standard_EXPORT 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_EXPORT Standard_Boolean CDF_MetaDataDriver::FindFolder const TCollection_ExtendedString &  aFolder  )  [pure virtual]
 

Implemented in FWOSDriver_Driver.

Standard_EXPORT const CDF_MetaDataDriver::Handle Standard_Type   )  const
 

Reimplemented in FWOSDriver_Driver.

virtual Standard_EXPORT 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_EXPORT Standard_Boolean CDF_MetaDataDriver::HasVersion const TCollection_ExtendedString &  aFolder,
const TCollection_ExtendedString &  aName
[virtual]
 

virtual Standard_EXPORT Standard_Boolean CDF_MetaDataDriver::HasVersionCapability  )  [virtual]
 

virtual Standard_EXPORT Handle_CDM_MetaData CDF_MetaDataDriver::LastVersion const Handle(CDM_MetaData)&  aMetaData  )  [virtual]
 

Standard_EXPORT Handle_CDM_MetaData CDF_MetaDataDriver::MetaData const TCollection_ExtendedString &  aFolder,
const TCollection_ExtendedString &  aName
 

virtual Standard_EXPORT Handle_CDM_MetaData CDF_MetaDataDriver::MetaData const TCollection_ExtendedString &  aFolder,
const TCollection_ExtendedString &  aName,
const TCollection_ExtendedString &  aVersion
[pure virtual]
 

Implemented in FWOSDriver_Driver.

virtual Standard_EXPORT Handle_PCDM_ReferenceIterator CDF_MetaDataDriver::ReferenceIterator  )  [virtual]
 

virtual Standard_EXPORT TCollection_ExtendedString CDF_MetaDataDriver::SetName const Handle(CDM_Document)&  aDocument,
const TCollection_ExtendedString &  aName
[virtual]
 

Reimplemented in FWOSDriver_Driver.


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 14:12:47 2008 for OpenCASCADE by  doxygen 1.4.1