org.pentaho.di.trans.steps.filterrows
Class FilterRowsMeta

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

public class FilterRowsMeta
extends BaseStepMeta
implements StepMetaInterface


Constructor Summary
FilterRowsMeta()
           
 
Method Summary
 void allocate()
           
 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.
 Condition getCondition()
           
 void getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta, String origin, 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
 StepMeta getSendFalseStep()
           
 String getSendFalseStepname()
           
 StepMeta getSendTrueStep()
           
 String getSendTrueStepname()
           
 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 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 setCondition(Condition condition)
           
 void setDefault()
          Set default values
 void setSendFalseStep(StepMeta sendFalseStep)
           
 void setSendFalseStepname(String sendFalseStepname)
           
 void setSendTrueStep(StepMeta sendTrueStep)
           
 void setSendTrueStepname(String sendTrueStepname)
           
 void setTargetSteps(StepMeta[] targetSteps)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getID, getInfoSteps, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, hasChanged, setChanged, setChanged, setID, setInfoSteps, 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, getInfoSteps, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, setInfoSteps, supportsErrorHandling
 

Constructor Detail

FilterRowsMeta

public FilterRowsMeta()
Method Detail

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.)

getCondition

public Condition getCondition()
Returns:
Returns the condition.

setCondition

public void setCondition(Condition condition)
Parameters:
condition - The condition to set.

getSendFalseStepname

public String getSendFalseStepname()
Returns:
Returns the sendFalseStepname.

getSendTrueStepname

public String getSendTrueStepname()
Returns:
Returns the sendTrueStepname.

setSendFalseStepname

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

setSendTrueStepname

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

getSendFalseStep

public StepMeta getSendFalseStep()
Returns:
Returns the sendFalseStep.

getSendTrueStep

public StepMeta getSendTrueStep()
Returns:
Returns the sendTrueStep.

setSendFalseStep

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

setSendTrueStep

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

allocate

public void allocate()

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()
              throws org.pentaho.di.core.exception.KettleException
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.
Throws:
org.pentaho.di.core.exception.KettleException - in case there is a conversion or XML encoding error

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

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
Returns:
true if this step chooses both target steps

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.

setTargetSteps

public void setTargetSteps(StepMeta[] targetSteps)
Specified by:
setTargetSteps in interface StepMetaInterface
Overrides:
setTargetSteps in class BaseStepMeta
Parameters:
targetSteps - The target step(s) to set

getFields

public void getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta,
                      String origin,
                      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:
rowMeta - The fields that are entering the step. These are changed to reflect the output metadata.
origin - 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.