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

mgISchemaCapabilities.h File Reference

Include dependency graph for mgISchemaCapabilities.h:


Namespaces

namespace  OSGeo
namespace  OSGeo::FDO
namespace  OSGeo::FDO::Connections
namespace  OSGeo::FDO::Connections::Capabilities
namespace  OSGeo::FDO::Schema

Functions

__property OSGeo::FDO::Schema::DataType get_DataTypes ()[]
 Returns an array of the DataType objects the feature provider supports.
__property System::Int64 get_MaximumDataValueLength (OSGeo::FDO::Schema::DataType dataType)
 Returns the maximum supported length of String, BLOB, or CLOB data properties. For decimal, it is the combination of the maximum scale and precision. For other data types that are not variable in size, the value returned is the byte length.
__property System::Int32 get_MaximumDecimalPrecision ()
 Returns the maximum supported precision for a decimal data property.
__property System::Int32 get_MaximumDecimalScale ()
 Returns the maximum supported scale for a decimal data property.
__property System::Int32 get_NameSizeLimit (OSGeo::FDO::Connections::Capabilities::SchemaElementNameType name)
 Returns the maximum size of a value of the given type. It includes limits for the data store name, shema name, class name, property name and description.
__property System::String * get_ReservedCharactersForName ()
 Returns a string that includes all the reserved characters that cannot be used for the various schema element names for the provider.
__property OSGeo::FDO::Schema::DataType get_SupportedAutoGeneratedTypes ()[]
 Returns an array of the DataType objects the feature provider supports for auto-generation.
__property OSGeo::FDO::Schema::DataType get_SupportedIdentityPropertyTypes ()[]
 Returns a list of property types that can be used for identity properties.
__property System::Boolean get_SupportsAssociationProperties ()
 Determines if the provider supports association property.
__property System::Boolean get_SupportsAutoIdGeneration ()
 Determines if the provider can auto-generate unique ID values for a class.
__property System::Boolean get_SupportsCompositeId ()
 Determines if the provider supports multiple identity properties per class.
__property System::Boolean get_SupportsCompositeUniqueValueConstraints ()
 Determines if the provider supports composite unique value constraint.
__property System::Boolean get_SupportsDataStoreScopeUniqueIdGeneration ()
 Determines if the provider can auto-generate unique ID values that are unique for the entire datastore, rather than just for a particular class.
__property System::Boolean get_SupportsDefaultValue ()
 Returns TRUE if default values can be specified for a data property definition, FALSE otherwise.
__property System::Boolean get_SupportsExclusiveValueRangeConstraints ()
 Determines if the provider supports exclusive value range constraints.
__property System::Boolean get_SupportsInclusiveValueRangeConstraints ()
 Determines if the provider supports inclusive value range constraints.
__property System::Boolean get_SupportsInheritance ()
 Determines if the feature provider supports inheritance.
__property System::Boolean get_SupportsMultipleSchemas ()
 Determines if the provider supports multiple schemas. Returns false if the provider supports only a single schema.
__property System::Boolean get_SupportsNetworkModel ()
 Determines if the provider supports the network model.
__property System::Boolean get_SupportsNullValueConstraints ()
 Determines if the provider supports nullable value constraint.
__property System::Boolean get_SupportsObjectProperties ()
 Determines if the provider supports object properties. Returns false if the provider supports only data and geometric properties.
__property System::Boolean get_SupportsSchemaModification ()
 Determines if the provider support update a schema through the ApplySchema command. If False, then an application can only create a schema once for the provider. They can use the ApplySchema command once for a given datastore. Once the schema is defined, it cannot be changed. If True, then the provider supports the ability to modify or add to the schema after it is defined initially.
__property System::Boolean get_SupportsSchemaOverrides ()
 Determines if the provider supports Schema Mapping Overrides (overrides to the default rules for mapping Feature Schemas to provider-specific physical schemas).
__property System::Boolean get_SupportsUniqueValueConstraints ()
 Determines if the provider supports unique value constraint.
__property System::Boolean get_SupportsValueConstraintsList ()
 Determines if the provider supports value constraints list.

Variables

public __gc __interface ISchemaCapabilities

Function Documentation

__property OSGeo ::FDO ::Schema ::DataType get_DataTypes  ) 
 

Returns an array of the DataType objects the feature provider supports.

Returns:
Returns the list of data types

__property System::Int64 get_MaximumDataValueLength OSGeo::FDO::Schema::DataType  dataType  ) 
 

Returns the maximum supported length of String, BLOB, or CLOB data properties. For decimal, it is the combination of the maximum scale and precision. For other data types that are not variable in size, the value returned is the byte length.

Parameters:
dataType The data type for which the information is to retrieved.
Returns:
Returns the maximum data value length for the identified data type.

__property System::Int32 get_MaximumDecimalPrecision  ) 
 

Returns the maximum supported precision for a decimal data property.

Returns:
Returns the maximum supported precision for a decimal data property.

__property System::Int32 get_MaximumDecimalScale  ) 
 

