org.pentaho.di.job.entries.simpleeval
Class JobEntrySimpleEval

java.lang.Object
  extended by org.pentaho.di.job.entry.JobEntryBase
      extended by org.pentaho.di.job.entries.simpleeval.JobEntrySimpleEval
All Implemented Interfaces:
Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntrySimpleEval
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'simple evaluation' job entry.

Since:
01-01-2009
Author:
Samatar Hassan

Field Summary
static int FIELD_TYPE_BOOLEAN
           
static int FIELD_TYPE_DATE_TIME
           
static int FIELD_TYPE_NUMBER
           
static int FIELD_TYPE_STRING
           
 int fieldtype
           
static String[] fieldTypeCode
           
static String[] fieldTypeDesc
           
static int SUCCESS_BOOLEAN_CONDITION_FALSE
           
static int SUCCESS_BOOLEAN_CONDITION_TRUE
           
static int SUCCESS_CONDITION_CONTAINS
           
static int SUCCESS_CONDITION_DIFFERENT
           
static int SUCCESS_CONDITION_END_WITH
           
static int SUCCESS_CONDITION_EQUAL
           
static int SUCCESS_CONDITION_IN_LIST
           
static int SUCCESS_CONDITION_NOT_CONTAINS
           
static int SUCCESS_CONDITION_NOT_END_WITH
           
static int SUCCESS_CONDITION_NOT_IN_LIST
           
static int SUCCESS_CONDITION_NOT_START_WITH
           
static int SUCCESS_CONDITION_REGEX
           
static int SUCCESS_CONDITION_START_WITH
           
static int SUCCESS_NUMBER_CONDITION_BETWEEN
           
static int SUCCESS_NUMBER_CONDITION_DIFFERENT
           
static int SUCCESS_NUMBER_CONDITION_EQUAL
           
static int SUCCESS_NUMBER_CONDITION_GREATER
           
static int SUCCESS_NUMBER_CONDITION_GREATER_EQUAL
           
static int SUCCESS_NUMBER_CONDITION_IN_LIST
           
static int SUCCESS_NUMBER_CONDITION_NOT_IN_LIST
           
static int SUCCESS_NUMBER_CONDITION_SMALLER
           
static int SUCCESS_NUMBER_CONDITION_SMALLER_EQUAL
           
 int successbooleancondition
           
static String[] successBooleanConditionCode
           
static String[] successBooleanConditionDesc
           
 int successcondition
           
static String[] successConditionCode
           
static String[] successConditionDesc
           
 int successnumbercondition
           
static String[] successNumberConditionCode
           
static String[] successNumberConditionDesc
           
static int VALUE_TYPE_FIELD
           
static int VALUE_TYPE_VARIABLE
           
 int valuetype
           
static String[] valueTypeCode
           
static String[] valueTypeDesc
           
 
Constructor Summary
JobEntrySimpleEval()
           
JobEntrySimpleEval(String n)
           
 
Method Summary
 Object clone()
          This method is called when a job entry is duplicated in Spoon.
 boolean evaluates()
          This method must return true if the job entry supports the true/false outgoing hops.
 Result execute(Result previousResult, int nr)
          Execute the job entry.
 String getCompareValue()
           
 String getFieldName()
           
static int getFieldTypeByDesc(String tt)
           
static String getFieldTypeDesc(int i)
           
 String getMask()
           
 String getMaxValue()
           
 String getMinValue()
           
static int getSuccessBooleanConditionByDesc(String tt)
           
static String getSuccessBooleanConditionDesc(int i)
           
static int getSuccessConditionByDesc(String tt)
           
static String getSuccessConditionDesc(int i)
           
static int getSuccessNumberConditionByCode(String tt)
           
static int getSuccessNumberConditionByDesc(String tt)
           
static String getSuccessNumberConditionCode(int i)
           
static String getSuccessNumberConditionDesc(int i)
           
static int getValueTypeByDesc(String tt)
           
static String getValueTypeDesc(int i)
           
 String getVariableName()
           
 String getXML()
          This method is called by PDI whenever a job entry needs to serialize its settings to XML.
 boolean isSuccessWhenVarSet()
           
 void loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)
          This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
 void loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
          This method is called by PDI whenever a job entry needs to read its settings from XML.
 void saveRep(Repository rep, ObjectId id_job)
          This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
 void setCompareValue(String comparevalue)
           
 void setFieldName(String fieldname)
           
 void setMask(String mask)
           
 void setMaxValue(String maxvalue)
           
 void setMinValue(String minvalue)
           
 void setSuccessWhenVarSet(boolean successwhenvarset)
           
 void setVariableName(String variablename)
           
 
Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getRegistrationDate, getRepository, getRepositoryDirectory, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setContainerObjectId, setDescription, setID, setLogLevel, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
check, clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, isUnconditional, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository
 

