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

FdoDataPropertyDefinition Class Reference

#include <DataPropertyDefinition.h>

Inherits FdoPropertyDefinition.

Inheritance diagram for FdoDataPropertyDefinition:

[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 (FdoString *propertyTypeName, FdoSchemaXmlContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this property from its XML attributes.
virtual void Set (FdoPropertyDefinition *pProperty, FdoSchemaMergeContext *pContext)
 DOXYGEN-IGNORE
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

FDO_API FdoDataPropertyDefinitionCreate (FdoString *name, FdoString *description, bool system=false)
 Constructs an instance of an FdoDataPropertyDefinition using the specified arguments.
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

Constructor & Destructor Documentation

FdoDataPropertyDefinition::FdoDataPropertyDefinition  )  [protected]
 

Constructs a default instance of an FdoDataPropertyDefinition.

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

Constructs an instance of an FdoDataPropertyDefinition using the specified arguments.

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


Member Function Documentation

virtual void FdoDataPropertyDefinition::_AcceptChanges  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoDataPropertyDefinition::_RejectChanges  )  [protected, virtual]
 

Reimplemented from FdoSchemaElement.

virtual void FdoDataPropertyDefinition::_StartChanges  )  [protected, virtual]
 

FdoFeatureSchema::RejectChanges() support.

Reimplemented from FdoSchemaElement.

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

Serialize this property to XML.

Reimplemented from FdoPropertyDefinition.

FDO_API FdoDataPropertyDefinition* FdoDataPropertyDefinition::Create FdoString name,
FdoString description,
bool  system = false
[static]
 

Constructs an instance of an FdoDataPropertyDefinition using the specified arguments.

Parameters:
name Input name
description Input description
system Input true if this is a system generated property, otherwise falseds.
Returns:
Returns FdoDataPropertyDefinition

FDO_API FdoDataPropertyDefinition* FdoDataPropertyDefinition::Create  )  [static]
 

Constructs a default instance of an FdoDataPropertyDefinition.

Returns:
Returns FdoDataPropertyDefinition

virtual void FdoDataPropertyDefinition::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoDataType FdoDataPropertyDefinition::GetDataType  ) 
 

Gets the FdoDataType of this property.

Returns:
Returns FdoDataType of this property

FDO_API FdoString* FdoDataPropertyDefinition::GetDefaultValue  ) 
 

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.

Returns:
Returns the default value

FDO_API bool FdoDataPropertyDefinition::GetIsAutoGenerated  ) 
 

Returns a Boolean value that indicates if this is an autogenerated property.

Returns:
Returns a Boolean value.

FDO_API FdoInt32 FdoDataPropertyDefinition::GetLength  ) 
 

Gets the length of a String, BLOB, or CLOB data property. This value does not apply to any other FdoDataType.

Returns:
Returns the length of a String, BLOB, or CLOB data property

FDO_API bool FdoDataPropertyDefinition::GetNullable  ) 
 

Returns a Boolean value that indicates if this property's value can be null.

Returns:
Returns a Boolean value

FDO_API FdoInt32 FdoDataPropertyDefinition::GetPrecision  ) 
 

Gets the precision (total number of digits) of a decimal data property. This value does not apply to any other FdoDataType.

Returns:
Returns the precision

virtual FDO_API FdoPropertyType FdoDataPropertyDefinition::GetPropertyType  )  [virtual]
 

Gets the concrete property type.

Returns:
Returns the concrete property type

Implements FdoPropertyDefinition.

FDO_API bool FdoDataPropertyDefinition::GetReadOnly  ) 
 

Returns a Boolean value that indicates if this property is read-only.

Returns:
Returns a Boolean value

FDO_API FdoInt32 FdoDataPropertyDefinition::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.

Returns:
Returns the scale

FDO_API FdoPropertyValueConstraint* FdoDataPropertyDefinition::GetValueConstraint  ) 
 

Returns the value constraint of this data property.

Returns:
Returns the FdoPropertyValueConstraint or NULL if not set.

void FdoDataPropertyDefinition::Init  )  [protected]
 

Common initialization code called by all constructors:.

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

Initialize this property from its XML attributes.

Reimplemented from FdoPropertyDefinition.

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

DOXYGEN-IGNORE

