org.pentaho.di.trans.steps.validator
Class ValidatorMeta

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

public class ValidatorMeta
extends BaseStepMeta
implements StepMetaInterface

Contains the meta-data for the Validator step: calculates predefined formula's Created on 08-sep-2005


Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
ValidatorMeta()
           
 
Method Summary
 void allocate(int nrValidations)
           
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, 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 equals(Object obj)
           
 boolean excludeFromRowLayoutVerification()
          This method is added to exclude certain steps from layout checking.
 String getConcatenationSeparator()
           
 List<StreamInterface> getOptionalStreams()
           
 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.
 StepIOMetaInterface getStepIOMeta()
          Returns the Input/Output metadata for this step.
 List<Validation> getValidations()
           
 String getXML()
          Produces the XML string that describes this step's information.
 void handleStreamSelection(StreamInterface stream)
          When an optional stream is selected, this method is called to handled the ETL metadata implications of that.
 boolean isConcatenatingErrors()
           
 boolean isValidatingAll()
           
 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 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 setConcatenatingErrors(boolean concatenatingErrors)
           
 void setConcatenationSeparator(String concatenationSeparator)
           
 void setDefault()
          Set default values
 void setValidatingAll(boolean validatingAll)
           
 void setValidations(List<Validation> validations)
           
 boolean supportsErrorHandling()
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, setChanged, setChanged, setParentStepMeta
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, exportResources, getDialogClassName, getFields, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, setParentStepMeta
 

Constructor Detail

ValidatorMeta

public ValidatorMeta()
Method Detail

allocate

public void allocate(int nrValidations)

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

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.

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

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

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)

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 stepMeta,
                  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
stepMeta - 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.

supportsErrorHandling

public boolean supportsErrorHandling()
Specified by:
supportsErrorHandling in interface StepMetaInterface
Overrides:
supportsErrorHandling in class BaseStepMeta
Returns:
true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.

getValidations

public List<Validation> getValidations()
Returns:
the validations

setValidations

public void setValidations(List<Validation> validations)
Parameters:
validations - the validations 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

isValidatingAll

public boolean isValidatingAll()
Returns:
the validatingAll

setValidatingAll

public void setValidatingAll(boolean validatingAll)
Parameters:
validatingAll - the validatingAll to set

isConcatenatingErrors

public boolean isConcatenatingErrors()
Returns:
the concatenatingErrors

setConcatenatingErrors

public void setConcatenatingErrors(boolean concatenatingErrors)
Parameters:
concatenatingErrors - the concatenatingErrors to set

getConcatenationSeparator

public String getConcatenationSeparator()
Returns:
the concatenationSeparator

setConcatenationSeparator

public void setConcatenationSeparator(String concatenationSeparator)
Parameters:
concatenationSeparator - the concatenationSeparator to set

getStepIOMeta

public StepIOMetaInterface getStepIOMeta()
Returns the Input/Output metadata for this step.

Specified by:
getStepIOMeta in interface StepMetaInterface
Overrides:
getStepIOMeta in class BaseStepMeta

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

getOptionalStreams

public List<StreamInterface> getOptionalStreams()
Specified by:
getOptionalStreams in interface StepMetaInterface
Overrides:
getOptionalStreams in class BaseStepMeta
Returns:
The list of optional input streams. It allows the user to select from a list of possible actions like "New target step"

handleStreamSelection

public void handleStreamSelection(StreamInterface stream)
Description copied from class: BaseStepMeta
When an optional stream is selected, this method is called to handled the ETL metadata implications of that.

Specified by:
handleStreamSelection in interface StepMetaInterface
Overrides:
handleStreamSelection in class BaseStepMeta
Parameters:
stream - The optional stream to handle.