org.pentaho.di.job.entries.evalfilesmetrics
Class JobEntryEvalFilesMetrics

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

public class JobEntryEvalFilesMetrics
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'evaluate files metrics' job entry.

Since:
26-02-2010
Author:
Samatar Hassan

Field Summary
 boolean arg_from_previous
           
static int EVALUATE_TYPE_COUNT
           
static int EVALUATE_TYPE_SIZE
           
 int evaluationType
           
static String[] EvaluationTypeCodes
           
static String[] EvaluationTypeDesc
           
 String[] includeSubFolders
           
static String[] IncludeSubFoldersCodes
           
static String[] IncludeSubFoldersDesc
           
static BigDecimal ONE
           
 int scale
           
static int SCALE_BYTES
           
static int SCALE_GBYTES
           
static int SCALE_KBYTES
           
static int SCALE_MBYTES
           
static String[] scaleCodes
           
static String[] scaleDesc
           
 String[] source_filefolder
           
static int SOURCE_FILES_FILENAMES_RESULT
           
static int SOURCE_FILES_FILES
           
static int SOURCE_FILES_PREVIOUS_RESULT
           
 int sourceFiles
           
static String[] SourceFilesCodes
           
static String[] SourceFilesDesc
           
 int successnumbercondition
           
 String[] wildcard
           
 
Constructor Summary
JobEntryEvalFilesMetrics()
           
JobEntryEvalFilesMetrics(String n)
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, JobMeta jobMeta)
          Support for overrides not having to put in a check method.
 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()
           
static int getEvaluationTypeByDesc(String tt)
           
static String getEvaluationTypeCode(int i)
           
static String getEvaluationTypeDesc(int i)
           
static String getIncludeSubFolders(String tt)
           
static String getIncludeSubFoldersDesc(String tt)
           
 String getMaxValue()
           
 String getMinValue()
           
 String getResultFieldFile()
           
 String getResultFieldIncludeSubfolders()
           
 String getResultFieldWildcard()
           
 String getResultFilenamesWildcard()
           
 int getScale()
           
static int getScaleByDesc(String tt)
           
static String getScaleCode(int i)
           
static String getScaleDesc(int i)
           
 int getSourceFiles()
           
static int getSourceFilesByDesc(String tt)
           
static String getSourceFilesCode(int i)
           
static String getSourceFilesDesc(int i)
           
 String getXML()
          This method is called by PDI whenever a job entry needs to serialize its settings to XML.
 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 setMaxValue(String maxvalue)
           
 void setMinValue(String minvalue)
           
 void setResultFieldFile(String field)
           
 void setResultFieldIncludeSubfolders(String field)
           
 void setResultFieldWildcard(String field)
           
 void setResultFilenamesWildcard(String resultwildcard)
           
 
Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
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
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

ONE

public static final BigDecimal ONE

IncludeSubFoldersDesc

public static final String[] IncludeSubFoldersDesc

IncludeSubFoldersCodes

public static final String[] IncludeSubFoldersCodes

scaleDesc

public static final String[] scaleDesc

scaleCodes

public static final String[] scaleCodes

SCALE_BYTES

public static final int SCALE_BYTES
See Also:
Constant Field Values

SCALE_KBYTES

public static final int SCALE_KBYTES
See Also:
Constant Field Values

SCALE_MBYTES

public static final int SCALE_MBYTES
See Also:
Constant Field Values

SCALE_GBYTES

public static final int SCALE_GBYTES
See Also:
Constant Field Values

scale

public int scale

SourceFilesDesc

public static final String[] SourceFilesDesc

SourceFilesCodes

public static final String[] SourceFilesCodes

SOURCE_FILES_FILES

public static final int SOURCE_FILES_FILES
See Also:
Constant Field Values

SOURCE_FILES_FILENAMES_RESULT

public static final int SOURCE_FILES_FILENAMES_RESULT
See Also:
Constant Field Values

SOURCE_FILES_PREVIOUS_RESULT

public static final int SOURCE_FILES_PREVIOUS_RESULT
See Also:
Constant Field Values

sourceFiles

public int sourceFiles

EvaluationTypeDesc

public static final String[] EvaluationTypeDesc

EvaluationTypeCodes

public static final String[] EvaluationTypeCodes

EVALUATE_TYPE_SIZE

public static final int EVALUATE_TYPE_SIZE
See Also:
Constant Field Values

EVALUATE_TYPE_COUNT

public static final int EVALUATE_TYPE_COUNT
See Also:
Constant Field Values

evaluationType

public int evaluationType

successnumbercondition

public int successnumbercondition

arg_from_previous

public boolean arg_from_previous

source_filefolder

public String[] source_filefolder

wildcard

public String[] wildcard

includeSubFolders

public String[] includeSubFolders
Constructor Detail

JobEntryEvalFilesMetrics

public JobEntryEvalFilesMetrics(String n)

JobEntryEvalFilesMetrics

public JobEntryEvalFilesMetrics()
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

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

getIncludeSubFolders

public static String getIncludeSubFolders(String tt)

getIncludeSubFoldersDesc

public static String getIncludeSubFoldersDesc(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

getSourceFiles

public int getSourceFiles()

getResultFieldFile

public String getResultFieldFile()

setResultFieldFile

public void setResultFieldFile(String field)

getResultFieldWildcard

public String getResultFieldWildcard()

setResultFieldWildcard

public void setResultFieldWildcard(String field)

getResultFieldIncludeSubfolders

public String getResultFieldIncludeSubfolders()

setResultFieldIncludeSubfolders

public void setResultFieldIncludeSubfolders(String field)

setMinValue

public void setMinValue(String minvalue)

getMinValue

public String getMinValue()

setCompareValue

public void setCompareValue(String comparevalue)

getCompareValue

public String getCompareValue()

setResultFilenamesWildcard

public void setResultFilenamesWildcard(String resultwildcard)

getResultFilenamesWildcard

public String getResultFilenamesWildcard()

setMaxValue

public void setMaxValue(String maxvalue)

getMaxValue

public String getMaxValue()

getScaleByDesc

public static int getScaleByDesc(String tt)

getSourceFilesByDesc

public static int getSourceFilesByDesc(String tt)

getEvaluationTypeByDesc

public static int getEvaluationTypeByDesc(String tt)

getScaleDesc

public static String getScaleDesc(int i)

getEvaluationTypeDesc

public static String getEvaluationTypeDesc(int i)

getSourceFilesDesc

public static String getSourceFilesDesc(int i)

getScaleCode

public static String getScaleCode(int i)

getSourceFilesCode

public static String getSourceFilesCode(int i)

getEvaluationTypeCode

public static String getEvaluationTypeCode(int i)

getScale

public int getScale()

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta)
Description copied from class: JobEntryBase
Support for overrides not having to put in a check method. For JobEntryBase, this method performs no operations.

Specified by:
check in interface JobEntryInterface
Overrides:
check in class JobEntryBase
Parameters:
remarks - CheckResults from checking the job entry
jobMeta - JobMeta information letting threading back to the JobMeta possible

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