DataTransformationConnection Class

 Spotfire 14.3 API Reference
Represents a connected DataTransformation. The connection is created when the transformation is bound to a DataRowReader that is used as input to the transformation.
Inheritance Hierarchy
SystemObject
  Spotfire.Dxp.DataDataTransformationConnection

Namespace:  Spotfire.Dxp.Data
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
public abstract class DataTransformationConnection : IDisposable

The DataTransformationConnection type exposes the following members.

Constructors
  NameDescription
Protected methodDataTransformationConnection
Initializes a new instance of the DataTransformationConnection class.
Top
Methods
  NameDescription
Public methodClose
Synonym for Dispose.
Public methodStatic memberCreateConnection(DataTransformationConnectionTransformationExecutor)
Create a default DataTransformationConnection instance.
Public methodStatic memberCreateConnection(DataTransformationConnectionTransformationExecutor, IEnumerableObject)
Create a default DataTransformationConnection instance.
Public methodDispose
Disposes of the connection.
Protected methodDispose(Boolean)
Disposes of the connection.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecuteTransformation
Performs prompting for all the prompt models and after that is finished the transformation is executed and the resulting DataRowReader is returned.
Protected methodExecuteTransformationCore
The implementor should execute the transformation with the current settings and returns the resulting DataRowReader.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetPromptModelsCore
This method is used to provide the prompt models that should be used for the data source.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
A connection is used to support perform prompting in a DataTransformation before returning the DataRowReader.

A creator of a transformation typically does not need to explicitly implement this class but can instead use the factory methods CreateConnection(DataTransformationConnectionTransformationExecutor) or CreateConnection(DataTransformationConnectionTransformationExecutor, IEnumerableObject).

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

Spotfire.Dxp.Data Namespace