org.pentaho.di.trans.steps.multimerge
Class MultiMergeJoinMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.multimerge.MultiMergeJoinMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class MultiMergeJoinMeta
extends BaseStepMeta
implements StepMetaInterface

Since:

24-nov-2006

Author:

Biswapesh

Field Summary

static String[]	join_types
static boolean[]	optionals

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

MultiMergeJoinMeta()

Method Summary

void	allocateInputSteps(int count)
void	allocateKeys(int nrKeys)
void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info) Checks the settings of this step and puts the findings in a remarks List.
Object	clone() Make an exact copy of this step, make sure to explicitly copy Collections etc.
boolean	excludeFromRowLayoutVerification() This method is added to exclude certain steps from layout checking.
void	getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Gets the fields.
String[]	getInputSteps()
String	getJoinType() The supported join types are INNER, LEFT OUTER, RIGHT OUTER and FULL OUTER
String[]	getKeyFields()
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans) Get the executing step, needed by Trans to launch a step.
StepDataInterface	getStepData() Get a new instance of the appropriate data class.
String	getXML() Produces the XML string that describes this step's information.
void	loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) Load the values for this step from an XML Node
void	readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) Read the steps information from a Kettle repository
void	resetStepIoMeta() Reset step io meta.
void	saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
void	searchInfoAndTargetSteps(List<StepMeta> steps) Change step names into step objects to allow them to be name-changed etc.
void	setDefault() Set default values
void	setInputSteps(String[] inputSteps)
void	setJoinType(String joinType) Sets the type of join
void	setKeyFields(String[] keyFields)

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, setChanged, setChanged, setParentStepMeta, supportsErrorHandling

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, setParentStepMeta, supportsErrorHandling

Field Detail

join_types

public static final String[] join_types

optionals

public static final boolean[] optionals

Constructor Detail

MultiMergeJoinMeta

public MultiMergeJoinMeta()

Method Detail

getJoinType

public String getJoinType()

The supported join types are INNER, LEFT OUTER, RIGHT OUTER and FULL OUTER

Returns:

The type of join

setJoinType

public void setJoinType(String joinType)

Sets the type of join

Parameters:

joinType - The type of join, e.g. INNER/FULL OUTER

getKeyFields

public String[] getKeyFields()

Returns:

Returns the keyFields1.

setKeyFields

public void setKeyFields(String[] keyFields)

Parameters:

keyFields1 - The keyFields1 to set.

excludeFromRowLayoutVerification

public boolean excludeFromRowLayoutVerification()

Description copied from class: BaseStepMeta

This method is added to exclude certain steps from layout checking.

Specified by:

excludeFromRowLayoutVerification in interface StepMetaInterface

Overrides:

excludeFromRowLayoutVerification in class BaseStepMeta

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

counters - Counters to reference.

Throws:

KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocateKeys

public void allocateKeys(int nrKeys)

clone

public Object clone()

Description copied from interface: StepMetaInterface

Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:

clone in interface StepMetaInterface

Overrides:

clone in class BaseStepMeta

Returns:

an exact copy of this step

getXML

public String getXML()

Description copied from class: BaseStepMeta

Produces the XML string that describes this step's information.

Specified by:

getXML in interface StepMetaInterface

Overrides:

getXML in class BaseStepMeta

Returns:

String containing the XML describing this step.

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Parameters:

rep - The repository to read from

id_step - The step ID

databases - The databases to reference

counters - The counters to reference

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

searchInfoAndTargetSteps

public void searchInfoAndTargetSteps(List<StepMeta> steps)

Description copied from class: BaseStepMeta

Change step names into step objects to allow them to be name-changed etc.

Specified by:

searchInfoAndTargetSteps in interface StepMetaInterface

Overrides:

searchInfoAndTargetSteps in class BaseStepMeta

Parameters:

steps - the steps to reference

saveRep

public void saveRep(Repository rep,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException

Description copied from interface: StepMetaInterface

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Parameters:

rep - The Kettle repository to save to

id_transformation - The transformation ID

id_step - The step ID

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepinfo,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)

Description copied from interface: StepMetaInterface

Checks the settings of this step and puts the findings in a remarks List.

Specified by:

check in interface StepMetaInterface

Parameters:

remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult

stepinfo - The stepMeta to help checking

prev - The fields coming from the previous step

input - The input step names

output - The output step names

info - The fields that are used as information by the step

getFields

public void getFields(RowMetaInterface r,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

r - the input row meta

name - the name

info - the info

nextStep - the next step

space - the space

Throws:

KettleStepException - the kettle step exception

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta tr,
                             Trans trans)

Description copied from interface: StepMetaInterface

Get the executing step, needed by Trans to launch a step.

Specified by:

getStep in interface StepMetaInterface

Parameters:

stepMeta - The step info

stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.

cnr - The copy nr to get

tr - The transformation info

trans - The launching transformation

getStepData

public StepDataInterface getStepData()

Description copied from interface: StepMetaInterface

Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:

getStepData in interface StepMetaInterface

Returns:

The appropriate StepDataInterface class.

resetStepIoMeta

public void resetStepIoMeta()

Description copied from class: BaseStepMeta

Reset step io meta.

Specified by:

resetStepIoMeta in interface StepMetaInterface

Overrides:

resetStepIoMeta in class BaseStepMeta

setInputSteps

public void setInputSteps(String[] inputSteps)

getInputSteps

public String[] getInputSteps()

allocateInputSteps

public void allocateInputSteps(int count)