Transform Class

The base class for transform nodes.
Inheritance Hierarchy

Namespace:  Dundas.BI.Data.Transforms
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
public abstract class Transform : ComponentBase, 
	IDisposable, IDataWarnings

The Transform type exposes the following members.

Constructors
  NameDescription
Protected methodTransform
Initializes a new instance of the Transform class.
Top
Properties
  NameDescription
Public propertyAdapterUIClassName
Gets a value indicating the name of the java script adapter class which is to be created for this transform.
Public propertyColor
Gets or sets the object color.
Public propertyComponentDescription
Gets the standard component description.
(Inherited from ComponentBase.)
Public propertyComponentId
Gets the component ID.
(Inherited from ComponentBase.)
Public propertyComponentName
Gets the standard component name.
(Inherited from ComponentBase.)
Public propertyDescription
Gets or sets the object description.
Public propertyElementExpressions
Gets the element process expressions, if any are defined for the current transform.
Public propertyEntity
Gets the parent entity.
Public propertyHasCustomConfigurationUI
Gets a value indicating whether this transform is using a custom configuration UI.
Public propertyHasElementExpressions
Gets a value indicating whether this instance has element process expressions defined within.
Public propertyHasTransformExpressions
Gets a value indicating whether this instance has transform expressions defined within.
Public propertyHasWarnings
Gets a value indicating whether this instance has any warnings.
Public propertyHelpUri
Gets a URI to a web page which provides documentation about the transform.
Public propertyId
Gets the object ID.
Public propertyInput
Gets the transform main input.
Public propertyInputs
Gets the inputs.
Public propertyIsAvailableInToolbar
Gets a value indicating whether or not the transform will be available in the toolbar.
Public propertyIsClosureTransform
Gets a value indicating whether this instance is a closure transform.
Public propertyIsConfigured
Gets a value indicating whether this instance is configured properly. When overriding, always check the value on the base class first.
Public propertyIsDoubleWidthDialog
Gets a value indicating whether this transform requires a double width UI dialog.
Public propertyIsDynamicInputSupported
Gets a value indicating whether this instance supports a dynamic number of inputs When true, all dynamic inputs get their settings from the primary transform input.
Public propertyIsEnabled
Gets a value indicating whether the component is enabled.
(Inherited from ComponentBase.)
Public propertyIsGroupRecordTransform
Gets a value indicating whether this instance processes multiple records at a time.
Public propertyIsInceptionTransform
Gets a value indicating whether this instance is an inception transform.
Public propertyIsInMemoryProcess
Gets a value indicating whether the current instance is executed as an in-memory process.
Public propertyIsInputConnectionValid
Gets a value indicating whether this instance has a valid input connection.
Public propertyIsMultipleElementTransform
Gets a value indicating whether this instance processes multiple elements at a time.
Public propertyIsOutputConnectionValid
Gets a value indicating whether this instance has a valid output connection.
Public propertyIsSingleElementTransform
Gets a value indicating whether this instance processes a single element at a time.
Public propertyIsSingleRecordTransform
Gets a value indicating whether this instance processes one record at a time.
Public propertyIsStepTransform
Gets a value indicating whether this instance is a process step transform.
Public propertyIsUnsafeQueryPrivilegeRequired
Gets a value indicating whether this instance requires unsafe query privileges.
Public propertyName
Gets or sets the object name.
Public propertyNodeIconUri
Gets a value indicating the relative path to be used as the transform's node icon when rendered on the canvas.
Public propertyOutput
Gets the transform main output.
Public propertyPackageId
Gets the ID of the extension package to which the component belongs.
(Inherited from ComponentBase.)
Public propertyParameters
Gets all the parameters defined for the current instance. These are either expression parameters or native structure parameters, if the current instance is a SelectTransform .
Public propertyProcess
Gets the parent DataProcess.
Public propertyProcessingType
Gets the type of the processing.
Public propertySettingValues
Gets the setting values for the current instance.
Public propertySupportsOutputExpressions
Gets a value indicating whether this instance supports the definition of output connector elements based on ConnectorElementExpression.
Public propertySupportsParameterizableOutputElements
Gets a value indicating whether the output elements for the current instance are parameterizable.
Public propertySupportsTransformExpressions
Gets a value indicating whether the current transform supports TransformExpressions that define the current instance functionality.
Public propertyToolbarIconUri
Gets a value indicating the relative path to be used as the transform's icon in the toolbar.
Public propertyTransformExpressions
Gets the transform expressions, if any are defined for the current transform.
Public propertyTransformSettings
Gets the transform generic settings.
Public propertyWarnings
Gets all the warnings currently associated with this instance.
Top
Methods
  NameDescription
