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::IConnectionImp Class Reference

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Connections::OSGeo::FDO::Connections::IConnection.

Inheritance diagram for OSGeo::FDO::Connections::IConnectionImp:

[legend]
List of all members.

Detailed Description

The IConnection interface enables a feature provider to implement a connection class, which represents a unique session with a data store.


Public Member Functions

OSGeo::FDO::Connections::ITransactionBeginTransaction ()
 Begins a transaction and returns an object that realizes ITransaction.
System::Void Close ()
 Closes the connection to the DataStore.
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::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::Capabilities::IConnectionCapabilitiesget_ConnectionCapabilities ()
 Gets an IConnectionCapabilities interface describing the capabilities of the connection.
__property OSGeo::FDO::Connections::IConnectionInfoget_ConnectionInfo ()
 Gets an IConnectionInfo interface that can be used to interrogate and set connection properties.
__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::Connections::Capabilities::IExpressionCapabilitiesget_ExpressionCapabilities ()
 Gets an IExpressionCapabilities interface describing the provider's support for expressions.
__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::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.
OSGeo::FDO::Connections::ConnectionState Open ()
 Opens a feature connection with the settings specified by the ConnectionString attribute of the provider-specific feature connection object.
__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.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Member Function Documentation

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

Begins a transaction and returns an object that realizes ITransaction.

Returns:
Returns the transaction

System::Void OSGeo::FDO::Connections::IConnectionImp::Close  ) 
 

Closes the connection to the DataStore.

Returns:
Returns nothing

OSGeo ::FDO ::Commands ::ICommand* OSGeo::FDO::Connections::IConnectionImp::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* OSGeo::FDO::Connections::IConnectionImp::CreateSchemaMapping  ) 
 

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

Returns:
Returns PhysicalSchemaMapping

System::Void OSGeo::FDO::Connections::IConnectionImp::Flush  ) 
 

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

Returns:
Returns nothing

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

Gets an ICommandCapabilities interface describing the commands a provider supports.

Returns:
Returns the command capabilities

__property OSGeo ::FDO ::Connections ::Capabilities ::IConnectionCapabilities* OSGeo::FDO::Connections::IConnectionImp::get_ConnectionCapabilities  ) 
 

Gets an IConnectionCapabilities interface describing the capabilities of the connection.

Returns:
Returns the connection capabilities

__property OSGeo ::FDO ::Connections ::IConnectionInfo* OSGeo::FDO::Connections::IConnectionImp::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 ::ConnectionState OSGeo::FDO::Connections::IConnectionImp::get_ConnectionState  ) 
 

Gets the current state of the connection.

Returns:
Returns the current state of the connection

__property System::String* OSGeo::FDO::Connections::IConnectionImp::get_ConnectionString  ) 
 

Gets the connection string used to open a DataStore.

Returns:
Returns the connection string

__property System::Int32 OSGeo::FDO::Connections::IConnectionImp::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 ::Connections ::Capabilities ::IExpressionCapabilities* OSGeo::FDO::Connections::IConnectionImp::get_ExpressionCapabilities  ) 
 

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

Returns:
Returns the expression capabilities

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

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

Returns:
Returns the filter capabilities

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

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

Returns:
Returns the geometry capabilities

__property OSGeo ::FDO ::Connections ::Capabilities ::IRasterCapabilities* OSGeo::FDO::Connections::IConnectionImp::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* OSGeo::FDO::Connections::IConnectionImp::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* OSGeo::FDO::Connections::IConnectionImp::get_TopologyCapabilities  ) 
 

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

Returns:
Returns the topology capabilities

OSGeo ::FDO ::Connections ::ConnectionState OSGeo::FDO::Connections::IConnectionImp::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 OSGeo::FDO::Connections::IConnectionImp::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.

__property System::Void OSGeo::FDO::Connections::IConnectionImp::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 OSGeo::FDO::Connections::IConnectionImp::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 OSGeo::FDO::Connections::IConnectionImp::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

Comments or suggestions? Send us feedback.