#include <CDF_MetaDataDriver.hxx>

Inheritance diagram for CDF_MetaDataDriver:

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

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 More...

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. More...

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 – based on the operating system can choose to add the extension of file to create to the object. More...

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; More...

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 More...

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; More...

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. More...

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 More...

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

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

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

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

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

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

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const Handle_Standard_Type &theType) const
	Returns a true value if this is an instance of Type. More...

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

Standard_Boolean	IsKind (const 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. More...

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. More...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

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

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

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

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.

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.

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 FWOSDriver_Driver.

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

calls Find with an empty version

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

by default return Standard_True.

virtual Standard_Boolean CDF_MetaDataDriver::HasVersionCapability ( )

virtual

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

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;

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

Handle_CDM_MetaData CDF_MetaDataDriver::MetaData	(	const TCollection_ExtendedString &	aFolder,
		const TCollection_ExtendedString &	aName
	)

calls MetaData with an empty version

virtual Handle_PCDM_ReferenceIterator CDF_MetaDataDriver::ReferenceIterator ( )

virtual

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

virtual

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.

Reimplemented in FWOSDriver_Driver.

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

CDF_MetaDataDriver.hxx

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation