org.pentaho.di.trans.steps.mergerows
Class MergeRowsMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.mergerows.MergeRowsMeta
All Implemented Interfaces:
Cloneable, StepMetaInterface

public class MergeRowsMeta
extends BaseStepMeta
implements StepMetaInterface


Constructor Summary
MergeRowsMeta()
           
 
Method Summary
 void allocate(int nrKeys, int nrValues)
           
 void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info)
          Checks the settings of this step and puts the findings in a remarks List.
 boolean chosesTargetSteps()
           
 Object clone()
          Make an exact copy of this step, make sure to explicitly copy Collections etc.
 StepMeta getCompareStepMeta()
           
 String getCompareStepName()
           
 void getFields(org.pentaho.di.core.row.RowMetaInterface r, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space)
          Get the fields that are emitted by this step
 String getFlagField()
           
 String[] getInfoSteps()
           
 String[] getKeyFields()
           
 StepMeta getReferenceStepMeta()
           
 String getReferenceStepName()
           
 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[] getTargetSteps()
           
 String[] getValueFields()
           
 String getXML()
          Produces the XML string that describes this step's information.
 void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters)
          Load the values for this step from an XML Node
 void readRep(Repository rep, long id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases, Map<String,org.pentaho.di.core.Counter> counters)
          Read the steps information from a Kettle repository
 void saveRep(Repository rep, long id_transformation, long id_step)
          Save the steps data into a Kettle repository
 void searchInfoAndTargetSteps(List<StepMeta> steps)
           
 void setCompareStepMeta(StepMeta sendFalseStep)
           
 void setCompareStepName(String sendFalseStepname)
           
 void setDefault()
          Set default values
 void setFlagField(String flagField)
           
 void setInfoSteps(StepMeta[] infoSteps)
           
 void setKeyFields(String[] keyFields)
           
 void setReferenceStepMeta(StepMeta sendTrueStep)
           
 void setReferenceStepName(String sendTrueStepname)
           
 void setValueFields(String[] valueFields)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getID, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, hasChanged, setChanged, setChanged, setID, setTargetSteps, 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, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, setTargetSteps, supportsErrorHandling
 

Constructor Detail

MergeRowsMeta

public MergeRowsMeta()
Method Detail

getKeyFields

public String[] getKeyFields()
Returns:
Returns the keyFields.

setKeyFields

public void setKeyFields(String[] keyFields)
Parameters:
keyFields - The keyFields to set.

getValueFields

public String[] getValueFields()
Returns:
Returns the valueFields.

setValueFields

public void setValueFields(String[] valueFields)
Parameters:
valueFields - The valueFields to set.

loadXML

public void loadXML(Node stepnode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    Map<String,org.pentaho.di.core.Counter> counters)
             throws org.pentaho.di.core.exception.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:
org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

getCompareStepName

public String getCompareStepName()
Returns:
Returns the sendFalseStepname.

getReferenceStepName

public String getReferenceStepName()
Returns:
Returns the sendTrueStepname.

setCompareStepName

public void setCompareStepName(String sendFalseStepname)
Parameters:
sendFalseStepname - The sendFalseStepname to set.

setReferenceStepName

public void setReferenceStepName(String sendTrueStepname)
Parameters:
sendTrueStepname - The sendTrueStepname to set.

getCompareStepMeta

public StepMeta getCompareStepMeta()
Returns:
Returns the sendFalseStep.

getReferenceStepMeta

public StepMeta getReferenceStepMeta()
Returns:
Returns the sendTrueStep.

setCompareStepMeta

public void setCompareStepMeta(StepMeta sendFalseStep)
Parameters:
sendFalseStep - The sendFalseStep to set.

setReferenceStepMeta

public void setReferenceStepMeta(StepMeta sendTrueStep)
Parameters:
sendTrueStep - The sendTrueStep to set.

getFlagField

public String getFlagField()
Returns:
Returns the flagField.

setFlagField

public void setFlagField(String flagField)
Parameters:
flagField - The flagField to set.

allocate

public void allocate(int nrKeys,
                     int nrValues)

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

getInfoSteps

public String[] getInfoSteps()
Specified by:
getInfoSteps in interface StepMetaInterface
Overrides:
getInfoSteps in class BaseStepMeta
Returns:
the informational source steps, if any. Null is the default: none.

setInfoSteps

public void setInfoSteps(StepMeta[] infoSteps)
Specified by:
setInfoSteps in interface StepMetaInterface
Overrides:
setInfoSteps in class BaseStepMeta
Parameters:
infoSteps - The info-step(s) to set

readRep

public void readRep(Repository rep,
                    long id_step,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    Map<String,org.pentaho.di.core.Counter> counters)
             throws org.pentaho.di.core.exception.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:
org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    long id_transformation,
                    long id_step)
             throws org.pentaho.di.core.exception.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:
org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

searchInfoAndTargetSteps

public void searchInfoAndTargetSteps(List<StepMeta> steps)
Specified by:
searchInfoAndTargetSteps in interface StepMetaInterface
Overrides:
searchInfoAndTargetSteps in class BaseStepMeta
Parameters:
steps - optionally search the info step in a list of steps

chosesTargetSteps

public boolean chosesTargetSteps()
Overrides:
chosesTargetSteps in class BaseStepMeta

getTargetSteps

public String[] getTargetSteps()
Specified by:
getTargetSteps in interface StepMetaInterface
Overrides:
getTargetSteps in class BaseStepMeta
Returns:
the chosen target steps, if any. Null is the default: automatically chosen target steps.

getFields

public void getFields(org.pentaho.di.core.row.RowMetaInterface r,
                      String name,
                      org.pentaho.di.core.row.RowMetaInterface[] info,
                      StepMeta nextStep,
                      org.pentaho.di.core.variables.VariableSpace space)
               throws org.pentaho.di.core.exception.KettleStepException
Description copied from interface: StepMetaInterface
Get the fields that are emitted by this step

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
r - The fields that are entering the step. These are changed to reflect the output metadata.
name - The name of the step to be used as origin
info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]
nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.
space - TODO
Throws:
org.pentaho.di.core.exception.KettleStepException - when an error occurred searching for the fields.

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepinfo,
                  org.pentaho.di.core.row.RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  org.pentaho.di.core.row.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

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.