org.pentaho.di.trans.steps.mailvalidator
Class MailValidatorMeta

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

public class MailValidatorMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
MailValidatorMeta()
           
 
Method Summary
 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.
 String getDefaultSMTP()
           
 String getDefaultSMTPField()
           
 String getEmailField()
           
 String getEMailNotValideMsg()
           
 String geteMailSender()
           
 String getEMailValideMsg()
           
 String getErrorsField()
           
 void getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Get the fields that are emitted by this step
 String getResultFieldName()
           
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, 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 getTimeOut()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isdynamicDefaultSMTP()
           
 boolean isResultAsString()
           
 boolean isSMTPCheck()
           
 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 setDefault()
          Set default values
 void setDefaultSMTP(String defaultSMTP)
           
 void setDefaultSMTPField(String defaultSMTPField)
           
 void setdynamicDefaultSMTP(boolean isdynamicDefaultSMTP)
           
 void setEmailfield(String emailfield)
           
 void setEmailNotValideMsg(String emailNotValideMsg)
           
 void seteMailSender(String emailSender)
           
 void setEmailValideMsg(String emailValideMsg)
           
 void setErrorsField(String errorsFieldName)
           
 void setResultAsString(boolean ResultAsString)
           
 void setResultFieldName(String resultfieldname)
           
 void setSMTPCheck(boolean smtpcheck)
           
 void setTimeOut(String timeout)
           
 boolean supportsErrorHandling()
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, 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, resetStepIoMeta, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta
 
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, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta
 

Constructor Detail

MailValidatorMeta

public MailValidatorMeta()
Method Detail

getEmailField

public String getEmailField()
Returns:
Returns the emailfield.

setEmailfield

public void setEmailfield(String emailfield)
Parameters:
emailfield - The emailfield to set.

getResultFieldName

public String getResultFieldName()
Returns:
Returns the resultName.

setResultFieldName

public void setResultFieldName(String resultfieldname)
Parameters:
resultfieldname - The resultfieldname to set.

setEmailValideMsg

public void setEmailValideMsg(String emailValideMsg)
Parameters:
emailValideMsg - The emailValideMsg to set.

getEMailValideMsg

public String getEMailValideMsg()
Returns:
Returns the emailValideMsg.

getEMailNotValideMsg

public String getEMailNotValideMsg()
Returns:
Returns the emailNotValideMsg.

getErrorsField

public String getErrorsField()
Returns:
Returns the errorsFieldName.

setErrorsField

public void setErrorsField(String errorsFieldName)
Parameters:
errorsFieldName - The errorsFieldName to set.

getTimeOut

public String getTimeOut()
Returns:
Returns the timeout.

setTimeOut

public void setTimeOut(String timeout)
Parameters:
timeout - The timeout to set.

getDefaultSMTP

public String getDefaultSMTP()
Returns:
Returns the defaultSMTP.

setDefaultSMTP

public void setDefaultSMTP(String defaultSMTP)
Parameters:
defaultSMTP - The defaultSMTP to set.

geteMailSender

public String geteMailSender()
Returns:
Returns the emailSender.

seteMailSender

public void seteMailSender(String emailSender)
Parameters:
emailSender - The emailSender to set.

getDefaultSMTPField

public String getDefaultSMTPField()
Returns:
Returns the defaultSMTPField.

setDefaultSMTPField

public void setDefaultSMTPField(String defaultSMTPField)
Parameters:
defaultSMTPField - The defaultSMTPField to set.

isdynamicDefaultSMTP

public boolean isdynamicDefaultSMTP()
Returns:
Returns the isdynamicDefaultSMTP.

setdynamicDefaultSMTP

public void setdynamicDefaultSMTP(boolean isdynamicDefaultSMTP)
Parameters:
isdynamicDefaultSMTP - The isdynamicDefaultSMTP to set.

setEmailNotValideMsg

public void setEmailNotValideMsg(String emailNotValideMsg)
Parameters:
emailNotValideMsg - The emailNotValideMsg to set.

isResultAsString

public boolean isResultAsString()

setResultAsString

public void setResultAsString(boolean ResultAsString)

setSMTPCheck

public void setSMTPCheck(boolean smtpcheck)

isSMTPCheck

public boolean isSMTPCheck()

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

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

getFields

public void getFields(RowMetaInterface r,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws 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:
KettleStepException - when an error occurred searching for the fields.

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.

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