Public methodAddDynamicInput
Adds one dynamic input to the current instance. The dynamic input always takes its element settings (if any) from the primary transform input. Dynamic inputs do not support transform settings.
Public methodAddOutputExpression
Adds a new ExpressionDescriptor for an output connector element .
Protected methodAddTransformExpression
Adds a new TransformExpression for the current instance .
Protected methodAddWarning
Adds a data warning to the current instance.
Protected methodAppendTransformSettings
Protected methodClearWarnings
Clears all data warnings from the current instance.
Public methodConfigureSetting(ParameterValue)
Configures a transform setting.
Public methodConfigureSetting(ConnectorElement, ParameterValue)
Configures an input element setting.
Public methodConfigureSetting(InputConnector, ParameterValue)
Configures transform input setting.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Public methodFetchElementValue
Fetches the value for the specified output element for run time data retrieval.
Protected methodFinalize
Finalizes an instance of the Transform class.
(Overrides ObjectFinalize.)
Public methodFindConnectorElement(Guid)
Finds a connector element by its ID.
Protected methodFindConnectorElement(String)
Finds the connector element by native name.
Public methodGenerateOutputElementSources
Generates the list of OutputElementSource, which are used elements for an OutputConnector.
Public methodGenerateProviderTask
Generates a data provider task, in those cases when the transform may be compatible with specific provider categories, such as OLAP providers or relational data providers.
Public methodGetConfigurationValue(Guid)
Gets the configuration value for a transform setting.
Public methodGetConfigurationValue(ComponentSetting)
Gets the configuration value for a transform setting.
Public methodGetConfigurationValue(ConnectorElement, Guid)
Gets the configuration value for an input connector element setting.
Public methodGetConfigurationValue(InputConnector, Guid)
Gets the configuration value for a transform input setting.
Public methodGetCustomConfigurationUI
Gets the custom configuration UI based on the requested content type.
Protected methodGetMetadata
Populates the process transform metadata by describing the data inputs, output and any available settings.
Public methodGetParameterValue
Gets the specified transform parameter value.
Protected methodInitializeSettingsFromContract
Initialize setting values using values stored in a data contract.
Protected methodLocalize
Localizes the specified string using the engine localization service.
(Inherited from ComponentBase.)
Public methodPreviewReader
Previews the output for the current instance.
Public methodRead
Reads a single record for the transform output, if there are any. If there are no more output records, it returns . The base class implementation calls Read on all the input readers and return if at least one of these operations is successful. Transforms that process a single record at one time do not need to override the base class implementation. Transforms that process multiple records at one time need to override the base class implementation by retrieving the necessary input data and also performing output record processing. If the Read operation is successful, the transform is responsible for providing corresponding data values on subsequent FetchElementValue calls.
Public methodRefresh
Updates the collection of output elements, evaluating all setting and parameter values.
Public methodRemoveDynamicInput
Removes a previously defined dynamic input.
Public methodRemoveOutputExpression
Removes a process expression previously defined for an output connector element.
Protected methodRemoveTransformExpression
Removes a transform expression previously defined for the current instance.
Protected methodRemoveWarning
Removes the specified data warning from the current instance.
Public methodResumeOutputAutoUpdate
Resumes the automatic update for the output elements.
Public methodResumeOutputAutoUpdate(Boolean)
Resumes the automatic update for the output elements.
Public methodSuppressOutputAutoUpdate
Suppresses the automatic update for the output elements.
Public methodTakeSnapshot
Returns a snapshot that can be used to detect future changes to this transform.
Public methodValidateSettingValues
Validates the settings values against their type, valid values and allowed range.
Public methodValidateTransform
Validates the transform prior to execution and throws if any setting values are invalid.
Top
See Also