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::Connections Namespace Reference


Classes

class  OSGeo::FDO::Connections::IConnectionImp
 The IConnection interface enables a feature provider to implement a connection class, which represents a unique session with a data store. More...
class  OSGeo::FDO::Connections::IConnectionInfoImp
 The IConnectionInfo interface exposes information about the feature provider and provides access to the IConnectionPropertyDictionary interface. More...
class  OSGeo::FDO::Connections::IConnectionPropertyDictionaryImp
 The IConnectionPropertyDictionary exposes a dictionary style interface to the connection properties. The properties required to establish a connection can be determined and their values can be set through this interface. Modifying connection properties through this interface dynamically modifies the connection string held by the connection object. When the connection is in an open state, calling SetProperty on this interface will result in an error. More...
class  OSGeo::FDO::Connections::ITransactionImp
 The ITransaction interface represents a transaction to be performed in a DataStore, and is implemented by feature providers that support transactions. More...
interface  OSGeo::FDO::Connections::OSGeo::FDO::Connections::IConnection
 The IConnection interface enables a feature provider to implement a connection class, which represents a unique session with a data store. More...
interface  OSGeo::FDO::Connections::OSGeo::FDO::Connections::IConnectionInfo
 The IConnectionInfo interface exposes information about the feature provider and provides access to the IConnectionPropertyDictionary interface. More...
interface  OSGeo::FDO::Connections::OSGeo::FDO::Connections::IConnectionPropertyDictionary
 The IConnectionPropertyDictionary exposes a dictionary style interface to the connection properties. The properties required to establish a connection can be determined and their values can be set through this interface. Modifying connection properties through this interface dynamically modifies the connection string held by the connection object. When the connection is in an open state, calling SetProperty on this interface will result in an error. More...
interface  OSGeo::FDO::Connections::OSGeo::FDO::Connections::ITransaction
 The ITransaction interface represents a transaction to be performed in a DataStore, and is implemented by feature providers that support transactions. More...

Enumerations

enum  ConnectionState {
  ConnectionState_Busy = FdoConnectionState_Busy,
  ConnectionState_Closed = FdoConnectionState_Closed,
  ConnectionState_Open = FdoConnectionState_Open,
  ConnectionState_Pending = FdoConnectionState_Pending
}
 The ConnectionState enumeration indicates the current state of the connection More...
enum  ProviderDatastoreType {
  ProviderDatastoreType_DatabaseServer = FdoProviderDatastoreType_DatabaseServer,
  ProviderDatastoreType_File = FdoProviderDatastoreType_File,
  ProviderDatastoreType_WebServer = FdoProviderDatastoreType_WebServer,
  ProviderDatastoreType_Unknown = FdoProviderDatastoreType_Unknown
}
 The ProviderDatastoreType enumeration lists all of the concrete provider types supported by FDO. More...

Functions

OSGeo::FDO::Connections::ITransactionBeginTransaction ()
 Begins a transaction and returns an object that realizes ITransaction.
System::Void Close ()
 Closes the connection to the DataStore.
System::Void Commit ()
 Commits the transaction.
OSGeo::FDO::Commands::ICommandCreateCommand (OSGeo::FDO::Commands::CommandType commandType)
 Creates and returns the specified type of command object associated with the connection.
OSGeo::FDO::Commands::Schema::PhysicalSchemaMappingCreateSchemaMapping ()
 Factory function that creates an empty Schema Override set specific to this FDO Provider.
System::String * EnumeratePropertyValues (System::String *name)[]
 Returns an array of possible values for the specified property.
System::Void Flush ()
 Forces the writes of any cached data to the targed datastore.
__property OSGeo::FDO::Connections::Capabilities::ICommandCapabilitiesget_CommandCapabilities ()
 Gets an ICommandCapabilities interface describing the commands a provider supports.
__property OSGeo::FDO::Connections::IConnectionInfoget_ConnectionInfo ()
 Gets an IConnectionInfo interface that can be used to interrogate and set connection properties.
__property OSGeo::FDO::Connections::IConnectionPropertyDictionaryget_ConnectionProperties ()
 Gets the IConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
__property OSGeo::FDO::Connections::ConnectionState get_ConnectionState ()
 Gets the current state of the connection.
__property System::String * get_ConnectionString ()
 Gets the connection string used to open a DataStore.
