FDO API Reference Feature Data Objects

FdoDataPropertyDefinition Class Reference

#include <DataPropertyDefinition.h>

Inherits FdoPropertyDefinition.

Inheritance diagram for FdoDataPropertyDefinition:

Inheritance graph
[legend]
List of all members.

Detailed Description

The FdoDataPropertyDefinition class derives from FdoPropertyDefinition and represents simple values or collections of simple values. FdoDataPropertyDefinitions can take on any of the data types listed in the FdoDataType enumeration.

Definition at line 36 of file DataPropertyDefinition.h.


Public Member Functions

virtual void _writeXml (FdoSchemaXmlContext *pContext)
 Serialize this property to XML.
FDO_API FdoDataType GetDataType ()
 Gets the FdoDataType of this property.
FDO_API FdoStringGetDefaultValue ()
 Gets the default value for this property. The default value is used when an instance of the containing class is created without specifying a value for this property.
FDO_API bool GetIsAutoGenerated ()
 Returns a Boolean value that indicates if this is an autogenerated property.
FDO_API FdoInt32 GetLength ()
 Gets the length of a String, BLOB, or CLOB data property. This value does not apply to any other FdoDataType.
FDO_API bool GetNullable ()
 Returns a Boolean value that indicates if this property's value can be null.
FDO_API FdoInt32 GetPrecision ()
 Gets the precision (total number of digits) of a decimal data property. This value does not apply to any other FdoDataType.
virtual FDO_API FdoPropertyType GetPropertyType ()
 Gets the concrete property type.
FDO_API bool GetReadOnly ()
 Returns a Boolean value that indicates if this property is read-only.
FDO_API FdoInt32 GetScale ()
 Gets the scale (number of digits to the right of the decimal point) of a decimal data property. This value does not apply to any other FdoDataType.
FDO_API FdoPropertyValueConstraintGetValueConstraint ()
 Returns the value constraint of this data property.
virtual void InitFromXml (const FdoString *propertyTypeName, FdoSchemaXmlContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this property from its XML attributes.
virtual void Set (FdoPropertyDefinition *pProperty, FdoSchemaXmlContext *pContext)
 Update this property from the given property.
FDO_API void SetDataType (FdoDataType dataType)
 Sets the FdoDataType of this property.
FDO_API void SetDefaultValue (FdoString *value)
 Sets the default value for this property. The default value is used when an instance of the containing class is created without specifying a value for this property.
FDO_API void SetIsAutoGenerated (bool value)
 Sets a Boolean value that indicates if this is an autogenerated property.
FDO_API void SetLength (FdoInt32 value)
 Sets the length of a String, BLOB, or CLOB data property. This value is ignored for all other FdoDataType values.
FDO_API void SetNullable (bool value)
 Sets a Boolean value that indicates if this property's value can be null.
FDO_API void SetPrecision (FdoInt32 value)
 Sets the precision (total number of digits) of a decimal data property. This value is ignored for all other FdoDataType values.
FDO_API void SetReadOnly (bool value)
 Sets a Boolean value that indicates if this property is read-only.
FDO_API void SetScale (FdoInt32 value)
 Sets the scale (number of digits to the right of the decimal point) of a decimal data property. This value is ignored for all other FdoDataType values.
FDO_API void SetValueConstraint (FdoPropertyValueConstraint *value)
 Sets the value constraint of this data property.
virtual FdoBoolean XmlEndElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname)
 Element end.
virtual FdoXmlSaxHandlerXmlStartElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)

Static Public Member Functions

static FDO_API FdoDataPropertyDefinitionCreate (FdoString *name, FdoString *description, bool system=false)
 Constructs an instance of an FdoDataPropertyDefinition using the specified arguments.
static FDO_API FdoDataPropertyDefinitionCreate ()
 Constructs a default instance of an FdoDataPropertyDefinition.

Protected Member Functions

virtual void _AcceptChanges ()
virtual void _RejectChanges ()
virtual void _StartChanges ()
 FdoFeatureSchema::RejectChanges() support.
virtual void Dispose ()
 Dispose this object.
 FdoDataPropertyDefinition (FdoString *name, FdoString *description, bool system=false)
 Constructs an instance of an FdoDataPropertyDefinition using the specified arguments.
 FdoDataPropertyDefinition ()
 Constructs a default instance of an FdoDataPropertyDefinition.
void Init ()
 Common initialization code called by all constructors:.
virtual ~FdoDataPropertyDefinition ()

Protected Attributes

bool m_autogeneratedCHANGED
FdoDataType m_dataTypeCHANGED
wchar_t * m_defaultValueCHANGED
FdoInt32 m_lengthCHANGED
bool m_nullableCHANGED
FdoInt32 m_precisionCHANGED
FdoPropertyValueConstraintm_propertyValueConstraintCHANGED
bool m_readOnlyCHANGED
FdoInt32 m_scaleCHANGED

Friends

class FdoObjectPropertyDefinition
class FdoSchemaCollection

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