FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoPropertyDefinition Class Reference

#include <PropertyDefinition.h>

Inherits FdoSchemaElement.

Inherited by FdoAssociationPropertyDefinition, FdoDataPropertyDefinition, FdoGeometricPropertyDefinition, FdoObjectPropertyDefinition, FdoRasterPropertyDefinition, and FdoTopoFeaturePropertyDefinition.

Inheritance diagram for FdoPropertyDefinition:

[legend]
List of all members.

Detailed Description

FdoPropertyDefinition is an abstract class that derives from FdoSchemaElement. FdoPropertyDefinition is the base class of FdoDataPropertyDefinition, FdoGeometricPropertyDefinition, and FdoObjectPropertyDefinition.

Definition at line 33 of file PropertyDefinition.h.


Public Member Functions

virtual void _writeXml (FdoSchemaXmlContext *pContext)
 Serialize this property to XML.
virtual FDO_API bool GetIsSystem ()
 Returns a Boolean value that indicates if this is a system generated property.
virtual FDO_API FdoPropertyType GetPropertyType ()=0
 Abstract operation that must be implemented by derived classes to return the concrete property type.
virtual FDO_API FdoStringP GetQualifiedName ()
 Gets the fully qualified name of this property.
virtual void InitFromXml (FdoSchemaXmlContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this property from its XML attributes.
virtual void InitFromXml (FdoString *propertyTypeName, FdoSchemaXmlContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this property from its XML attributes.
virtual void Set (FdoPropertyDefinition *pProperty, FdoSchemaMergeContext *pContext)
 DOXYGEN-IGNORE Public non-API functions for XML and Schema Merge support Update this property from the given property.
virtual FDO_API void SetIsSystem (bool value)
 Sets whether this is a system property. This function must only be called by an FDO Provider. Typically, it would be called by the DescribeSchema command implementation.

Protected Member Functions

 FdoPropertyDefinition (FdoString *name, FdoString *description, bool system=false)
 FdoPropertyDefinition ()
 Constructs a default instance of a PropertyDefinition.
virtual ~FdoPropertyDefinition ()

Protected Attributes

bool m_system

Constructor & Destructor Documentation

FdoPropertyDefinition::FdoPropertyDefinition  )  [protected]
 

Constructs a default instance of a PropertyDefinition.

FdoPropertyDefinition::FdoPropertyDefinition FdoString name,
FdoString description,
bool  system = false
[protected]
 

Constructs an instance of a PropertyDefinition using the specified arguments.

virtual FdoPropertyDefinition::~FdoPropertyDefinition  )  [protected, virtual]
 


Member Function Documentation

virtual void FdoPropertyDefinition::_writeXml FdoSchemaXmlContext *  pContext  )  [virtual]
 

Serialize this property to XML.

Reimplemented from FdoSchemaElement.

Reimplemented in FdoAssociationPropertyDefinition, FdoDataPropertyDefinition, FdoGeometricPropertyDefinition, FdoObjectPropertyDefinition, FdoRasterPropertyDefinition, FdoTopoFeaturePropertyDefinition, and FdoTopoGeometryPropertyDefinition.

virtual FDO_API bool FdoPropertyDefinition::GetIsSystem  )  [virtual]
 

Returns a Boolean value that indicates if this is a system generated property.

Returns:
Returns true if this property is system generated, false otherwise.
System properties are not written out to the XML schema file, which remains provider-portable.

virtual FDO_API FdoPropertyType FdoPropertyDefinition::GetPropertyType  )  [pure virtual]
 

Abstract operation that must be implemented by derived classes to return the concrete property type.

Returns:
Returns the property type

Implemented in FdoAssociationPropertyDefinition, FdoDataPropertyDefinition, FdoGeometricPropertyDefinition, FdoObjectPropertyDefinition, and FdoRasterPropertyDefinition.

virtual FDO_API FdoStringP FdoPropertyDefinition::GetQualifiedName  )  [virtual]
 

Gets the fully qualified name of this property.

Returns:
Returns {schema_name}:{class_name}.{property_name}

Reimplemented from FdoSchemaElement.

virtual void FdoPropertyDefinition::InitFromXml FdoSchemaXmlContext *  pContext,
FdoXmlAttributeCollection attrs
[virtual]
 

Initialize this property from its XML attributes.

Reimplemented from FdoSchemaElement.

Reimplemented in FdoTopoFeaturePropertyDefinition, and FdoTopoGeometryPropertyDefinition.

virtual void FdoPropertyDefinition::InitFromXml FdoString propertyTypeName,
FdoSchemaXmlContext *  pContext,
FdoXmlAttributeCollection attrs
[virtual]
 

Initialize this property from its XML attributes.

Reimplemented in FdoAssociationPropertyDefinition, FdoDataPropertyDefinition, FdoGeometricPropertyDefinition, FdoObjectPropertyDefinition, FdoRasterPropertyDefinition, FdoTopoFeaturePropertyDefinition, and FdoTopoGeometryPropertyDefinition.

virtual void FdoPropertyDefinition::Set FdoPropertyDefinition pProperty,
FdoSchemaMergeContext pContext
[virtual]
 

DOXYGEN-IGNORE Public non-API functions for XML and Schema Merge support Update this property from the given property.

Reimplemented in FdoAssociationPropertyDefinition, FdoDataPropertyDefinition, FdoGeometricPropertyDefinition, FdoObjectPropertyDefinition, and FdoRasterPropertyDefinition.

virtual FDO_API void FdoPropertyDefinition::SetIsSystem bool  value  )  [virtual]
 

Sets whether this is a system property. This function must only be called by an FDO Provider. Typically, it would be called by the DescribeSchema command implementation.

Parameters:
value Input true if this is a system property.

Member Data Documentation

bool FdoPropertyDefinition::m_system [protected]
 

Definition at line 98 of file PropertyDefinition.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.