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

Class JobEntryJob

    • Field Detail

      • arguments

        public String[] arguments

      • argFromPrevious

        public boolean argFromPrevious

      • paramsFromPrevious

        public boolean paramsFromPrevious

      • execPerRow

        public boolean execPerRow

      • parameters

        public String[] parameters

      • parameterFieldNames

        public String[] parameterFieldNames

      • parameterValues

        public String[] parameterValues

      • setLogfile

        public boolean setLogfile

      • logfile

        public String logfile

      • logext

        public String logext

      • addDate

        public boolean addDate

      • addTime

        public boolean addTime

      • logFileLevel

        public org.pentaho.di.core.logging.LogLevel logFileLevel

      • parallel

        public boolean parallel

      • setAppendLogfile

        public boolean setAppendLogfile

      • createParentFolder

        public boolean createParentFolder

      • waitingToFinish

        public boolean waitingToFinish

      • followingAbortRemotely

        public boolean followingAbortRemotely

      • expandingRemoteJob

        public boolean expandingRemoteJob

      • passingAllParameters

        public boolean passingAllParameters

      • DEFAULT_LOG_LEVEL

        public static final org.pentaho.di.core.logging.LogLevel DEFAULT_LOG_LEVEL

    • Constructor Detail

      • JobEntryJob

        public JobEntryJob​(String name)

      • JobEntryJob

        public JobEntryJob()

    • 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

      • setFileName

        public void setFileName​(String n)

      • getFileName

        @Deprecated
