Spotfire.Dxp.Data.DataFunctions Namespace

TIBCO Spotfire 10.0 API Reference
The Spotfire.Dxp.Data.DataFunctions namespace contains classes enabling function definition, function execution in a background thread, and handling of function output.
Classes

  ClassDescription
Public classColumnsOutput
Represents the settings for the handling of a OutputParameter of a DataFunction. This class will add columns to an existing table when first executed and when updated it will either update those column or add new columns depending on the settings.
Public classColumnsOutputPropertyNames
Contains property name constants for the public properties of ColumnsOutput.
Public classColumnsOutputBuilder
Represents a builder class for creating a ColumnsOutput for a DataFunction. Used as input in DataFunctionOutputCollection.
Public classDataFunction
Represents an execution of a data function defined from a DataFunctionDefinition.
Public classDataFunctionPropertyNames
Contains property name constants for the public properties of DataFunction.
Public classDataFunctionCollection
Represents a list of DataFunction instances.
Public classDataFunctionCollectionPropertyNames
Public classDataFunctionDefinition
Represents a definition of an data function.

The definition describes the information needed to invoke the function and enough information to provide a user interface for specifying how the inputs and outputs should be handled. If the function definition represents a script it also contains the script definition.

The function definition provides methods to save and load the definition from the Spotfire library.

Public classDataFunctionDefinitionBuilder
Responsible for building a DataFunctionDefinition.
Public classDataFunctionExecutorService
This is a global service that can be used to execute functions through data function executors without using the document directly.
Public classDataFunctionExecutorTypeIdentifiers
Type identifiers for function providers.
Public classDataFunctionExpressionFunction
Represents a data function expression function.
Public classDataFunctionExpressionFunctionCollection
This class represents a collection of data function expression functions. These functions calls data functions through the Spotfire expression language.
Public classDataFunctionExpressionFunctionCollectionPropertyNames
Contains property name constants for the public properties of DataFunctionExpressionFunctionCollection.
Public classDataFunctionInput
Defines how to retrieve the input for an InputParameter in a DataFunction.

An input to a data function is an expression representing a list of columns and optionally a set of selections that can be used to define the rows that the expression should be calculated on. The expression is calculated on the intersection of all the included selections.

Instances of this class is created in the DataFunctionInputCollection class.

Public classDataFunctionInputPropertyNames
Contains property name constants for the public properties of DataFunctionInput.
Public classDataFunctionInputCollection
Represents the declarations on how to retrieve the values for InputParameters in a DataFunction.
Public classDataFunctionInputCollectionPropertyNames
Contains property name constants for the public properties of DataFunctionInputCollection.
Public classDataFunctionInvocation
Represents an invocation of a data function.
Public classDataFunctionInvocationBuilder
A builder that is used to create a DataFunctionInvocation which is used as a transient object when executing the function defined by a DataFunctionDefinition using the DataFunctionExecutorService.
Public classDataFunctionOutput
The data function output mapping.
Public classDataFunctionOutputPropertyNames
Contains property name constants for the public properties of DataFunctionOutput.
Public classDataFunctionOutputBuilder
Represents a builder for output mappings.
Public classDataFunctionOutputCollection
Represents the declarations on how to handle the results for OutputParameters in a DataFunction.
Public classDataFunctionOutputCollectionPropertyNames
Contains property name constants for the public properties of DataFunctionOutputCollection.
Public classInputParameter
Represents an input parameter to a data function.
Public classInputParameterBuilder
Responsible for building an input parameter to a data function.
Public classJoinOutput
Output mapping class for adding columns to a new table using a join.
Public classJoinOutputPropertyNames
Contains property name constants for the public properties of JoinOutput.
Public classJoinOutputBuilder
Represents a builder class for outputmappings that add columns to a table. Used as input in DataFunctionOutputCollection.
Public classOutputParameter
An output parameter from an data function.
Public classOutputParameterBuilder
Responsible for building an input argument to a data function.
Public classPropertyOutput
Output mapping class for setting the values of properties as output.
Public classPropertyOutputPropertyNames
Contains property name constants for the public properties of PropertyOutput.
Public classPropertyOutputBuilder
Represents a builder class for outputmappings that create a new table. Used as input in DataFunctionOutputCollection.
Public classReplaceDataOutput
Output mapping class for replacing data.
Public classReplaceDataOutputPropertyNames
Contains property name constants for the public properties of ReplaceDataOutput.
Public classReplaceDataOutputBuilder
Represents a builder class for outputmappings that replace a datatable. Used as input in DataFunctionOutputCollection.
Public classRowsOutput
Represents the settings for the handling of a OutputParameter of a DataFunction. This class will add rows to an existing table when first executed and when updated it will either update those rows or add new rows depending on the settings.
Public classRowsOutputPropertyNames
Contains property name constants for the public properties of RowsOutput.
Public classRowsOutputBuilder
Represents a builder class for creating a RowsOutput for a DataFunction. Used as input in DataFunctionOutputCollection.
Public classTableOutput
Output mapping class for adding a new table.
Public classTableOutputPropertyNames
Contains property name constants for the public properties of TableOutput.
Public classTableOutputBuilder
Represents a builder class for outputmappings that create a new table. Used as input in DataFunctionOutputCollection.
Delegates

  DelegateDescription
Public delegateDataFunctionCompletionCallback
A delegate the is used to provide a callback for the execution of a DataFunction.
Enumerations

  EnumerationDescription
Public enumerationDataFunctionNameHandling
Specifies how name handling should be performed for a custom data function executor.
Public enumerationDataFunctionUpdateBehavior
The update behavior for a data function.
Public enumerationParameterType
The type of a input or output parameter of a data function.