FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Schema::DataPropertyDefinition Class Reference

Inherits OSGeo::FDO::Schema::PropertyDefinition.

Inheritance diagram for OSGeo::FDO::Schema::DataPropertyDefinition:

[legend]
List of all members.

Detailed Description

The DataPropertyDefinition class derives PropertyDefinition and represents simple values or collections of simple values. DataPropertyDefinitions can take on any of the data types listed in DataType enumeration.


Public Member Functions

 DataPropertyDefinition (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a DataPropertyDefinition object based on an unmanaged instance of the object.
 DataPropertyDefinition (System::String *name, System::String *description, System::Boolean system)
 Constructs an instance of an DataPropertyDefinition using the specified arguments.
 DataPropertyDefinition (System::String *name, System::String *description)
 Constructs an instance of an DataPropertyDefinition using the specified arguments.
 DataPropertyDefinition ()
 Constructs a default instance of an DataPropertyDefinition.
__property OSGeo::FDO::Schema::DataType get_DataType ()
 Gets the DataType of this property.
__property System::String * get_DefaultValue ()
 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.
__property System::Boolean get_IsAutoGenerated ()
 Returns a Boolean value that indicates if this is an autogenerated property.
__property System::Int32 get_Length ()
 Gets the length of a String, BLOB, or CLOB data property. This value does not apply to any other DataType.
__property System::Boolean get_Nullable ()
 Returns a Boolean value that indicates if this property's value can be null.
__property System::Int32 get_Precision ()
 Gets the precision (total number of digits) of a decimal data property. This value does not apply to any other DataType.
__property OSGeo::FDO::Schema::PropertyType get_PropertyType ()
 Gets the concrete property type.
__property System::Boolean get_ReadOnly ()
 Returns a Boolean value that indicates if this property is read-only.
__property System::Int32 get_Scale ()
 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 DataType.
__property OSGeo::FDO::Schema::PropertyValueConstraintget_ValueConstraint ()
 Returns the value constraint of this data property.
__property System::Void set_DataType (OSGeo::FDO::Schema::DataType value)
 Sets the DataType of this property.
__property System::Void set_DefaultValue (System::String *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.
__property System::Void set_IsAutoGenerated (System::Boolean value)
 Sets a Boolean value that indicates if this is an autogenerated property.
__property System::Void set_Length (System::Int32 value)
 Sets the length of a String, BLOB, or CLOB data property. This value is ignored for all other DataType values.
__property System::Void set_Nullable (System::Boolean value)
 Sets a Boolean value that indicates if this property's value can be null.
__property System::Void set_Precision (System::Int32 value)
 Sets the precision (total number of digits) of a decimal data property. This value is ignored for all other DataType values.
__property System::Void set_ReadOnly (System::Boolean value)
 Sets a Boolean value that indicates if this property is read-only.
__property System::Void set_Scale (System::Int32 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 DataType values.
__property System::Void set_ValueConstraint (OSGeo::FDO::Schema::PropertyValueConstraint *value)
 Sets the value constraint of this data property.

Constructor & Destructor Documentation

OSGeo::FDO::Schema::DataPropertyDefinition::DataPropertyDefinition  ) 
 

Constructs a default instance of an DataPropertyDefinition.

OSGeo::FDO::Schema::DataPropertyDefinition::DataPropertyDefinition System::String *  name,
System::String *  description
 

Constructs an instance of an DataPropertyDefinition using the specified arguments.

Parameters:
name Input name
description Input description

OSGeo::FDO::Schema::DataPropertyDefinition::DataPropertyDefinition System::String *  name,
System::String *  description,
System::Boolean  system
 

Constructs an instance of an DataPropertyDefinition using the specified arguments.

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

OSGeo::FDO::Schema::DataPropertyDefinition::DataPropertyDefinition System::IntPtr  unmanaged,
System::Boolean  autoDelete
[inline]
 

Constructs a DataPropertyDefinition object based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

__property OSGeo ::FDO ::Schema ::DataType OSGeo::FDO::Schema::DataPropertyDefinition::get_DataType  ) 
 

Gets the DataType of this property.

Returns:
Returns the DataType of this property

__property System::String* OSGeo::FDO::Schema::DataPropertyDefinition::get_DefaultValue  ) 
 

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

__property System::Boolean OSGeo::FDO::Schema::DataPropertyDefinition::get_IsAutoGenerated  ) 
 

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

Returns:
Returns a Boolean value.

__property System::Int32 OSGeo::FDO::Schema::DataPropertyDefinition::get_Length  ) 
 

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

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

__property System::Boolean OSGeo::FDO::Schema::DataPropertyDefinition::get_Nullable  ) 
 

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

Returns:
Returns a Boolean value

__property System::Int32 OSGeo::FDO::Schema::DataPropertyDefinition::get_Precision  ) 
 

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

Returns:
Returns the precision

__property OSGeo ::FDO ::Schema ::PropertyType OSGeo::FDO::Schema::DataPropertyDefinition::get_PropertyType  ) 
 

Gets the concrete property type.

Returns:
Returns the concrete property type.

Reimplemented from OSGeo::FDO::Schema::PropertyDefinition.

__property System::Boolean OSGeo::FDO::Schema::DataPropertyDefinition::get_ReadOnly  ) 
 

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

Returns:
Returns a Boolean value

__property System::Int32 OSGeo::FDO::Schema::DataPropertyDefinition::get_Scale  ) 
 

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

Returns:
Returns the scale

__property OSGeo ::FDO ::Schema ::PropertyValueConstraint* OSGeo::FDO::Schema::DataPropertyDefinition::get_ValueConstraint  ) 
 

Returns the value constraint of this data property.

Returns:
Returns PropertyValueConstraint or NULL if not set.

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_DataType OSGeo::FDO::Schema::DataType  value  ) 
 

Sets the DataType of this property.

Parameters:
value Input the DataType of this property
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_DefaultValue System::String *  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

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_IsAutoGenerated System::Boolean  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

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_Length System::Int32  value  ) 
 

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

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

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_Nullable System::Boolean  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

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_Precision System::Int32  value  ) 
 

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

Parameters:
value Input the precision
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_ReadOnly System::Boolean  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

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_Scale System::Int32  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 DataType values.

Parameters:
value Input the scale
Returns:
Returns nothing

__property System::Void OSGeo::FDO::Schema::DataPropertyDefinition::set_ValueConstraint OSGeo::FDO::Schema::PropertyValueConstraint value  ) 
 

Sets the value constraint of this data property.

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

Comments or suggestions? Send us feedback.