__property System::Int32 get_ConnectionTimeout ()
 Gets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability 0 will be returned.
__property OSGeo::FDO::Common::StringCollectionget_DependentFileNames ()
 File-based providers depend on a various files. This function returns a list of fully qualified dependend file names. The return parameter will be NULL if the provider is not a file-based provider.
__property OSGeo::FDO::Connections::Capabilities::IExpressionCapabilitiesget_ExpressionCapabilities ()
 Gets an IExpressionCapabilities interface describing the provider's support for expressions.
__property System::String * get_FeatureDataObjectsVersion ()
 Gets the version of the Feature Data Objects specification to which this provider conforms.
__property OSGeo::FDO::Connections::Capabilities::IFilterCapabilitiesget_FilterCapabilities ()
 Gets an IFilterCapabilities interface describing the provider's support for filters.
__property OSGeo::FDO::Connections::Capabilities::IGeometryCapabilitiesget_GeometryCapabilities ()
 Gets an IGeometryCapabilities interface describing the provider's support for geometry.
__property OSGeo::FDO::Connections::ProviderDatastoreType get_ProviderDatastoreType ()
 Returns the provider type. A provider can be a file-based, database-based or web-based provider. The valid values the function may return are defined in the enumeration ProviderDatastoreType. The enumeration includes the following values: ProviderDatastoreType_Unknown, ProviderDatastoreType_File, ProviderDatastoreType_DatabaseServer, ProviderDatastoreType_WebServer.
__property System::String * get_ProviderDescription ()
 Gets the description of the feature provider.
__property System::String * get_ProviderDisplayName ()
 Gets the display name of the feature provider.
__property System::String * get_ProviderVersion ()
 Gets the version of the feature provider.
__property OSGeo::FDO::Connections::Capabilities::IRasterCapabilitiesget_RasterCapabilities ()
 Gets an IRasterCapabilities interface describing the provider's support for raster images.
__property OSGeo::FDO::Connections::Capabilities::ISchemaCapabilitiesget_SchemaCapabilities ()
 Gets an ISchemaCapabilities interface describing the provider's support for the feature schema.
__property OSGeo::FDO::Connections::Capabilities::ITopologyCapabilitiesget_TopologyCapabilities ()
 Gets an ITopologyCapabilities interface describing the provider's support for topology.
System::String * GetLocalizedName (System::String *name)
 Gets a localized name for the property (for NLS purposes).
System::String * GetProperty (System::String *name)
 Gets the value of the specified property.
System::String * GetPropertyDefault (System::String *name)
 Gets the default value for the specified property.
System::Boolean IsPropertyEnumerable (System::String *name)
 Determines if the possible values for the specified property can be enumerated via the EnumeratePropertyValues method.
System::Boolean IsPropertyProtected (System::String *name)
 Indicates if the property is a password or other protected field that should be kept secure.
System::Boolean IsPropertyRequired (System::String *name)
 Determines if the specified property is required.
OSGeo::FDO::Connections::ConnectionState Open ()
 Opens a feature connection with the settings specified by the ConnectionString attribute of the provider-specific feature connection object.
System::Void Rollback ()
 Rolls back a transaction from a pending state.
__property System::Void set_Configuration (OSGeo::FDO::Common::Io::IoStream *configStream)
 Sets the XML configuration stream used to configure the Data Store. SetConfiguration can only be called while the connection is closed.
__property System::Void set_ConnectionString (System::String *value)
 Sets the connection string used to open a DataStore. SetConnectionString can only be set while the connection is closed.
__property System::Void set_ConnectionTimeout (System::Int32 value)
 Sets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability then attempting to set a timeout will result in an exception.
System::Void SetProperty (System::String *name, System::String *value)
 Sets the value of the specified property. An exception is thrown if the connection is currently open.

Variables

public __gc __interface IConnection
public __gc __interface IConnectionInfo
public __gc __interface IConnectionPropertyDictionary
public __gc __interface ITransaction

Enumeration Type Documentation

enum ConnectionState
 

The ConnectionState enumeration indicates the current state of the connection

Enumeration values:
ConnectionState_Busy  The connection is busy executing one or more commands. Executing another command while the connection is busy will result in an exception.
ConnectionState_Closed  The connection is closed.
ConnectionState_Open  The connection is open.
ConnectionState_Pending  The connection is pending. this is used to indicate that the application has issued an Open request, but the open is not completed because the application needs to include additional connection property values.

