Class DataFlowBuilder

This class is a builder that can be used to dynamically create a Spotfire.Dxp.Data.DataFlow instance.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataFlowBuilder

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor AddTransformation Build Dispose Execute RemoveTransformation

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Default capability

constructor

new DataFlowBuilder(dataSource, importContext): DataFlowBuilder
Initializes a new instance of the Spotfire.Dxp.Data.DataFlowBuilder class.
Parameters
- dataSource: DataSource
  The Spotfire.Dxp.Data.DataSource that defines the starting point of the flow.
- importContext: ImportContext
  The import context.
Returns DataFlowBuilder
Since
2.0

Overrides Object.constructor

AddTransformation

AddTransformation(transformation): number
Adds a Spotfire.Dxp.Data.DataTransformation to the flow.
Parameters
- transformation: DataTransformation
  The transformation to add.
Returns number
The index of the added transformation.

Since
2.0

Build

Build(): DataFlow
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.

Returns DataFlow
The created Spotfire.Dxp.Data.DataFlow.

Since
2.0

Dispose

Dispose(): void
Dispose method.

Returns void
Since
2.0

Execute

Execute(promptMode): DataRowReader
Executes the flow. A connection to the data source will be made using the Spotfire.Dxp.Data.DataSourcePromptMode. The data will be passed through the list of Spotfire.Dxp.Data.DataTransformation's and the result returned.
Parameters
- promptMode: DataSourcePromptMode
  The prompt mode.
Returns DataRowReader
The resulting Spotfire.Dxp.Data.DataRowReader.

Since
2.0
Execute(transformationIndex, promptMode): DataRowReader
Executes the flow. A connection to the data source will be made using the Spotfire.Dxp.Data.DataSourcePromptMode. The data will be passed through the list of Spotfire.Dxp.Data.DataTransformation's up to the specified step and the result will be returned.
Parameters
- transformationIndex: number | Int32
  At which transformation the execution should stop, 0 to just execute the data source.
- promptMode: DataSourcePromptMode
  The prompt mode.
Returns DataRowReader
The resulting Spotfire.Dxp.Data.DataRowReader.

Since
2.0

RemoveTransformation

RemoveTransformation(): boolean
Removes the last added Spotfire.Dxp.Data.DataTransformation.

Returns boolean
True if the last transformation was successfully removed; otherwise False.

Since
2.0

Class DataFlowBuilder

Since

Hierarchy (view full)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Parameters

Returns DataFlowBuilder

Since

AddTransformation

Parameters

Returns number

Since

Build

Returns DataFlow

Since

Dispose

Returns void

Since

Execute

Parameters

Returns DataRowReader

Since

Parameters

Returns DataRowReader

Since

RemoveTransformation

Returns boolean

Since

Settings

On This Page

`Static`Equals