Package org.pentaho.di.trans.steps.jobexecutor

Class JobExecutorMeta

    • Constructor Detail

      • JobExecutorMeta

        public JobExecutorMeta()

    • Method Detail

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

      • loadXML

        public void loadXML​(Node stepnode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException
        Description copied from interface: StepMetaInterface
        Load the values for this step from an XML Node
        Specified by:
        loadXML in interface StepMetaInterface
        Overrides:
        loadXML in class BaseStepMeta
        Parameters:
        stepnode - the Node to get the info from
        databases - The available list of databases to reference to
        metaStore - the metastore to optionally load external reference metadata from
        Throws:
        org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

      • readRep

        public void readRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_step,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: StepMetaInterface
        Read the steps information from a Kettle repository
        Specified by:
        readRep in interface StepMetaInterface
        Overrides:
        readRep in class BaseStepMeta
        Parameters:
        rep - The repository to read from
        metaStore - The MetaStore to read external information from
        id_step - The step ID
        databases - The databases to reference
        Throws:
        org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

      • saveRep

        public void saveRep​(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_transformation,
                    org.pentaho.di.repository.ObjectId id_step)
             throws org.pentaho.di.core.exception.KettleException
        Description copied from interface: StepMetaInterface
        Save the steps data into a Kettle repository
        Specified by:
        saveRep in interface StepMetaInterface
        Overrides:
        saveRep in class BaseStepMeta
        Parameters:
        rep - The Kettle repository to save to
        metaStore - the metaStore to optionally write to
        id_transformation - The transformation ID
        id_step - The step ID
        Throws:
        org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

      • getFields

        public void getFields​(org.pentaho.di.core.row.RowMetaInterface row,
                      String origin,
                      org.pentaho.di.core.row.RowMetaInterface[] info,
                      StepMeta nextStep,
                      org.pentaho.di.core.variables.VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws org.pentaho.di.core.exception.KettleStepException
        Description copied from class: BaseStepMeta
        Gets the fields.
        Specified by:
        getFields in interface StepMetaInterface
        Overrides:
        getFields in class BaseStepMeta
        Parameters:
        row - the input row meta that is modified in this method to reflect the output row metadata of the step
        origin - Name of the step to use as input for the origin field in the values
        info - Fields used as extra lookup information
        nextStep - the next step that is targeted
        space - the space The variable space to use to replace variables
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields
        Throws:
        org.pentaho.di.core.exception.KettleStepException - the kettle step exception

      • getInfoSteps

        public String[] getInfoSteps()

      • getTargetSteps

        public String[] getTargetSteps()

      • loadJobMeta

        public static final JobMeta loadJobMeta​(JobExecutorMeta executorMeta,
                                        Repository rep,
                                        org.pentaho.di.core.variables.VariableSpace space)
                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • loadJobMeta

        public static final JobMeta loadJobMeta​(JobExecutorMeta executorMeta,
                                        Repository rep,
                                        org.pentaho.metastore.api.IMetaStore metaStore,
                                        org.pentaho.di.core.variables.VariableSpace space)
                                 throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • check

        public void check​(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  org.pentaho.di.core.row.RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  org.pentaho.di.core.row.RowMetaInterface info,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)
        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
        Overrides:
        check in class BaseStepMeta
        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
        space - the variable space to resolve variable expressions with
        repository - the repository to use to load Kettle metadata objects impacting the output fields
        metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

      • 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

      • exportResources

        public String exportResources​(org.pentaho.di.core.variables.VariableSpace space,
                              Map<String,​ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws org.pentaho.di.core.exception.KettleException
        Specified by:
        exportResources in interface StepMetaInterface
        Overrides:
        exportResources in class BaseStepMeta
        Parameters:
        space - the variable space to use
        repository - The repository to optionally load other resources from (to be converted to XML)
        metaStore - the metaStore in which non-kettle metadata could reside.
        Returns:
        the filename of the exported resource
        Throws:
        org.pentaho.di.core.exception.KettleException

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

      • getDirectoryPath

        public String getDirectoryPath()
        Returns:
        the directoryPath

      • setDirectoryPath

        public void setDirectoryPath​(String directoryPath)
        Parameters:
        directoryPath - the directoryPath to set

      • getDirectories

        public String[] getDirectories()
        Description copied from interface: HasRepositoryDirectories
        If step has reference(s) to another transformation(s)/job(s) returns an array of repository directories. An implementation is considered to define the array order itself.
        Specified by:
        getDirectories in interface HasRepositoryDirectories
        Returns:
        String array of repository directories

      • setDirectories

        public void setDirectories​(String[] directories)
        Description copied from interface: HasRepositoryDirectories
        If step has reference(s) to another transformation(s)/job(s) sets updated repository directories from incoming String array. An implementation is considered to define the array order itself.
        Specified by:
        setDirectories in interface HasRepositoryDirectories
        Parameters:
        directories - Array of updated rep directories to set

      • getFileName

        public String getFileName()
        Returns:
        the fileName

      • setFileName

        public void setFileName​(String fileName)
        Parameters:
        fileName - the fileName to set

      • getMappingParameters

        public JobExecutorParameters getMappingParameters()
        Returns:
        the mappingParameters

      • setMappingParameters

        public void setMappingParameters​(JobExecutorParameters mappingParameters)
        Parameters:
        mappingParameters - the mappingParameters to set

      • getSpecificationMethod

        public org.pentaho.di.core.ObjectLocationSpecificationMethod getSpecificationMethod()
        Returns:
        the specificationMethod

      • getSpecificationMethods

        public org.pentaho.di.core.ObjectLocationSpecificationMethod[] getSpecificationMethods()
        Description copied from interface: HasRepositoryDirectories
        If step has reference(s) to another transformation(s)/job(s) returns an array of specification method(s) defining the type of an access to a referenced file. An implementation is considered to define the array order itself.
        Specified by:
        getSpecificationMethods in interface HasRepositoryDirectories
        Returns:
        String array of specification method(s)

      • setSpecificationMethod

        public void setSpecificationMethod​(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod)
        Parameters:
        specificationMethod - the specificationMethod to set

      • getJobName

        public String getJobName()
        Returns:
        the jobName

      • setJobName

        public void setJobName​(String jobName)
        Parameters:
        jobName - the jobName to set

      • getJobObjectId

        public org.pentaho.di.repository.ObjectId getJobObjectId()
        Returns:
        the jobObjectId

      • setJobObjectId

        public void setJobObjectId​(org.pentaho.di.repository.ObjectId jobObjectId)
        Parameters:
        jobObjectId - the jobObjectId to set

      • setParameters

        public void setParameters​(JobExecutorParameters parameters)
        Parameters:
        parameters - the parameters to set

      • getExecutionTimeField

        public String getExecutionTimeField()
        Returns:
        the executionTimeField

      • setExecutionTimeField

        public void setExecutionTimeField​(String executionTimeField)
        Parameters:
        executionTimeField - the executionTimeField to set

      • getExecutionResultField

        public String getExecutionResultField()
        Returns:
        the executionResultField

      • setExecutionResultField

        public void setExecutionResultField​(String executionResultField)
        Parameters:
        executionResultField - the executionResultField to set

      • getExecutionNrErrorsField

        public String getExecutionNrErrorsField()
        Returns:
        the executionNrErrorsField

      • setExecutionNrErrorsField

        public void setExecutionNrErrorsField​(String executionNrErrorsField)
        Parameters:
        executionNrErrorsField - the executionNrErrorsField to set

      • getExecutionLinesReadField

        public String getExecutionLinesReadField()
        Returns:
        the executionLinesReadField

      • setExecutionLinesReadField

        public void setExecutionLinesReadField​(String executionLinesReadField)
        Parameters:
        executionLinesReadField - the executionLinesReadField to set

      • getExecutionLinesWrittenField

        public String getExecutionLinesWrittenField()
        Returns:
        the executionLinesWrittenField

      • setExecutionLinesWrittenField

        public void setExecutionLinesWrittenField​(String executionLinesWrittenField)
        Parameters:
        executionLinesWrittenField - the executionLinesWrittenField to set

      • getExecutionLinesInputField

        public String getExecutionLinesInputField()
        Returns:
        the executionLinesInputField

      • setExecutionLinesInputField

        public void setExecutionLinesInputField​(String executionLinesInputField)
        Parameters:
        executionLinesInputField - the executionLinesInputField to set

      • getExecutionLinesOutputField

        public String getExecutionLinesOutputField()
        Returns:
        the executionLinesOutputField

      • setExecutionLinesOutputField

        public void setExecutionLinesOutputField​(String executionLinesOutputField)
        Parameters:
        executionLinesOutputField - the executionLinesOutputField to set

      • getExecutionLinesRejectedField

        public String getExecutionLinesRejectedField()
        Returns:
        the executionLinesRejectedField

      • setExecutionLinesRejectedField

        public void setExecutionLinesRejectedField​(String executionLinesRejectedField)
        Parameters:
        executionLinesRejectedField - the executionLinesRejectedField to set

      • getExecutionLinesUpdatedField

        public String getExecutionLinesUpdatedField()
        Returns:
        the executionLinesUpdatedField

      • setExecutionLinesUpdatedField

        public void setExecutionLinesUpdatedField​(String executionLinesUpdatedField)
        Parameters:
        executionLinesUpdatedField - the executionLinesUpdatedField to set

      • getExecutionLinesDeletedField

        public String getExecutionLinesDeletedField()
        Returns:
        the executionLinesDeletedField

      • setExecutionLinesDeletedField

        public void setExecutionLinesDeletedField​(String executionLinesDeletedField)
        Parameters:
        executionLinesDeletedField - the executionLinesDeletedField to set

      • getExecutionFilesRetrievedField

        public String getExecutionFilesRetrievedField()
        Returns:
        the executionFilesRetrievedField

      • setExecutionFilesRetrievedField

        public void setExecutionFilesRetrievedField​(String executionFilesRetrievedField)
        Parameters:
        executionFilesRetrievedField - the executionFilesRetrievedField to set

      • getExecutionExitStatusField

        public String getExecutionExitStatusField()
        Returns:
        the executionExitStatusField

      • setExecutionExitStatusField

        public void setExecutionExitStatusField​(String executionExitStatusField)
        Parameters:
        executionExitStatusField - the executionExitStatusField to set

      • getExecutionLogTextField

        public String getExecutionLogTextField()
        Returns:
        the executionLogTextField

      • setExecutionLogTextField

        public void setExecutionLogTextField​(String executionLogTextField)
        Parameters:
        executionLogTextField - the executionLogTextField to set

      • getExecutionLogChannelIdField

        public String getExecutionLogChannelIdField()
        Returns:
        the executionLogChannelIdField

      • setExecutionLogChannelIdField

        public void setExecutionLogChannelIdField​(String executionLogChannelIdField)
        Parameters:
        executionLogChannelIdField - the executionLogChannelIdField to set

      • getResultRowsTargetStep

        public String getResultRowsTargetStep()
        Returns:
        the resultRowsTargetStep

      • setResultRowsTargetStep

        public void setResultRowsTargetStep​(String resultRowsTargetStep)
        Parameters:
        resultRowsTargetStep - the resultRowsTargetStep to set

      • getResultRowsField

        public String[] getResultRowsField()
        Returns:
        the resultRowsField

      • setResultRowsField

        public void setResultRowsField​(String[] resultRowsField)
        Parameters:
        resultRowsField - the resultRowsField to set

      • getResultRowsType

        public int[] getResultRowsType()
        Returns:
        the resultRowsType

      • setResultRowsType

        public void setResultRowsType​(int[] resultRowsType)
        Parameters:
        resultRowsType - the resultRowsType to set

      • getResultRowsLength

        public int[] getResultRowsLength()
        Returns:
        the resultRowsLength

      • setResultRowsLength

        public void setResultRowsLength​(int[] resultRowsLength)
        Parameters:
        resultRowsLength - the resultRowsLength to set

      • getResultRowsPrecision

        public int[] getResultRowsPrecision()
        Returns:
        the resultRowsPrecision

      • setResultRowsPrecision

        public void setResultRowsPrecision​(int[] resultRowsPrecision)
        Parameters:
        resultRowsPrecision - the resultRowsPrecision to set

      • getResultFilesTargetStep

        public String getResultFilesTargetStep()
        Returns:
        the resultFilesTargetStep

      • setResultFilesTargetStep

        public void setResultFilesTargetStep​(String resultFilesTargetStep)
        Parameters:
        resultFilesTargetStep - the resultFilesTargetStep to set

      • getResultRowsTargetStepMeta

        public StepMeta getResultRowsTargetStepMeta()
        Returns:
        the resultRowsTargetStepMeta

      • setResultRowsTargetStepMeta

        public void setResultRowsTargetStepMeta​(StepMeta resultRowsTargetStepMeta)
        Parameters:
        resultRowsTargetStepMeta - the resultRowsTargetStepMeta to set

      • getResultFilesTargetStepMeta

        public StepMeta getResultFilesTargetStepMeta()
        Returns:
        the resultFilesTargetStepMeta

      • setResultFilesTargetStepMeta

        public void setResultFilesTargetStepMeta​(StepMeta resultFilesTargetStepMeta)
        Parameters:
        resultFilesTargetStepMeta - the resultFilesTargetStepMeta to set

      • getGroupSize

        public String getGroupSize()
        Returns:
        the groupSize

      • setGroupSize

        public void setGroupSize​(String groupSize)
        Parameters:
        groupSize - the groupSize to set

      • getGroupField

        public String getGroupField()
        Returns:
        the groupField

      • setGroupField

        public void setGroupField​(String groupField)
        Parameters:
        groupField - the groupField to set

      • getGroupTime

        public String getGroupTime()
        Returns:
        the groupTime

      • setGroupTime

        public void setGroupTime​(String groupTime)
        Parameters:
        groupTime - the groupTime to set

      • getExecutionResultTargetStep

        public String getExecutionResultTargetStep()
        Returns:
        the executionResultTargetStep

      • setExecutionResultTargetStep

        public void setExecutionResultTargetStep​(String executionResultTargetStep)
        Parameters:
        executionResultTargetStep - the executionResultTargetStep to set

      • getExecutionResultTargetStepMeta

        public StepMeta getExecutionResultTargetStepMeta()
        Returns:
        the executionResultTargetStepMeta

      • setExecutionResultTargetStepMeta

        public void setExecutionResultTargetStepMeta​(StepMeta executionResultTargetStepMeta)
        Parameters:
        executionResultTargetStepMeta - the executionResultTargetStepMeta to set

      • getResultFilesFileNameField

        public String getResultFilesFileNameField()
        Returns:
        the resultFilesFileNameField

      • setResultFilesFileNameField

        public void setResultFilesFileNameField​(String resultFilesFileNameField)
        Parameters:
        resultFilesFileNameField - the resultFilesFileNameField to set

      • loadReferencedObject

        public Object loadReferencedObject​(int index,
                                   Repository rep,
                                   org.pentaho.metastore.api.IMetaStore metaStore,
                                   org.pentaho.di.core.variables.VariableSpace space)
                            throws org.pentaho.di.core.exception.KettleException
        Load the referenced object
        Specified by:
        loadReferencedObject in interface StepMetaInterface
        Overrides:
        loadReferencedObject in class BaseStepMeta
        Parameters:
        index - the object index to load
        rep - the repository
        metaStore - the metaStore
        space - the variable space to use
        Returns:
        the referenced object once loaded
        Throws:
        org.pentaho.di.core.exception.KettleException

      • setMetaStore

        public void setMetaStore​(org.pentaho.metastore.api.IMetaStore metaStore)

      • getMetaStore

        public org.pentaho.metastore.api.IMetaStore getMetaStore()

      • cleanAfterHopFromRemove

        public boolean cleanAfterHopFromRemove​(StepMeta toStep)
        Description copied from interface: StepMetaInterface

        Action remove hop exiting this step

        Specified by:
        cleanAfterHopFromRemove in interface StepMetaInterface
        Parameters:
        toStep - the to-step of the hop being removed
        Returns:
        step was changed