Package org.pentaho.di.job.entries.evalfilesmetrics

Class JobEntryEvalFilesMetrics

  • All Implemented Interfaces:
    Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.logging.LoggingObjectLifecycleInterface, org.pentaho.di.core.variables.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 Detail

      • 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

        public int scale

      • SourceFilesDesc

        public static final String[] SourceFilesDesc

      • SourceFilesCodes

        public static final String[] SourceFilesCodes

      • 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

      • evaluationType

        public int evaluationType

      • arg_from_previous

        public boolean arg_from_previous

    • Constructor Detail

      • JobEntryEvalFilesMetrics

        public JobEntryEvalFilesMetrics​(String n)

      • JobEntryEvalFilesMetrics

        public JobEntryEvalFilesMetrics()

    • Method Detail

      • allocate

        public void allocate​(int nrFields)

      • 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<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.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
        Overrides:
        loadXML in class JobEntryBase
        Parameters:
        entrynode - the top-level XML node
        databases - the list of databases
        slaveServers - the list of slave servers
        rep - the repository object
        metaStore - The metaStore to optionally load from.
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

      • loadRep

        public void loadRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.
        Specified by:
        loadRep in interface JobEntryInterface
        Overrides:
        loadRep in class JobEntryBase
        Parameters:
        rep - the repository object
        metaStore - the MetaStore to use
        id_jobentry - the id of the job entry
        databases - the list of databases
        slaveServers - the list of slave servers
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the load

      • saveRep

        public void saveRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: JobEntryInterface
        This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.
        Specified by:
        saveRep in interface JobEntryInterface
        Overrides:
        saveRep in class JobEntryBase
        Parameters:
        rep - the repository
        metaStore - the MetaStore to use
        id_job - the id_job
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the save

      • execute

        public org.pentaho.di.core.Result execute​(org.pentaho.di.core.Result previousResult,
                                          int nr)
                                   throws org.pentaho.di.core.exception.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:
        org.pentaho.di.core.exception.KettleException - if any Kettle exceptions occur

      • getSuccessConditionType

        public int getSuccessConditionType()

      • setSuccessConditionType

        public void setSuccessConditionType​(int successConditionType)

      • getSourceFiles

        public int getSourceFiles()

      • getSourceFileFolder

        public String[] getSourceFileFolder()

      • setSourceFileFolder

        public void setSourceFileFolder​(String[] sourceFileFolder)

      • getSourceWildcard

        public String[] getSourceWildcard()

      • setSourceWildcard

        public void setSourceWildcard​(String[] sourceWildcard)

      • getSourceIncludeSubfolders

        public String[] getSourceIncludeSubfolders()

      • setSourceIncludeSubfolders

        public void setSourceIncludeSubfolders​(String[] sourceIncludeSubfolders)

      • setSourceFiles

        public void setSourceFiles​(int sourceFiles)

      • 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<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
        Description copied from class: JobEntryBase
        Allows JobEntry objects to check themselves for consistency
        Specified by:
        check in interface JobEntryInterface
        Overrides:
        check in class JobEntryBase
        Parameters:
        remarks - List of CheckResult objects indicating consistency status
        jobMeta - the metadata object for the job entry
        space - the variable space to resolve string expressions with variables with
        repository - the repository to load Kettle objects from
        metaStore - the MetaStore to load common elements from

      • 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