public String getFileName()
        Deprecated.
        use getFilename() instead.
        Returns:
        the filename

      • getFilename

        public String getFilename()
        Description copied from class: JobEntryBase
        Gets the filename of the job entry. For JobEntryBase, this method always returns null
        Specified by:
        getFilename in interface JobEntryInterface
        Specified by:
        getFilename in interface org.pentaho.di.core.logging.LoggingObjectInterface
        Overrides:
        getFilename in class JobEntryBase
        Returns:
        null
        See Also:
        LoggingObjectInterface.getFilename()

      • setJobName

        public void setJobName​(String jobname)

      • getJobName

        public String getJobName()

      • getDirectory

        public String getDirectory()

      • setDirectory

        public void setDirectory​(String directory)

      • 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

      • isPassingExport

        public boolean isPassingExport()

      • setPassingExport

        public void setPassingExport​(boolean passingExport)

      • getLogFilename

        public String getLogFilename()

      • 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

      • 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
        Load the jobentry from repository
        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 result,
                                          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:
        result - 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

      • 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

      • isUnconditional

        public boolean isUnconditional()
        Description copied from class: JobEntryBase
        This method must return true if the job entry supports the unconditional outgoing hop. For JobEntryBase, this method always returns true
        Specified by:
        isUnconditional in interface JobEntryInterface
        Overrides:
        isUnconditional in class JobEntryBase
        Returns:
        true

      • getSQLStatements

        public List<org.pentaho.di.core.SQLStatement> getSQLStatements​(Repository repository,
                                                               org.pentaho.metastore.api.IMetaStore metaStore,
                                                               org.pentaho.di.core.variables.VariableSpace space)
                                                        throws org.pentaho.di.core.exception.KettleException
        Description copied from class: JobEntryBase
        Gets the SQL statements needed by this job entry to execute successfully, given a set of variables. For JobEntryBase, this method returns an empty list.
        Specified by:
        getSQLStatements in interface JobEntryInterface
        Overrides:
        getSQLStatements in class JobEntryBase
        Parameters:
        repository - the repository object
        metaStore - the MetaStore to use
        space - a variable space object containing variable bindings
        Returns:
        an empty list
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the generation of SQL statements

      • getJobMetaFromRepository

        protected JobMeta getJobMetaFromRepository​(Repository rep,
                                           CurrentDirectoryResolver r,
                                           String transPath,
                                           org.pentaho.di.core.variables.VariableSpace tmpSpace)
                                    throws org.pentaho.di.core.exception.KettleException
        Throws:
        org.pentaho.di.core.exception.KettleException

      • getJobMeta

        public JobMeta getJobMeta​(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

      • isExecPerRow

        public boolean isExecPerRow()
        Returns:
        Returns the runEveryResultRow.

      • setExecPerRow

        public void setExecPerRow​(boolean runEveryResultRow)
        Parameters:
        runEveryResultRow - The runEveryResultRow to set.

      • exportResources

        public String exportResources​(org.pentaho.di.core.variables.VariableSpace space,
                              Map<String,​ResourceDefinition> definitions,
                              ResourceNamingInterface namingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws org.pentaho.di.core.exception.KettleException
        Exports the object to a flat-file system, adding content with filename keys to a set of definitions. The supplied resource naming interface allows the object to name appropriately without worrying about those parts of the implementation specific details.
        Specified by:
        exportResources in interface JobEntryInterface
        Overrides:
        exportResources in class JobEntryBase
        Parameters:
        space - The variable space to resolve (environment) variables with.
        definitions - The map containing the filenames and content
        namingInterface - The resource naming interface allows the object to be named appropriately
        repository - The repository to load resources from
        metaStore - the metaStore to load external metadata from
        Returns:
        The filename for this object. (also contained in the definitions map)
        Throws:
        org.pentaho.di.core.exception.KettleException - in case something goes wrong during the export

      • 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

      • main

        public static void main​(String[] args)

      • getLogfile

        protected String getLogfile()

      • getRemoteSlaveServerName

        public String getRemoteSlaveServerName()
        Returns:
        the remote slave server name

      • isWaitingToFinish

        public boolean isWaitingToFinish()
        Returns:
        the waitingToFinish

      • setWaitingToFinish

        public void setWaitingToFinish​(boolean waitingToFinish)
        Parameters:
        waitingToFinish - the waitingToFinish to set

      • isFollowingAbortRemotely

        public boolean isFollowingAbortRemotely()
        Returns:
        the followingAbortRemotely

      • setFollowingAbortRemotely

        public void setFollowingAbortRemotely​(boolean followingAbortRemotely)
        Parameters:
        followingAbortRemotely - the followingAbortRemotely to set

      • isPassingAllParameters

        public boolean isPassingAllParameters()
        Returns:
        the passingAllParameters

      • setPassingAllParameters

        public void setPassingAllParameters​(boolean passingAllParameters)
        Parameters:
        passingAllParameters - the passingAllParameters to set

      • getJob

        public Job getJob()

      • 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

      • 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

      • lookupRepositoryReferences

        public void lookupRepositoryReferences​(Repository repository)
                                throws org.pentaho.di.core.exception.KettleException
        Look up the references after import
        Specified by:
        lookupRepositoryReferences in interface JobEntryInterface
        Overrides:
        lookupRepositoryReferences in class JobEntryBase
        Parameters:
        repository - the repository to reference.
        Throws:
        org.pentaho.di.core.exception.KettleException - if any errors occur during the lookup

      • 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 JobEntryInterface
        Overrides:
        loadReferencedObject in class JobEntryBase
        Parameters:
        index - the referenced object index to load (in case there are multiple references)
        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

      • isExpandingRemoteJob

        public boolean isExpandingRemoteJob()

      • setExpandingRemoteJob

        public void setExpandingRemoteJob​(boolean expandingRemoteJob)

      • setParentJobMeta

        public void setParentJobMeta​(JobMeta parentJobMeta)
        Description copied from class: JobEntryBase
        At save and run time, the system will attempt to set the jobMeta so that it can be accessed by the jobEntries if necessary.
        Specified by:
        setParentJobMeta in interface JobEntryInterface
        Overrides:
        setParentJobMeta in class JobEntryBase
        Parameters:
        parentJobMeta - the JobMeta to which this JobEntryInterface belongs