com.informatica.powercenter.sdk.mapfwk.core
Class TransformHelper

java.lang.Object
  com.informatica.powercenter.sdk.mapfwk.core.TransformHelper

public class TransformHelper
extends java.lang.Object

Helper class to simplify Transformation creation. This helper allows creation of Transformation objects on a given Mapping object.

TransformHelper

public TransformHelper(Mapping mapping)

Initialize the object with a Mapping object

Parameters:

mapping - Mapping object

TransformHelper

public TransformHelper(Mapplet mapplet)

Initialize the object with a Mapplet object

Parameters:

mapplet - Mapplet object

sourceQualifier

public OutputSet sourceQualifier(Source source)
                          throws InvalidTransformationException

Apply the Source Qualifier transformation on a Source object

Parameters:

source - object

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

Source, InvalidTransformationException

expression

public OutputSet expression(RowSet rowSet,
                            TransformField transformField,
                            java.lang.String name)
                     throws InvalidTransformationException

Apply the expression transformation on a RowSet by adding a TransformField.

Parameters:

rowSet - RowSet object

transformField - TransformField object

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException

expression

public OutputSet expression(RowSet rowSet,
                            java.util.Vector vTransformField,
                            java.lang.String name)
                     throws InvalidTransformationException

Apply the expression transformation on a RowSet by adding a collection of TransformField.

Parameters:

rowSet - RowSet object

vTransformField - TransformField object

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException

expression

public OutputSet expression(InputSet inSet,
                            TransformField transformField,
                            java.lang.String name)
                     throws InvalidTransformationException

Apply the expression transformation on a InputSet by adding a TransformField.

Parameters:

inSet - InputSet object

transformField - TransformField object

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException

expression

public OutputSet expression(java.util.Vector vInputSets,
                            java.util.Vector vTransformFields,
                            java.lang.String name)
                     throws InvalidTransformationException

Apply the expression transformation on a collection of InputSets by adding a collection of TransformFields.

Parameters:

vInputSets - collection of InputSet objects

vTransformFields - collection of TransformFields

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException

expression

public OutputSet expression(java.util.Vector vInputSets,
                            java.util.Vector vTransformFields,
                            TransformationProperties props,
                            java.lang.String name)
                     throws InvalidTransformationException

Apply the expression transformation on a collection of InputSets by adding a collection of TransformFields and TransformationProperties

Parameters:

vInputSets - collection of InputSet objects

vTransformFields - collection of TransformFields

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException, TransformationProperties

aggregate

public OutputSet aggregate(RowSet rowSet,
                           TransformField transformField,
                           java.lang.String[] groupBy,
                           java.lang.String name)
                    throws InvalidTransformationException

Apply the aggregate transformation on a RowSet by adding a TransformField for a given group by criteria

Parameters:

rowSet - RowSet

transformField -

groupBy - criteria

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException

aggregate

public OutputSet aggregate(RowSet rowSet,
                           java.util.Vector vTransformField,
                           java.lang.String[] groupBy,
                           java.lang.String name)
                    throws InvalidTransformationException

Apply the aggregate transformation on a RowSet by adding a collection of TransformFields for a given group by criteria

Parameters:

rowSet - RowSet

vTransformField - Vector of TransformField objects

groupBy - criteria

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException

aggregate

public OutputSet aggregate(java.util.Vector vInputSets,
                           java.util.Vector vTransformFields,
                           java.lang.String[] groupBy,
                           java.lang.String name)
                    throws InvalidTransformationException

Apply the aggregate transformation on a collection of InputSets by adding a collection of TransformFields for a given group by criteria

Parameters:

vInputSets - collection of InputSet's

vTransformFields - collection of TransformField's

groupBy - criteria

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException

aggregate

public OutputSet aggregate(java.util.Vector vInputSets,
                           java.util.Vector vTransformFields,
                           java.lang.String[] groupBy,
                           TransformationProperties props,
                           java.lang.String name)
                    throws InvalidTransformationException

Apply the aggregate transformation on a collection of InputSets by adding a collection of TransformFields for a given group by criteria and TransformationProperties

Parameters:

vInputSets - collection of InputSet's

vTransformFields - collection of TransformField's

groupBy - group by criteria

name - name of transformation

props - TransformationProperties

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException, TransformationProperties

filter