Field Detail

valueTypeDesc

public static final String[] valueTypeDesc

valueTypeCode

public static final String[] valueTypeCode

VALUE_TYPE_FIELD

public static final int VALUE_TYPE_FIELD
See Also:
Constant Field Values

VALUE_TYPE_VARIABLE

public static final int VALUE_TYPE_VARIABLE
See Also:
Constant Field Values

valuetype

public int valuetype

successConditionDesc

public static final String[] successConditionDesc

successConditionCode

public static final String[] successConditionCode

SUCCESS_CONDITION_EQUAL

public static final int SUCCESS_CONDITION_EQUAL
See Also:
Constant Field Values

SUCCESS_CONDITION_DIFFERENT

public static final int SUCCESS_CONDITION_DIFFERENT
See Also:
Constant Field Values

SUCCESS_CONDITION_CONTAINS

public static final int SUCCESS_CONDITION_CONTAINS
See Also:
Constant Field Values

SUCCESS_CONDITION_NOT_CONTAINS

public static final int SUCCESS_CONDITION_NOT_CONTAINS
See Also:
Constant Field Values

SUCCESS_CONDITION_START_WITH

public static final int SUCCESS_CONDITION_START_WITH
See Also:
Constant Field Values

SUCCESS_CONDITION_NOT_START_WITH

public static final int SUCCESS_CONDITION_NOT_START_WITH
See Also:
Constant Field Values

SUCCESS_CONDITION_END_WITH

public static final int SUCCESS_CONDITION_END_WITH
See Also:
Constant Field Values

SUCCESS_CONDITION_NOT_END_WITH

public static final int SUCCESS_CONDITION_NOT_END_WITH
See Also:
Constant Field Values

SUCCESS_CONDITION_REGEX

public static final int SUCCESS_CONDITION_REGEX
See Also:
Constant Field Values

SUCCESS_CONDITION_IN_LIST

public static final int SUCCESS_CONDITION_IN_LIST
See Also:
Constant Field Values

SUCCESS_CONDITION_NOT_IN_LIST

public static final int SUCCESS_CONDITION_NOT_IN_LIST
See Also:
Constant Field Values

successcondition

public int successcondition

fieldTypeDesc

public static final String[] fieldTypeDesc

fieldTypeCode

public static final String[] fieldTypeCode

FIELD_TYPE_STRING

public static final int FIELD_TYPE_STRING
See Also:
Constant Field Values

FIELD_TYPE_NUMBER

public static final int FIELD_TYPE_NUMBER
See Also:
Constant Field Values

FIELD_TYPE_DATE_TIME

public static final int FIELD_TYPE_DATE_TIME
See Also:
Constant Field Values

FIELD_TYPE_BOOLEAN

public static final int FIELD_TYPE_BOOLEAN
See Also:
Constant Field Values

fieldtype

public int fieldtype

successNumberConditionDesc

public static final String[] successNumberConditionDesc

successNumberConditionCode

public static final String[] successNumberConditionCode

SUCCESS_NUMBER_CONDITION_EQUAL

public static final int SUCCESS_NUMBER_CONDITION_EQUAL
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_DIFFERENT

public static final int SUCCESS_NUMBER_CONDITION_DIFFERENT
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_SMALLER

public static final int SUCCESS_NUMBER_CONDITION_SMALLER
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_SMALLER_EQUAL

public static final int SUCCESS_NUMBER_CONDITION_SMALLER_EQUAL
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_GREATER

public static final int SUCCESS_NUMBER_CONDITION_GREATER
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_GREATER_EQUAL

public static final int SUCCESS_NUMBER_CONDITION_GREATER_EQUAL
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_BETWEEN

public static final int SUCCESS_NUMBER_CONDITION_BETWEEN
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_IN_LIST

public static final int SUCCESS_NUMBER_CONDITION_IN_LIST
See Also:
Constant Field Values

SUCCESS_NUMBER_CONDITION_NOT_IN_LIST