enum ProviderDatastoreType
 

The ProviderDatastoreType enumeration lists all of the concrete provider types supported by FDO.

Enumeration values:
ProviderDatastoreType_DatabaseServer  Indicates that the provider is a database-based provider.
ProviderDatastoreType_File  Indicates that the provider is a file-based provider.
ProviderDatastoreType_WebServer  Indicates that the provider is a web-based provider.
ProviderDatastoreType_Unknown  Indicates that the provider is of an unknown provider type.

Function Documentation

OSGeo ::FDO ::Connections ::ITransaction* BeginTransaction  ) 
 

Begins a transaction and returns an object that realizes ITransaction.

Returns:
Returns the transaction

System::Void Close  ) 
 

Closes the connection to the DataStore.

Returns:
Returns nothing

System::Void Commit  ) 
 

Commits the transaction.

Returns:
Returns nothing

OSGeo ::FDO ::Commands ::ICommand* CreateCommand OSGeo::FDO::Commands::CommandType  commandType  ) 
 

Creates and returns the specified type of command object associated with the connection.

Parameters:
commandType Input the command type to be created
Returns:
Returns the command

OSGeo ::FDO ::Commands ::Schema ::PhysicalSchemaMapping* CreateSchemaMapping  ) 
 

Factory function that creates an empty Schema Override set specific to this FDO Provider.

Returns:
Returns PhysicalSchemaMapping

System::String* EnumeratePropertyValues System::String *  name  ) 
 

Returns an array of possible values for the specified property.

Parameters:
name Input the property name.
Returns:
Returns the list of values for this property.

System::Void Flush  ) 
 

Forces the writes of any cached data to the targed datastore.

Returns:
Returns nothing

__property OSGeo ::FDO ::Connections ::Capabilities ::ICommandCapabilities* get_CommandCapabilities  ) 
 

Gets an ICommandCapabilities interface describing the commands a provider supports.

Returns:
Returns the command capabilities

__property OSGeo ::FDO ::Connections ::IConnectionInfo* get_ConnectionInfo  ) 
 

Gets an IConnectionInfo interface that can be used to interrogate and set connection properties.

Returns:
Returns the connection info

__property OSGeo ::FDO ::Connections ::IConnectionPropertyDictionary* get_ConnectionProperties  ) 
 

Gets the IConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.

Returns:
Returns the property dictionary

__property OSGeo ::FDO ::Connections ::ConnectionState get_ConnectionState  ) 
 

Gets the current state of the connection.

Returns:
Returns the current state of the connection

__property System::String* get_ConnectionString  ) 
 

Gets the connection string used to open a DataStore.

Returns:
Returns the connection string

__property System::Int32 get_ConnectionTimeout  ) 
 

Gets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability 0 will be returned.

Returns:
Returns the time to wait (in milliseconds)

__property OSGeo ::FDO ::Common ::StringCollection* get_DependentFileNames  ) 
 

File-based providers depend on a various files. This function returns a list of fully qualified dependend file names. The return parameter will be NULL if the provider is not a file-based provider.

Returns:
Returns the list of fully-qualified dependend file names if the provider is a file-based provider, NULL otherwise.

__property OSGeo ::FDO ::Connections ::Capabilities ::IExpressionCapabilities* get_ExpressionCapabilities  ) 
 

Gets an IExpressionCapabilities interface describing the provider's support for expressions.

Returns:
Returns the expression capabilities

__property System::String* get_FeatureDataObjectsVersion  ) 
 

Gets the version of the Feature Data Objects specification to which this provider conforms.

Returns:
Returns FDO version supported.

__property OSGeo ::FDO ::Connections ::Capabilities ::IFilterCapabilities* get_FilterCapabilities  ) 
 

Gets an IFilterCapabilities interface describing the provider's support for filters.

Returns:
Returns the filter capabilities

__property OSGeo ::FDO ::Connections ::Capabilities ::IGeometryCapabilities* get_GeometryCapabilities  ) 
 

Gets an IGeometryCapabilities interface describing the provider's support for geometry.

Returns:
Returns the geometry capabilities

__property OSGeo ::FDO ::Connections ::ProviderDatastoreType get_ProviderDatastoreType  ) 
 