Reimplemented from FdoPropertyDefinition.

FDO_API void FdoDataPropertyDefinition::SetDataType FdoDataType  dataType  ) 
 

Sets the FdoDataType of this property.

Parameters:
dataType Input the FdoDataType of this property
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::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.

Parameters:
value Input the default value
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::SetIsAutoGenerated bool  value  ) 
 

Sets a Boolean value that indicates if this is an autogenerated property.

Parameters:
value Input a Boolean value that indicates if this property should be automatically generated by the provider. If true, then the provider will auto-generate unique id values for objects of the class containing this property. The provider will set the attribute properties to read-only. If the provider does not support auto-generation or if the data types of the property is not supported for unique id generation by the provider, then the provider will throw an AutoGenerationException. If false, then the provider will not autogenerate values.
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::SetLength FdoInt32  value  ) 
 

Sets the length of a String, BLOB, or CLOB data property. This value is ignored for all other FdoDataType values.

Parameters:
value Input the length of a String, BLOB, or CLOB data property
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::SetNullable bool  value  ) 
 

Sets a Boolean value that indicates if this property's value can be null.

Parameters:
value Input a Boolean value that indicates if this property's value can be null
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::SetPrecision FdoInt32  value  ) 
 

Sets the precision (total number of digits) of a decimal data property. This value is ignored for all other FdoDataType values.

Parameters:
value Input the precision
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::SetReadOnly bool  value  ) 
 

Sets a Boolean value that indicates if this property is read-only.

Parameters:
value Input a Boolean value that indicates if this property is read-only
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::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.

Parameters:
value Input the scale
Returns:
Returns nothing

FDO_API void FdoDataPropertyDefinition::SetValueConstraint FdoPropertyValueConstraint value  ) 
 

Sets the value constraint of this data property.

Parameters:
value Set the value constraint of this data property.
Returns:
Returns nothing

virtual FdoBoolean FdoDataPropertyDefinition::XmlEndElement FdoXmlSaxContext context,
FdoString uri,
FdoString name,
FdoString qname
[virtual]
 

Element end.

Reimplemented from FdoSchemaElement.

virtual FdoXmlSaxHandler* FdoDataPropertyDefinition::XmlStartElement FdoXmlSaxContext context,
FdoString uri,
FdoString name,
FdoString qname,
FdoXmlAttributeCollection atts
[virtual]
 

read the geometric types from XML sub-elements. Element start

Reimplemented from FdoSchemaElement.


Friends And Related Function Documentation

friend class FdoObjectPropertyDefinition [friend]
 

Definition at line 39 of file DataPropertyDefinition.h.

friend class FdoSchemaCollection [friend]
 

Reimplemented from FdoSchemaElement.

Definition at line 38 of file DataPropertyDefinition.h.


Member Data Documentation

bool FdoDataPropertyDefinition::m_autogeneratedCHANGED [protected]
 

Definition at line 331 of file DataPropertyDefinition.h.

FdoDataType FdoDataPropertyDefinition::m_dataTypeCHANGED [protected]
 

Definition at line 324 of file DataPropertyDefinition.h.

wchar_t* FdoDataPropertyDefinition::m_defaultValueCHANGED [protected]
 

Definition at line 330 of file DataPropertyDefinition.h.

FdoInt32 FdoDataPropertyDefinition::m_lengthCHANGED [protected]
 

Definition at line 326 of file DataPropertyDefinition.h.

bool FdoDataPropertyDefinition::m_nullableCHANGED [protected]
 

Definition at line 329 of file DataPropertyDefinition.h.

FdoInt32 FdoDataPropertyDefinition::m_precisionCHANGED [protected]
 

Definition at line 327 of file DataPropertyDefinition.h.

FdoPropertyValueConstraint* FdoDataPropertyDefinition::m_propertyValueConstraintCHANGED [protected]
 

Definition at line 332 of file DataPropertyDefinition.h.

bool FdoDataPropertyDefinition::m_readOnlyCHANGED [protected]
 

Definition at line 325 of file DataPropertyDefinition.h.

FdoInt32 FdoDataPropertyDefinition::m_scaleCHANGED [protected]
 

Definition at line 328 of file DataPropertyDefinition.h.


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