public OutputSet filter(RowSet rowSetObj,
                        java.lang.String filterExpr,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the filter transformation using an expression on a RowSet

Parameters:

rowSetObj - RowSet object

filterExpr - filter expression

name - transformation name

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

filter

public OutputSet filter(InputSet inputSetObj,
                        java.lang.String filterExpr,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the filter transformation using an expression on a InputSet

Parameters:

inputSetObj - RowSet object

filterExpr - filter expression

name - transformation name

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

filter

public OutputSet filter(java.util.Vector inputSets,
                        java.lang.String filterExpr,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the filter transformation using an expression on a collection of InputSets

Parameters:

inputSets - collection of InputSet's

filterExpr - filter expression

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

filter

public OutputSet filter(java.util.Vector inputSets,
                        java.lang.String filterExpr,
                        TransformationProperties properties,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the filter transformation using an expression on a collection of InputSets and properties

Parameters:

inputSets - collection of InputSet's

filterExpr - filter expression

properties - TransformationProperties object

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

lookup

public OutputSet lookup(RowSet rowSetObj,
                        SourceTarget sourceTgtObj,
                        java.lang.String condition,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the lookup transformation on a rowset using fields from a source for a set of conditions specified as a Lookup Condition

Parameters:

rowSetObj - RowSet object

name - name of transformation

sourceTgtObj - Source object

condition - Lookup Condition as a string, eg: ORDER_ID = IN_ORDER_ID

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

RowSet, Source, InvalidTransformationException

lookup

public OutputSet lookup(InputSet inputSetObj,
                        SourceTarget sourceTgtObj,
                        java.lang.String condition,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the lookup transformation on a InputSet using fields from a source for a set of conditions specified as a Lookup condition

Parameters:

inputSetObj - InputSet object

sourceTgtObj - Source object

condition - Lookup Condition as a string, eg: ORDER_ID = IN_ORDER_ID

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, Source, InvalidTransformationException

lookup

public OutputSet lookup(java.util.Vector vInputSets,
                        SourceTarget sourceTgtObj,
                        java.lang.String condition,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the lookup transformation on a collection of InputSet's using fields from a source for a set of conditions specified as a Lookup condition

Parameters:

vInputSets - collection of InputSet's

sourceTgtObj - Source object

name - name of transformation

condition - Lookup Condition as a string, eg: ORDER_ID = IN_ORDER_ID

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, Source, InvalidTransformationException

lookup

public OutputSet lookup(java.util.Vector vInputSets,
                        SourceTarget sourceTgtObj,
                        java.lang.String condition,
                        TransformationProperties props,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the lookup transformation on a collection of InputSet's using fields from a source for a set of conditions specified as a Lookup condition along with additional properties

Parameters:

vInputSets - collection of InputSet's

sourceTgtObj - Source object

condition - Lookup Condition as a string, eg: ORDER_ID = IN_ORDER_ID

props - TransformationProperties

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, Source, InvalidTransformationException, TransformationProperties

join

public OutputSet join(java.util.Vector vDetailRowSets,
                      RowSet masterRowSet,
                      java.lang.String joinCnd,
                      java.lang.String name)
               throws InvalidTransformationException

Apply the joiner transformation on a collection of Detail RowSet's using a given RowSet as a master. In addition, the join type as well as the join conditions should be specified

Parameters:

vDetailRowSets - collection of RowSet's to be joined - the collection should not include the master rowset

masterRowSet - master RowSet

joinCnd - String with the join condition, for ex: ORDER_ID = IN_ORDER_ID

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

join

public OutputSet join(java.util.Vector vDetailInputSets,
                      InputSet masterInputSet,
                      java.lang.String joinCnd,
                      java.lang.String name)
               throws InvalidTransformationException

Apply the joiner transformation on a collection of Detail InputSet's using a given InputSet as a master. In addition, the join type as well as the join conditions should be specified.

Parameters:

vDetailInputSets - collection of InputSet's to be joined - the collection should not include the master InputSet

masterInputSet - master InputSet

joinCnd - String with the join condition, for ex: ORDER_ID = IN_ORDER_ID

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

join

public OutputSet join(java.util.Vector vDetailInputSets,
                      InputSet masterInputSet,
                      java.lang.String joinCnd,
                      TransformationProperties properties,
                      java.lang.String name)
               throws InvalidTransformationException

Apply the joiner transformation on a collection of Detail InputSet's using a given InputSet as a master. In addition, the join type as well as the join conditions should be specified. Additional properties for JoinTransformation can also be specified.

Parameters:

vDetailInputSets - collection of InputSet's to be joined - the collection should not include the master rowset

masterInputSet - master InputSet

joinCnd - String with the join condition, for ex: ORDER_ID = IN_ORDER_ID

properties - TransformationProperties object

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException, TransformationProperties

rank

public OutputSet rank(RowSet rowSetObj,
                      int rank,
                      java.lang.String rankPort,
                      java.lang.String[] groupBy,
                      java.lang.String name)
               throws InvalidTransformationException

This method creates a Rank Transformation using RowSet without specifying a transformation field and but giving rank order.

Parameters:

rowSetObj - Field Input to the rank

rank - No of rank that is required

rankPort - Port on which to rank

groupBy - groupBy ports

name - name of the Rank Transformation

Returns:

OutputSet

Throws:

InvalidTransformationException

rank

public OutputSet rank(RowSet rowSetObj,
                      int rank,
                      java.lang.String rankPort,
                      java.lang.String[] groupBy,
                      java.lang.String name,
                      boolean top)
               throws InvalidTransformationException

This method creates a Rank Transformation using a RowSet without specifying a transformation field and but giving rank order.

Parameters:

rowSetObj - Field Input to the rank

rank - No of rank that is required

rankPort - Port on which to rank

groupBy - groupBy ports

name - name of the Rank Transformation

top - Rank from TOP or BOTTOM default TOP

Returns:

OutputSet

Throws:

InvalidTransformationException

rank

public OutputSet rank(InputSet inputSetObj,
                      int rank,
                      java.lang.String rankPort,
                      java.lang.String[] groupBy,
                      java.lang.String name)
               throws InvalidTransformationException

This method creates a Rank Transformation using an InputSet without specifying a transformation field and using default rank order i.e TOP.

Parameters:

inputSetObj - Field Input to the rank

rank - No of rank that is required

rankPort - Port on which to rank

groupBy - groupBy ports

name - name of the Rank Transformation

Returns:

OutputSet

Throws:

InvalidTransformationException

rank

public OutputSet rank(InputSet inputSetObj,
                      int rank,
                      java.lang.String rankPort,
                      java.lang.String[] groupBy,
                      java.lang.String name,
                      TransformField transformField)
               throws InvalidTransformationException

This method creates a Rank Transformation using a transformation field and rank order.

Parameters:

inputSetObj - Field Input to the rank

rank - No of rank that is required

rankPort - Port on which to rank

groupBy - groupBy ports

name - name of the Rank Transformation

transformField - transformfield to be set

Returns:

OutputSet

Throws:

InvalidTransformationException

rank

public OutputSet rank(InputSet inputSetObj,
                      int rank,
                      java.lang.String rankPort,
                      java.lang.String[] groupBy,
                      java.lang.String name,
                      boolean top,
                      java.util.Vector vTransformField)
               throws InvalidTransformationException

This method creates a Rank Transformation using a given set of transformation field and rank order.

Parameters:

inputSetObj - Field Input to the rank

rank - No of rank that is required

rankPort - Port on which to rank

groupBy - groupBy ports

name - name of the Rank Transformation

top - Rank from TOP or BOTTOM default TOP

vTransformField - vector of transformfields

Returns:

OutputSet

Throws:

InvalidTransformationException

rank

public OutputSet rank(InputSet inputSetObj,
                      int rank,
                      java.lang.String rankPort,
                      java.lang.String[] groupBy,
                      java.lang.String name,
                      boolean top,
                      java.util.Vector vTransformField,
                      TransformationProperties properties)
               throws InvalidTransformationException

This method creates a Rank Transformation using a given set of transformation properties, transformation field and rank order.

Parameters:

inputSetObj - Field Input to the rank

rank - No of rank that is required

rankPort - Port on which to rank

groupBy - groupBy ports

name - name of the Rank Transformation

top - Rank from TOP or BOTTOM default TOP

vTransformField - vector of transformfields

properties - A set of transformation properties.

Returns:

OutputSet

Throws:

InvalidTransformationException

updateStrategy

public OutputSet updateStrategy(RowSet rowSetObj,
                                java.lang.String strategyExpr,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the Update Strategy transformation using an expression on a RowSet

Parameters:

rowSetObj - RowSet object

strategyExpr - strategy expression

name - transformation name

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

updateStrategy

public OutputSet updateStrategy(InputSet inputSetObj,
                                java.lang.String strategyExpr,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the Update Strategy transformation using an expression on a InputSet

Parameters:

inputSetObj - RowSet object

strategyExpr - strategy expression

name - transformation name

Returns:

OutputSet object

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

updateStrategy

public OutputSet updateStrategy(java.util.Vector inputSets,
                                java.lang.String strategyExpr,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the Update Strategy transformation using an expression on a collection of InputSets

Parameters:

inputSets - collection of InputSet's

strategyExpr - strategy expression

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

updateStrategy

public OutputSet updateStrategy(java.util.Vector inputSets,
                                java.lang.String strategyExpr,
                                TransformationProperties properties,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the Update Strategy transformation using an expression on a collection of InputSets and properties

Parameters:

inputSets - collection of InputSet's

strategyExpr - strategy expression

properties - TransformationProperties object

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

sequenceGenerator

public OutputSet sequenceGenerator(java.lang.String name)
                            throws InvalidTransformationException

Apply the Sequence Generator transformation

Parameters:

name - name of transformation

Returns:

OutputSet object

Throws:

InvalidTransformationException

See Also:

OutputSet, InvalidTransformationException

sequenceGenerator

public OutputSet sequenceGenerator(java.lang.String name,
                                   TransformationProperties properties)
                            throws InvalidTransformationException

Apply the Sequence Generator transformation with properties

Parameters:

name - name of transformation

properties - TransformationProperties object

Returns:

OutputSet object

Throws:

InvalidTransformationException

See Also:

OutputSet, InvalidTransformationException

sorter

public OutputSet sorter(RowSet rowSetObj,
                        java.lang.String sorterPort,
                        boolean ascending,
                        java.lang.String name)
                 throws InvalidTransformationException

This method creates a Sorter Transformation using a RowSet as input a sorting port and the sort direction.

Parameters:

rowSetObj - The Input RowSet

sorterPort - port on which to sort

ascending - direction of sorting

name - name of the Transformation

Returns:

OutputSet

Throws:

InvalidTransformationException

sorter

public OutputSet sorter(RowSet rowSetObj,
                        java.lang.String[] sorterPort,
                        boolean[] ascending,
                        java.lang.String name)
                 throws InvalidTransformationException

This method creates a Sorter Transformation using a RowSet as input an array of sorting port and the sort direction.

Parameters:

rowSetObj - The Input RowSet

sorterPort - port on which to sort

ascending - direction of sorting

name - name of the Transformation

Returns:

OutputSet

Throws:

InvalidTransformationException

sorter

public OutputSet sorter(InputSet inputSetObj,
                        java.lang.String sorterPort,
                        boolean ascending,
                        java.lang.String name)
                 throws InvalidTransformationException

This method creates a Sorter Transformation using an InputSet as input a sorting port and the sort direction.

Parameters:

inputSetObj - The Input RowSet

sorterPort - port on which to sort

ascending - direction of sorting

name - name of the Transformation

Returns:

OutputSet

Throws:

InvalidTransformationException

sorter

public OutputSet sorter(InputSet inputSetObj,
                        java.lang.String[] sorterPort,
                        boolean[] ascending,
                        java.lang.String name)
                 throws InvalidTransformationException

This method creates a Sorter Transformation using an InputSet as input an array of sorting port and the sort direction.

Parameters:

inputSetObj - The Input RowSet

sorterPort - port on which to sort

ascending - direction of sorting

name - name of the Transformation

Returns:

OutputSet

Throws:

InvalidTransformationException

sorter

public OutputSet sorter(InputSet inputSetObj,
                        java.lang.String[] sorterPort,
                        boolean[] ascending,
                        java.lang.String name,
                        TransformField transformField)
                 throws InvalidTransformationException

This method creates a Sorter Transformation using an InputSet as Input an array of sorting port and the sort direction and a new transformafield.

Parameters:

inputSetObj - The Input RowSet

sorterPort - port on which to sort

ascending - direction of sorting

name - name of the Transformation

transformField - The new transformation field to be used.

Returns:

OutputSet

Throws:

InvalidTransformationException

sorter

public OutputSet sorter(InputSet inputSetObj,
                        java.lang.String[] sorterPort,
                        boolean[] ascending,
                        java.lang.String name,
                        TransformationProperties properties,
                        java.util.Vector vTransformField)
                 throws InvalidTransformationException

This method creates a Sorter Transformation using an InputSet as Input an array of sorting port and the sort direction, a new transformafield and a set of TransformationProperties.

Parameters:

inputSetObj - The Input RowSet

sorterPort - port on which to sort

ascending - direction of sorting

name - name of the Transformation

vTransformField - A new set of transformation field to be used.

Returns:

OutputSet

Throws:

InvalidTransformationException

transactionControl

public OutputSet transactionControl(RowSet rowSet,
                                    java.lang.String name,
                                    java.lang.String condition,
                                    TransformationProperties properties)
                             throws InvalidTransformationException

Apply the Transaction Control transformation on a RowSet.

Parameters:

rowSet - InputSet object

name - name of transformation

condition - the Transaction Control Condition

Returns:

OutputSet

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException, TransformationProperties

transactionControl

public OutputSet transactionControl(RowSet rowSet,
                                    java.util.Vector vTransformField,
                                    java.lang.String name,
                                    java.lang.String condition,
                                    TransformationProperties properties)
                             throws InvalidTransformationException

Apply the Transaction Control transformation on a RowSet by adding a collection of TransformFields.

Parameters:

rowSet - InputSet object

vTransformField - collection of TransformFields

name - name of transformation

condition - Transaction Control condition

Returns:

OutputSet

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException, TransformationProperties

transactionControl

public OutputSet transactionControl(InputSet inputSet,
                                    java.util.Vector vTransformFields,
                                    java.lang.String name,
                                    java.lang.String condition,
                                    TransformationProperties properties)
                             throws InvalidTransformationException

Apply the Transaction Control transformation on a collection of InputSets by adding a collection of TransformFields and TransformationProperties

Parameters:

inputSet - InputSet object

vTransformFields - collection of TransformFields

name - name of transformation

condition - Transaction Control condition

Returns:

OutputSet

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException, TransformationProperties

router

public OutputSet router(RowSet rowSet,
                        TransformGroup transGroup,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the Router transformation on a RowSet along with TransformGroup object

Parameters:

rowSet - RowSet object

transGroup - Transformgroup object

name - Transformation name

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

RowSet, TransformGroup, InvalidTransformationException

router

public OutputSet router(RowSet rowSet,
                        java.util.Vector vTransGroup,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the Router transformation on a RowSet along with collection of TransformGroup objects

Parameters:

rowSet - RowSet object

vTransGroup - vector of TransformGroup objects

name - Transformation name

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

RowSet, TransformGroup, InvalidTransformationException

router

public OutputSet router(InputSet inputSet,
                        TransformGroup transGroup,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the Router transformation on an InputSet along with TransformGroup

Parameters:

inputSet - InputSet object

transGroup - Transformgroup object

name - Transformation name

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

InputSet, TransformGroup, InvalidTransformationException

router

public OutputSet router(InputSet inputSet,
                        java.util.Vector vTransGroup,
                        java.lang.String name)
                 throws InvalidTransformationException

Apply the Router transformation on a InputSet along with collection of TransformGroup objects

Parameters:

inputSet - InputSet object

vTransGroup - Vector of TransformGroups

name - Transformation name

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

InputSet, TransformGroup, InvalidTransformationException

router

public OutputSet router(InputSet inputSet,
                        java.util.Vector vTransGroup,
                        java.lang.String name,
                        TransformationProperties properties)
                 throws InvalidTransformationException

Apply the Router transformation on InputSet along with collection of TransformGroup objects

Parameters:

inputSet - InputSet object

vTransGroup - Vector of TransformGroups

name - Transformation name

properties - TransformationProperties object

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

InputSet, TransformGroup, InvalidTransformationException, TransformationProperties

router

public OutputSet router(java.util.Vector vInputSets,
                        java.util.Vector vTransGroup,
                        java.lang.String name,
                        TransformationProperties properties)
                 throws InvalidTransformationException

Apply the Router transformation on a collection of InputSets along with collection of TransformGroup objects

Parameters:

vInputSets -

vTransGroup -

name -

properties -

Returns:

outputSet

Throws:

InvalidTransformationException

union

public OutputSet union(RowSet rowSetObj,
                       RowSet groupFieldSet,
                       java.lang.String name)
                throws InvalidTransformationException

Apply the union transformation on a single RowSet and along with group field RowSet. The number fields in rowSetObj should match with groupFieldSet and also it should match datatype, scale, precision of each fields else it throws an exception

Parameters:

rowSetObj - RowSet object

groupFieldSet - RowSet object

name - transformation name

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

RowSet, InvalidTransformationException

union

public OutputSet union(InputSet inputSetObj,
                       RowSet groupFieldSet,
                       java.lang.String name)
                throws InvalidTransformationException

Apply the union transformation on a single InputSet and along with group field RowSet. The number fields in inputSetObj should match with groupFieldSet and also it should match datatype, scale, precision of each fields else it throws an exception

Parameters:

inputSetObj - InputSet object

groupFieldSet - RowSet object

name - transformation name

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

RowSet, InputSet, InvalidTransformationException

union

public OutputSet union(java.util.Vector inputSets,
                       RowSet groupFieldSet,
                       java.lang.String name)
                throws InvalidTransformationException

Apply the union transformation on a collection of InputSets and along with group field RowSet. The number fields in each IputSet object in inputSets should match with groupFieldSet and also it should match datatype, scale, precision of each fields else it throws an exception

Parameters:

inputSets - vector of InputSet object

groupFieldSet - RowSet object

name - transformation name

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

RowSet, InputSet, InvalidTransformationException

union

public OutputSet union(java.util.Vector inputSets,
                       RowSet groupFieldSet,
                       TransformationProperties properties,
                       java.lang.String name)
                throws InvalidTransformationException

Apply the union transformation on a collection of InputSets and along with group field RowSet and properties. The number fields in each IputSet object in inputSets should match with groupFieldSet and also it should match datatype, scale, precision of each fields else it throws an exception

Parameters:

inputSets - vector of InputSet object

groupFieldSet - RowSet object

name - transformation name

properties - TransformationProperties

Returns:

Returns OutputSet object

Throws:

InvalidTransformationException - exception

See Also:

RowSet, InputSet, InvalidTransformationException

storedProc

public OutputSet storedProc(RowSet rowSet,
                            java.lang.String name,
                            java.lang.String procName)
                     throws InvalidTransformationException

Apply the Stored Procedure transformation on a RowSet by giving the Stored Proc Name. The Input RowSet of the Stored Procedure must match the Input Parameters of the Stored procedure.

Parameters:

rowSet - InputSet object

name - name of transformation

procName - Stored Procedure Name

Returns:

OutputSet

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

storedProc

public OutputSet storedProc(RowSet rowSet,
                            java.util.Vector vTransformFields,
                            java.lang.String name,
                            java.lang.String procName)
                     throws InvalidTransformationException

Apply the Stored Procedure transformation on a RowSet by adding a collection of TransformFields and giving the Stored Proc Name. The Input RowSet of the Stored Procedure must match the Input Parameters of the Stored procedure.

Parameters:

rowSet - InputSet object

vTransformFields - collection of TransformFields

name - name of transformation

procName - Stored Procedure Name

Returns:

OutputSet

Throws:

InvalidTransformationException

See Also:

TransformField, RowSet, InvalidTransformationException

storedProc

public OutputSet storedProc(InputSet inputSet,
                            java.util.Vector vTransformFields,
                            java.lang.String name,
                            java.lang.String procName)
                     throws InvalidTransformationException

Apply the Stored Procedure transformation on an InputSet by adding a collection of TransformFields and giving the Stored Proc Name. The InputSet of the Stored Procedure must match the Input Parameters of the Stored procedure.

Parameters:

inputSet - InputSet object

vTransformFields - vTransformFields collection of TransformFields

name - name of transformation

procName - Stored Procedure Name

Returns:

OutputSet

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

storedProc

public OutputSet storedProc(InputSet inputSet,
                            java.util.Vector vTransformFields,
                            java.lang.String name,
                            java.lang.String procName,
                            TransformationProperties properties)
                     throws InvalidTransformationException

Apply the Stored Procedure transformation on an InputSet by adding a collection of TransformFields and giving the Stored Proc Name and setting the properties.The InputSet of the Stored Procedure must match the Input Parameters of the Stored procedure.

Parameters:

inputSet - InputSet object

vTransformFields - collection of TransformFields

name - name of transformation

procName - Stored Procedure Name

properties - TransformationProperties to be set

Returns:

OutputSet

Throws:

InvalidTransformationException

See Also:

TransformField, InputSet, InvalidTransformationException, TransformationProperties

custom

public OutputSet custom(java.util.Vector vGroupSets,
                        int transformationType,
                        java.lang.String name)
                 throws java.lang.Exception

Apply the Custom transformation on vector of GroupSet, transformation name and transformation type.

Parameters:

vGroupSets - vector of GroupSet

transformationType - Transformation type (TransformationConstants.PASSIVE or TransformationConstants.ACTIVE)

name - Transformation name

Returns:

Returns the OutputSet object

Throws:

java.lang.Exception

See Also:

GroupSet, TransformationConstants, CustomTransformation

mapplet

public OutputSet mapplet(java.util.Vector vGroupSets,
                         int transformationType,
                         java.lang.String name)
                  throws java.lang.Exception

Use the mapplet either as a Transformation or Source. The mapplet parameters should be supplied as a GroupSet. If the mapplet is to be used as a Source, then only OUTPUTGROUP GroupSet is needed. For Transformation, both INPUTGROUP and OUTPUTGROUP GroupSet(s) should be specified.

Parameters:

vGroupSets - collection of GroupSet

transformationType - Transformation type

name - transformation name

Returns:

the OutputSet object

Throws:

java.lang.Exception

See Also:

GroupSet, OutputSet

custom

public OutputSet custom(java.util.Vector vGroupSets,
                        int transformationType,
                        java.lang.String name,
                        java.lang.String moduleIdetifier,
                        java.lang.String functionIdetifier,
                        TransformationProperties properties)
                 throws java.lang.Exception

Apply the Custom transformation on vector of GroupSet, transformation name, transformation type, function identifier, module identifier and Transformation properties

Parameters:

vGroupSets - vector of GroupSet

transformationType - Transformation type (TransformationConstants.PASSIVE or TransformationConstants.ACTIVE)

name - Transformation name

moduleIdetifier - Module identifier

functionIdetifier - Function identifier

properties - Transformation properties

Returns:

Returns the OutputSet object

Throws:

java.lang.Exception

See Also:

GroupSet, TransformationConstants, CustomTransformation

unconnectedLookup

public UnconnectedLookup unconnectedLookup(java.lang.String name,
                                           Field returnPort,
                                           java.util.Vector inputFld,
                                           java.lang.String condition,
                                           SourceTarget srtTgt)

Create a UnConnected Lookup transformation that can be referred in other transformations. All the fields in the Source/Target will be used as Output/Lookup fields.

Parameters:

name - name of transformation

returnPort - return port for unconnected transformation

inputFld - collection of input fields

condition - lookup condition

srtTgt - Source/Target

Returns:

UnconnectedLookup

unconnectedLookup

public UnconnectedLookup unconnectedLookup(java.lang.String name,
                                           java.lang.String bussName,
                                           java.util.Vector lkpFields,
                                           Field returnPort,
                                           java.util.Vector inputFld,
                                           java.lang.String condition,
                                           SourceTarget srtTgt)

Create a UnConnected lookup transformation that can be referred in other transformations. All the fields in the Source/Target will be used as Output/Lookup fields.

Parameters:

name - name of transformation

bussName - business name of transformation

returnPort - return port for unconnected transformation

inputFld - collection of input fields

condition - lookup condition

srtTgt - Source/Target

Returns:

UnconnectedLookup

unconnectedLookup

public UnconnectedLookup unconnectedLookup(java.lang.String name,
                                           java.lang.String bussName,
                                           java.lang.String desc,
                                           java.util.Vector lkpFields,
                                           Field returnPort,
                                           java.util.Vector inputFld,
                                           java.lang.String condition,
                                           SourceTarget srtTgt)

Create a UnConnected lookup transformation that can be referred in other transformations. Only the fields that are specified in lkpFields vector would be used.

Parameters:

name - name of transformation

bussName - business name of transformation

desc - description

returnPort - return port for unconnected transformation

inputFld - collection of input fields

condition - lookup condition

srtTgt - Source/Target

Returns:

UnconnectedLookup

unconnectedLookup

public UnconnectedLookup unconnectedLookup(java.lang.String name,
                                           java.lang.String bussName,
                                           java.lang.String desc,
                                           Field returnPort,
                                           java.util.Vector inputFld,
                                           TransformationProperties properties,
                                           java.lang.String condition,
                                           SourceTarget srcTgt)

Create a UnConnected lookup transformation that can be referred in other transformations. Only the fields that are specified in lkpFields vector would be used.

Parameters:

name - name of transformation

bussName - business name of transformation

desc - description

returnPort - return port for unconnected transformation

inputFld - input field

properties - transformation properties

condition - lookup condition

srcTgt - Source/Target

Returns:

UnconnectedLookup

sqlTransformation

public OutputSet sqlTransformation(java.util.Vector vInputSets,
                                   java.util.Vector vTransformFields,
                                   java.lang.String name)
                            throws InvalidTransformationException

creates a SQL tranformation using the query mode, Oracle DB and static connection

Parameters:

vInputSets - Vector of InputSets. Only the first element is used by SQL transformation

vTransformFields - Vector of TransformField objects to be added to transformation

name - name of the transformation

Returns:

An Object of OutputSet

Throws:

InvalidTransformationException

sqlTransformation

public OutputSet sqlTransformation(java.util.Vector vInputSets,
                                   java.util.Vector vTransformFields,
                                   boolean isQueryMode,
                                   int DBType,
                                   boolean isStaticConnection,
                                   boolean isConnectionObjectProvided,
                                   java.lang.String name)
                            throws InvalidTransformationException

Creates a SQL transformation depending on the arguments passed. Only the first element in the vector of InputSets is used.

Parameters:

vInputSets - Vector of InputSets. Only the first element is used by SQL transformation

vTransformFields - Vector of TransformField objects to be added to transformation

isQueryMode - boolean denoting if the transformation is in query mode. If false, transformation is in script mode

DBType - Database type of connection. Use the static members in SQLTransformation class to set its value

isStaticConnection - boolean denoting if the connection is static. If false, connection is dynamic.

isConnectionObjectProvided - Used if isStaticConnection is false. If true, then logical connection object has to be passed in.

name - name of the transformation

Returns:

An Object of OutputSet

Throws:

InvalidTransformationException

sqlTransformation

public OutputSet sqlTransformation(java.util.Vector vInputSets,
                                   java.util.Vector vTransformFields,
                                   boolean isQueryMode,
                                   int DBType,
                                   boolean isStaticConnection,
                                   boolean isConnectionObjectProvided,
                                   java.lang.String name,
                                   TransformationProperties prop)
                            throws InvalidTransformationException

Creates a SQL transformation depending on the arguments passed. Only the first element in the vector of InputSets is used. The TransformProperties Object is used to set the transformation properties.

Parameters:

vInputSets - Vector of InputSets. Only the first element is used by SQL transformation

vTransformFields - Vector of TransformField objects to be added to transformation

isQueryMode - boolean denoting if the transformation is in query mode. If false, transformation is in script mode

DBType - Database type of connection. Use the static members in SQLTransformation class to set its value

isStaticConnection - boolean denoting if the connection is static. If false, connection is dynamic.

isConnectionObjectProvided - Used if isStaticConnection is false. If true, then logical connection object has to be passed in.

name - name of the transformation

prop - TransformationProperties Object to set the properties of the transformation

Returns:

An Object of OutputSet

Throws:

InvalidTransformationException

sqlTransformation

public OutputSet sqlTransformation(InputSet inputSet,
                                   java.util.Vector vTransformFields,
                                   boolean isQueryMode,
                                   int DBType,
                                   boolean isStaticConnection,
                                   boolean isConnectionObjectProvided,
                                   java.lang.String name,
                                   TransformationProperties prop)
                            throws InvalidTransformationException

Creates a SQL transformation depending on the arguments passed. The TransformProperties Object is used to set the transformation properties.

Parameters:

inputSet - The InputSet to be used by this transformation

vTransformFields - Vector of TransformField objects to be added to transformation

isQueryMode - boolean denoting if the transformation is in query mode. If false, transformation is in script mode

DBType - Database type of connection. Use the static members in SQLTransformation class to set its value

isStaticConnection - boolean denoting if the connection is static. If false, connection is dynamic.

isConnectionObjectProvided - Used if isStaticConnection is false. If true, then logical connection object has to be passed in.

name - name of the transformation

prop - TransformationProperties Object to set the properties of the transformation

Returns:

An Object of OutputSet

Throws:

InvalidTransformationException

sqlTransformation

public OutputSet sqlTransformation(RowSet inputRowSet,
                                   java.util.Vector vTransformFields,
                                   boolean isQueryMode,
                                   int DBType,
                                   boolean isStaticConnection,
                                   boolean isConnectionObjectProvided,
                                   java.lang.String name,
                                   TransformationProperties prop)
                            throws InvalidTransformationException

Creates a SQL transformation depending on the arguments passed. The TransformProperties Object is used to set the transformation properties. A InputSet is built on the rowset passed using the default propagation and linking context.

Parameters:

inputRowSet - RowSet object to be used by the transformation.

vTransformFields - Vector of TransformField objects to be added to transformation

isQueryMode - boolean denoting if the transformation is in query mode. If false, transformation is in script mode

DBType - Database type of connection. Use the static members in SQLTransformation class to set its value

isStaticConnection - boolean denoting if the connection is static. If false, connection is dynamic.

isConnectionObjectProvided - Used if isStaticConnection is false. If true, then logical connection object has to be passed in.

name - name of the transformation

prop - TransformationProperties Object to set the properties of the transformation

Returns:

An Object of OutputSet

Throws:

InvalidTransformationException

ifExist

public static boolean ifExist(java.util.Vector transformField,
                              java.lang.String fieldName)

This method checks if the field given by fieldname exists in the vector of TransformationField.

Parameters:

transformField - vector of TransformationField

fieldName - Name of the Field

Returns:

boolean

inputTransform

public OutputSet inputTransform(RowSet rowSetObj,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the input transformation using an expression on a RowSet

Parameters:

rowSetObj - RowSet object

name - transformation name

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

inputTransform

public OutputSet inputTransform(InputSet inputSetObj,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the input transformation using an expression on a InputSet

Parameters:

inputSetObj - RowSet object

name - transformation name

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

inputTransform

public OutputSet inputTransform(java.util.Vector inputSets,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the input transformation using an expression on a collection of InputSets

Parameters:

inputSets - collection of InputSet's

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

inputTransform

public OutputSet inputTransform(java.util.Vector inputSets,
                                TransformationProperties properties,
                                java.lang.String name)
                         throws InvalidTransformationException

Apply the input transformation using an expression on a collection of InputSets and properties

Parameters:

inputSets - collection of InputSet's

properties - TransformationProperties object

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

outputTransform

public OutputSet outputTransform(RowSet rowSetObj,
                                 java.lang.String name)
                          throws InvalidTransformationException

Apply the output transformation using an expression on a RowSet

Parameters:

rowSetObj - RowSet object

name - transformation name

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

outputTransform

public OutputSet outputTransform(InputSet inputSetObj,
                                 java.lang.String name)
                          throws InvalidTransformationException

Apply the output transformation using an expression on a InputSet

Parameters:

inputSetObj - RowSet object

name - transformation name

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

RowSet, InvalidTransformationException

outputTransform

public OutputSet outputTransform(java.util.Vector inputSets,
                                 java.lang.String name)
                          throws InvalidTransformationException

Apply the output transformation using an expression on a collection of InputSets

Parameters:

inputSets - collection of InputSet's

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

outputTransform

public OutputSet outputTransform(java.util.Vector inputSets,
                                 TransformationProperties properties,
                                 java.lang.String name)
                          throws InvalidTransformationException

Apply the output transformation using an expression on a collection of InputSets and properties

Parameters:

inputSets - collection of InputSet's

properties - TransformationProperties object

name - name of transformation

Returns:

RowSet object

Throws:

InvalidTransformationException

See Also:

InputSet, InvalidTransformationException

mapplet

public OutputSet mapplet(Mapplet mapplet,
                         java.util.Vector vInputSets,
                         java.lang.String instName)
                  throws java.lang.Exception

Use the mapplet either as a Transformation or Source. The mapplet parameters should be supplied as a Vector of InputSet. If the mapplet is to be used as a Source, then an empty vector of inputset should be passed. For Transformation, both vctor of inputset should be specified. while passsing arguments, user should keep in mind that fields name of inputsets vector should be same as fields name in input transformation of mapplet

Parameters:

mapplet -

vInputSets -

transformationType -

Returns:

OutputSet object

Throws:

java.lang.Exception

mapplet

public OutputSet mapplet(java.util.Vector vGroupSets,
                         java.lang.String name,
                         java.lang.String instName)
                  throws java.lang.Exception

Parameters:

vGroupSets -

name -

instName -

Returns:

Throws:

java.lang.Exception

normalizer

public OutputSet normalizer(java.util.Vector vRecords,
                            java.util.Vector vFields,
                            RowSet rowset,
                            java.lang.String name,
                            java.lang.String instName)
                     throws InvalidTransformationException

Create a Normalizer transformation. The ports will be linked by position.

Parameters:

vRecords -

vFields -

rowset -

name -

instName -

Returns:

Throws:

InvalidTransformationException

normalizer

public OutputSet normalizer(java.util.Vector vRecords,
                            java.util.Vector vFields,
                            RowSet rowset,
                            PortLinkContext linkStrategy,
                            java.lang.String name,
                            java.lang.String instName)
                     throws InvalidTransformationException

Create a Normalizer transformation. The ports will be linked based on the PortLinkContext passed

Parameters:

vRecords: - a vector of normalizer records

vFields: - a vector of normalizer fields

rowset -

linkStrategy -

name -

instName -

Returns:

Throws:

InvalidTransformationException

sourceQualifier

public OutputSet sourceQualifier(ShortCut shortCutObject)
                          throws InvalidTransformationException

create a source qualifier from a shortcut of source object

Parameters:

shortCutObject -

Returns:

Throws:

InvalidTransformationException