Returns the provider type. A provider can be a file-based, database-based or web-based provider. The valid values the function may return are defined in the enumeration ProviderDatastoreType. The enumeration includes the following values: ProviderDatastoreType_Unknown, ProviderDatastoreType_File, ProviderDatastoreType_DatabaseServer, ProviderDatastoreType_WebServer.

Returns:
Returns the provider data store type.

__property System::String* get_ProviderDescription  ) 
 

Gets the description of the feature provider.

Returns:
Returns the provider description

__property System::String* get_ProviderDisplayName  ) 
 

Gets the display name of the feature provider.

Returns:
Returns the provider's display name

__property System::String* get_ProviderVersion  ) 
 

Gets the version of the feature provider.

Returns:
Returns provider version

__property OSGeo ::FDO ::Connections ::Capabilities ::IRasterCapabilities* get_RasterCapabilities  ) 
 

Gets an IRasterCapabilities interface describing the provider's support for raster images.

Returns:
Returns the raster capabilities

__property OSGeo ::FDO ::Connections ::Capabilities ::ISchemaCapabilities* get_SchemaCapabilities  ) 
 

Gets an ISchemaCapabilities interface describing the provider's support for the feature schema.

Returns:
Returns schema capabilities

__property OSGeo ::FDO ::Connections ::Capabilities ::ITopologyCapabilities* get_TopologyCapabilities  ) 
 

Gets an ITopologyCapabilities interface describing the provider's support for topology.

Returns:
Returns the topology capabilities

System::String* GetLocalizedName System::String *  name  ) 
 

Gets a localized name for the property (for NLS purposes).

Parameters:
name Input the property name.
Returns:
Returns the localized name for the property (for NLS purposes).

System::String* GetProperty System::String *  name  ) 
 

Gets the value of the specified property.

Parameters:
name Input the property name.
Returns:
Returns the property value.

System::String* GetPropertyDefault System::String *  name  ) 
 

Gets the default value for the specified property.

Parameters:
name Input the property name
Returns:
Returns the property default value

System::Boolean IsPropertyEnumerable System::String *  name  ) 
 

Determines if the possible values for the specified property can be enumerated via the EnumeratePropertyValues method.

Parameters:
name Input the property name
Returns:
Returns true if the possible values for the specified property can be enumerated.

System::Boolean IsPropertyProtected System::String *  name  ) 
 

Indicates if the property is a password or other protected field that should be kept secure.

Parameters:
name Input the property name.
Returns:
Returns true if the property is a password or other protected field that should be kept secure.

System::Boolean IsPropertyRequired System::String *  name  ) 
 

Determines if the specified property is required.

Parameters:
name Input the property name
Returns:
Returns true if the specified property is required

OSGeo ::FDO ::Connections ::ConnectionState Open  ) 
 

Opens a feature connection with the settings specified by the ConnectionString attribute of the provider-specific feature connection object.

Returns:
Returns nothing

System::Void Rollback  ) 
 

Rolls back a transaction from a pending state.

Returns:
Returns nothing

__property System::Void set_Configuration OSGeo::FDO::Common::Io::IoStream configStream  ) 
 

Sets the XML configuration stream used to configure the Data Store. SetConfiguration can only be called while the connection is closed.

Parameters:
configStream Input the XML configuration stream
Returns:
Returns nothing

__property System::Void set_ConnectionString System::String *  value  ) 
 

Sets the connection string used to open a DataStore. SetConnectionString can only be set while the connection is closed.

Parameters:
value Input the connection string
Returns:
Returns nothing

__property System::Void set_ConnectionTimeout System::Int32  value  ) 
 

Sets the number of milliseconds to wait while trying to establish a connection before terminating the attempt and generating an error. If the provider does not support the timeout capability then attempting to set a timeout will result in an exception.

Parameters:
value Input the time to wait (in milliseconds)
Returns:
Returns nothing

System::Void SetProperty System::String *  name,
System::String *  value
 

Sets the value of the specified property. An exception is thrown if the connection is currently open.

Parameters:
name Input the property name
value Input the property value
Returns:
Returns nothing

Variable Documentation

public __gc __interface OSGeo::FDO::Connections::IConnection
 

public __gc __interface OSGeo::FDO::Connections::IConnectionInfo
 

public __gc __interface OSGeo::FDO::Connections::IConnectionPropertyDictionary
 

public __gc __interface OSGeo::FDO::Connections::ITransaction
 


Comments or suggestions? Send us feedback.