Returns the maximum supported scale for a decimal data property.

Returns:
Returns the maximum supported scale for a decimal data property.

__property System::Int32 get_NameSizeLimit OSGeo::FDO::Connections::Capabilities::SchemaElementNameType  name  ) 
 

Returns the maximum size of a value of the given type. It includes limits for the data store name, shema name, class name, property name and description.

Parameters:
name The schema element name type identifier for which the information is to be retrieved. Can be any of the following options: SchemaElementNameType_Datastore, SchemaElementNameType_Schema, SchemaElementNameType_Class, SchemaElementNameType_Property or SchemaElementNameType_Description
Returns:
Returns the size limitation for the identified schema element.

__property System::String* get_ReservedCharactersForName  ) 
 

Returns a string that includes all the reserved characters that cannot be used for the various schema element names for the provider.

Returns:
Returns a string with the reserved characters for the identified schema element.

__property OSGeo ::FDO ::Schema ::DataType get_SupportedAutoGeneratedTypes  ) 
 

Returns an array of the DataType objects the feature provider supports for auto-generation.

Returns:
Returns the list of data types

__property OSGeo ::FDO ::Schema ::DataType get_SupportedIdentityPropertyTypes  ) 
 

Returns a list of property types that can be used for identity properties.

Returns:
Returns a string with the reserved characters for the identified schema element.

__property System::Boolean get_SupportsAssociationProperties  ) 
 

Determines if the provider supports association property.

Returns:
Returns true if the provider support the association property.

__property System::Boolean get_SupportsAutoIdGeneration  ) 
 

Determines if the provider can auto-generate unique ID values for a class.

Returns:
Returns true if the provider supports id autogeneration.

__property System::Boolean get_SupportsCompositeId  ) 
 

Determines if the provider supports multiple identity properties per class.

Returns:
Returns true if the provider supports multiple identity properties per class.

__property System::Boolean get_SupportsCompositeUniqueValueConstraints  ) 
 

Determines if the provider supports composite unique value constraint.

Returns:
Returns true if the provider supports composite unique value constraint.

__property System::Boolean get_SupportsDataStoreScopeUniqueIdGeneration  ) 
 

Determines if the provider can auto-generate unique ID values that are unique for the entire datastore, rather than just for a particular class.

Returns:
Returns true if the provider supports id autogeneration unique across an datastore.

__property System::Boolean get_SupportsDefaultValue  ) 
 

Returns TRUE if default values can be specified for a data property definition, FALSE otherwise.

Returns:
Returns TRUE if default values can be specified for a data property definition, FALSE otherwise.

__property System::Boolean get_SupportsExclusiveValueRangeConstraints  ) 
 

Determines if the provider supports exclusive value range constraints.

Returns:
Returns true if the provider supports exclusive value range constraints.

__property System::Boolean get_SupportsInclusiveValueRangeConstraints  ) 
 

Determines if the provider supports inclusive value range constraints.

Returns:
Returns true if the provider supports inclusive value range constraints.

__property System::Boolean get_SupportsInheritance  ) 
 

Determines if the feature provider supports inheritance.

Returns:
Returns true if the feature provider supports inheritance

__property System::Boolean get_SupportsMultipleSchemas  ) 
 

Determines if the provider supports multiple schemas. Returns false if the provider supports only a single schema.

Returns:
Returns true if the provider supports multiple schemas.

__property System::Boolean get_SupportsNetworkModel  ) 
 

Determines if the provider supports the network model.

Returns:
Returns true if the provider supports the network model.

__property System::Boolean get_SupportsNullValueConstraints  ) 
 

Determines if the provider supports nullable value constraint.

Returns:
Returns true if the provider supports nullable value constraint.

__property System::Boolean get_SupportsObjectProperties  ) 
 

Determines if the provider supports object properties. Returns false if the provider supports only data and geometric properties.

Returns:
Returns true if the provider supports object properties.

__property System::Boolean get_SupportsSchemaModification  ) 
 

Determines if the provider support update a schema through the ApplySchema command. If False, then an application can only create a schema once for the provider. They can use the ApplySchema command once for a given datastore. Once the schema is defined, it cannot be changed. If True, then the provider supports the ability to modify or add to the schema after it is defined initially.

Returns:
Returns true if the provider supports the update of the schema.

__property System::Boolean get_SupportsSchemaOverrides  ) 
 

Determines if the provider supports Schema Mapping Overrides (overrides to the default rules for mapping Feature Schemas to provider-specific physical schemas).

Returns:
Returns true if the provider supports Schema Overrides

__property System::Boolean get_SupportsUniqueValueConstraints  ) 
 

Determines if the provider supports unique value constraint.

Returns:
Returns true if the provider supports unique value constraint.

__property System::Boolean get_SupportsValueConstraintsList  ) 
 

Determines if the provider supports value constraints list.

Returns:
Returns true if the provider supports value constraints list.

Variable Documentation

public __gc __interface OSGeo::FDO::Connections::Capabilities::ISchemaCapabilities
 


Comments or suggestions? Send us feedback.