public static final int SUCCESS_NUMBER_CONDITION_NOT_IN_LIST
See Also:
Constant Field Values

successnumbercondition

public int successnumbercondition

successBooleanConditionDesc

public static final String[] successBooleanConditionDesc

successBooleanConditionCode

public static final String[] successBooleanConditionCode

SUCCESS_BOOLEAN_CONDITION_TRUE

public static final int SUCCESS_BOOLEAN_CONDITION_TRUE
See Also:
Constant Field Values

SUCCESS_BOOLEAN_CONDITION_FALSE

public static final int SUCCESS_BOOLEAN_CONDITION_FALSE
See Also:
Constant Field Values

successbooleancondition

public int successbooleancondition
Constructor Detail

JobEntrySimpleEval

public JobEntrySimpleEval(String n)

JobEntrySimpleEval

public JobEntrySimpleEval()
Method Detail

clone

public Object clone()
Description copied from class: JobEntryBase
This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.

Specified by:
clone in interface JobEntryInterface
Overrides:
clone in class JobEntryBase
Returns:
a clone of the object

getSuccessNumberConditionCode

public static String getSuccessNumberConditionCode(int i)

getXML

public String getXML()
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.

Specified by:
getXML in interface JobEntryInterface
Overrides:
getXML in class JobEntryBase
Returns:
the xml representation of the job entry

setSuccessWhenVarSet

public void setSuccessWhenVarSet(boolean successwhenvarset)

isSuccessWhenVarSet

public boolean isSuccessWhenVarSet()

getSuccessNumberConditionByCode

public static int getSuccessNumberConditionByCode(String tt)

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException
Description copied from interface: JobEntryInterface
This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry�s settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.

Specified by:
loadXML in interface JobEntryInterface
Parameters:
entrynode - the top-level XML node
databases - the list of databases
slaveServers - the list of slave servers
rep - the repository object
Throws:
KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. For JobEntryBase, this method performs no operations.

Specified by:
loadRep in interface JobEntryInterface
Overrides:
loadRep in class JobEntryBase
Parameters:
rep - the repository object
id_jobentry - the id of the job entry
databases - the list of databases
slaveServers - the list of slave servers
Throws:
KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. For JobEntryBase, this method performs no operations

Specified by:
saveRep in interface JobEntryInterface
Overrides:
saveRep in class JobEntryBase
Parameters:
rep - the repository object
id_job - the id_job
Throws:
KettleException - if any errors occur during the save

execute

public Result execute(Result previousResult,
                      int nr)
               throws KettleException
Description copied from interface: JobEntryInterface
Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.

Specified by:
execute in interface JobEntryInterface
Parameters:
previousResult - the previous result
nr - the number of rows
Returns:
the Result object from execution of this job entry
Throws:
KettleException - if any Kettle exceptions occur

getValueTypeDesc

public static String getValueTypeDesc(int i)

getFieldTypeDesc

public static String getFieldTypeDesc(int i)

getSuccessConditionDesc

public static String getSuccessConditionDesc(int i)

getSuccessNumberConditionDesc

public static String getSuccessNumberConditionDesc(int i)

getSuccessBooleanConditionDesc

public static String getSuccessBooleanConditionDesc(int i)

getValueTypeByDesc

public static int getValueTypeByDesc(String tt)

getFieldTypeByDesc

public static int getFieldTypeByDesc(String tt)

getSuccessConditionByDesc

public static int getSuccessConditionByDesc(String tt)

getSuccessNumberConditionByDesc

public static int getSuccessNumberConditionByDesc(String tt)

getSuccessBooleanConditionByDesc

public static int getSuccessBooleanConditionByDesc(String tt)

setMinValue

public void setMinValue(String minvalue)

getMinValue

public String getMinValue()

setCompareValue

public void setCompareValue(String comparevalue)

getMask

public String getMask()

setMask

public void setMask(String mask)

getFieldName

public String getFieldName()

setFieldName

public void setFieldName(String fieldname)

getVariableName

public String getVariableName()

setVariableName

public void setVariableName(String variablename)

getCompareValue

public String getCompareValue()

setMaxValue

public void setMaxValue(String maxvalue)

getMaxValue

public String getMaxValue()

evaluates

public boolean evaluates()
Description copied from class: JobEntryBase
This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:
evaluates in interface JobEntryInterface
Overrides:
evaluates in class JobEntryBase
Returns:
false