DataFlowBuilder Class

Spotfire 14.3 API Reference
This class is a builder that can be used to dynamically create a DataFlow instance.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.DataDataFlowBuilder

Namespace:  Spotfire.Dxp.Data
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
public sealed class DataFlowBuilder : IDisposable

The DataFlowBuilder type exposes the following members.

Constructors

  NameDescription
Public methodDataFlowBuilder
Initializes a new instance of the DataFlowBuilder class.
Top
Methods

  NameDescription
Public methodAddTransformation
Adds a DataTransformation to the flow.
Public methodBuild
Builds a data flow that can be used as a data source. Includes the original data source and the list of all added data transformations.
Public methodDispose
Dispose method.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute(DataSourcePromptMode)
Executes the flow. A connection to the data source will be made using the DataSourcePromptMode. The data will be passed through the list of DataTransformation's and the result returned.
Public methodExecute(Int32, DataSourcePromptMode)
Executes the flow. A connection to the data source will be made using the DataSourcePromptMode. The data will be passed through the list of DataTransformation's up to the specified step and the result will be returned.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemoveTransformation
Removes the last added DataTransformation.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

The flow is initially created from a DataSource and then transformations may be added after it has been created.

After a DataSource and DataTransformation objects have been added it can also be used execute the flow up to a certain DataTransformation.

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