this class list the method that must be available for a specific DBMS More...

#include <CDF_MetaDataDriver.hxx>

Inheritance diagram for CDF_MetaDataDriver:

[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 method is useful 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_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 (const Handle< Message_Messenger > &theMessageDriver)

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

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
	CDF_MetaDataDriver ()

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

this class list the method that must be available for a specific DBMS

Constructor & Destructor Documentation

◆ CDF_MetaDataDriver()

CDF_MetaDataDriver::CDF_MetaDataDriver ( )

protected

Member Function Documentation

◆ BuildFileName()

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

pure virtual

Implemented in CDF_FWOSDriver.

◆ CreateDependsOn()

virtual void CDF_MetaDataDriver::CreateDependsOn	(	const Handle< CDM_MetaData > &	aFirstData,
		const Handle< CDM_MetaData > &	aSecondData )

virtual

Creates a "Depends On" relation between two Datas. By default does nothing.

◆ CreateMetaData()

virtual Handle< CDM_MetaData > CDF_MetaDataDriver::CreateMetaData	(	const Handle< CDM_Document > &	aDocument,
		const TCollection_ExtendedString &	aFileName )

pure virtual

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.

◆ CreateReference()

virtual void CDF_MetaDataDriver::CreateReference	(	const Handle< CDM_MetaData > &	aFrom,
		const Handle< CDM_MetaData > &	aTo,
		const Standard_Integer	aReferenceIdentifier,
		const Standard_Integer	aToDocumentVersion )

virtual

◆ DefaultFolder()

virtual TCollection_ExtendedString CDF_MetaDataDriver::DefaultFolder ( )

pure virtual

Implemented in CDF_FWOSDriver.

◆ Find() [1/2]

Standard_Boolean CDF_MetaDataDriver::Find	(	const TCollection_ExtendedString &	aFolder,
		const TCollection_ExtendedString &	aName )

calls Find with an empty version

◆ Find() [2/2]

virtual Standard_Boolean CDF_MetaDataDriver::Find	(	const TCollection_ExtendedString &	aFolder,
		const TCollection_ExtendedString &	aName,
		const TCollection_ExtendedString &	aVersion )

pure virtual

should indicate whether meta-data exist in the DBMS corresponding to the Data. aVersion may be NULL;

Implemented in CDF_FWOSDriver.

◆ FindFolder()

virtual Standard_Boolean CDF_MetaDataDriver::FindFolder ( const TCollection_ExtendedString & aFolder )

pure virtual

Implemented in CDF_FWOSDriver.

◆ HasReadPermission()

virtual Standard_Boolean CDF_MetaDataDriver::HasReadPermission	(	const TCollection_ExtendedString &	aFolder,
		const TCollection_ExtendedString &	aName,
		const TCollection_ExtendedString &	aVersion )

pure virtual

Implemented in CDF_FWOSDriver.

◆ HasVersion()

virtual Standard_Boolean CDF_MetaDataDriver::HasVersion	(	const TCollection_ExtendedString &	aFolder,
		const TCollection_ExtendedString &	aName )

virtual

by default return Standard_True.

◆ HasVersionCapability()

virtual Standard_Boolean CDF_MetaDataDriver::HasVersionCapability ( )

virtual

returns true if the MetaDataDriver can manage different versions of a Data. By default, returns Standard_False.

◆ LastVersion()

virtual Handle< CDM_MetaData > CDF_MetaDataDriver::LastVersion ( const Handle< CDM_MetaData > & aMetaData )

virtual

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;

◆ MetaData() [1/2]

Handle< CDM_MetaData > CDF_MetaDataDriver::MetaData	(	const TCollection_ExtendedString &	aFolder,
		const TCollection_ExtendedString &	aName )

calls MetaData with an empty version

◆ MetaData() [2/2]

virtual Handle< CDM_MetaData > CDF_MetaDataDriver::MetaData	(	const TCollection_ExtendedString &	aFolder,
		const TCollection_ExtendedString &	aName,
		const TCollection_ExtendedString &	aVersion )

pure virtual

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

◆ ReferenceIterator()

virtual Handle< PCDM_ReferenceIterator > CDF_MetaDataDriver::ReferenceIterator ( const Handle< Message_Messenger > & theMessageDriver )

virtual

◆ SetName()

virtual TCollection_ExtendedString CDF_MetaDataDriver::SetName	(	const Handle< CDM_Document > &	aDocument,
		const TCollection_ExtendedString &	aName )

virtual

this method is useful 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.

Reimplemented in CDF_FWOSDriver.

The documentation for this class was generated from the following file:

CDF_MetaDataDriver.hxx

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CDF_MetaDataDriver()

Member Function Documentation

◆ BuildFileName()

◆ CreateDependsOn()

◆ CreateMetaData()

◆ CreateReference()

◆ DefaultFolder()

◆ Find() [1/2]

◆ Find() [2/2]

◆ FindFolder()

◆ HasReadPermission()

◆ HasVersion()

◆ HasVersionCapability()

◆ LastVersion()

◆ MetaData() [1/2]

◆ MetaData() [2/2]

◆ ReferenceIterator()

◆ SetName()