Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.pentaho.di.job.entries.job
Class JobEntryJob

    java.lang.Object
      org.pentaho.di.job.entry.JobEntryBase
          org.pentaho.di.job.entries.job.JobEntryJob

All Implemented Interfaces:
  Cloneable, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

    public class JobEntryJob

extends JobEntryBase
implements Cloneable, JobEntryInterface

Recursive definition of a Job. This step means that an entire Job has to be executed. It can be the same Job, but just make sure that you don't get an endless loop. Provide an escape routine using JobEval.

Since:
  01-10-2003, Rewritten on 18-06-2004
Author:
  Matt

Field Summary
`boolean` | `addDate`
`boolean` | `addTime`
`boolean` | `argFromPrevious`
`String[]` | `arguments`
`boolean` | `execPerRow`
`boolean` | `followingAbortRemotely`
`String` | `logext`
`String` | `logfile`
`int` | `loglevel`
`boolean` | `parallel`
`String[]` | `parameterFieldNames`
`String[]` | `parameters`
`String[]` | `parameterValues`
`boolean` | `paramsFromPrevious`
`boolean` | `passingAllParameters`
`boolean` | `setAppendLogfile`
`boolean` | `setLogfile`
`boolean` | `waitingToFinish`

Fields inherited from class org.pentaho.di.job.entry.JobEntryBase
`category_order`

Constructor Summary
`JobEntryJob()`
`JobEntryJob(JobEntryBase jeb)`
`JobEntryJob(String name)`

Method Summary
`void` | `check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta)` Support for overrides not having to put in a check method
`void` | `clear()`
`Object` | `clone()`
`boolean` | `evaluates()` check whether or not this job entry evaluates.
`org.pentaho.di.core.Result` | `execute(org.pentaho.di.core.Result result, int nr, Repository rep, Job parentJob)`
`String` | `exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface namingInterface, Repository repository)` We're going to load the transformation meta data referenced here.
`String` | `getDirectory()`
`String` | `getFilename()`
`String` | `getFileName()` Deprecated. use getFilename() instead.
`String` | `getJobName()`
`String` | `getLogFilename()`
`String` | `getRealFilename()`
`String` | `getRemoteSlaveServerName()`
`List<ResourceReference>` | `getResourceDependencies(JobMeta jobMeta)` Get a list of all the resource dependencies that the step is depending on.
`List<org.pentaho.di.core.SQLStatement>` | `getSQLStatements(Repository repository)`
`List<org.pentaho.di.core.SQLStatement>` | `getSQLStatements(Repository repository, org.pentaho.di.core.variables.VariableSpace space)`
`String` | `getXML()`
`boolean` | `isExecPerRow()`
`boolean` | `isFollowingAbortRemotely()`
`boolean` | `isPassingAllParameters()`
`boolean` | `isUnconditional()`
`boolean` | `isWaitingToFinish()`
`void` | `loadRep(Repository rep, long id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers)` Load the jobentry from repository
`void` | `loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)`
`static void` | `main(String[] args)`
`void` | `saveRep(Repository rep, long id_job)`
`void` | `setDirectory(String directory)`
`void` | `setExecPerRow(boolean runEveryResultRow)`
`void` | `setFileName(String n)`
`void` | `setFollowingAbortRemotely(boolean followingAbortRemotely)`
`void` | `setJobName(String jobname)`
`void` | `setPassingAllParameters(boolean passingAllParameters)`
`void` | `setRemoteSlaveServerName(String remoteSlaveServerName)`
`void` | `setWaitingToFinish(boolean waitingToFinish)`

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
`copyVariablesFrom, environmentSubstitute, environmentSubstitute, getBooleanValueOfVariable, getConfigId, getDescription, getDialogClassName, getHolderType, getID, getJobEntryType, getName, getParentVariableSpace, getPluginID, getTypeCode, getTypeCode, getTypeDesc, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, initializeVariablesFrom, injectVariables, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isSFTP, isShell, isSpecial, isStart, isTransformation, listVariables, loadXML, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setConfigId, setDescription, setID, setJobEntryType, setName, setParentVariableSpace, setPluginID, setVariable, shareVariablesWith, toString`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
`getConfigId, getDescription, getDialogClassName, getID, getJobEntryType, getName, getPluginID, getTypeCode, getUsedDatabaseConnections, hasChanged, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, resetErrorsBeforeExecution, setChanged, setChanged, setConfigId, setDescription, setID, setJobEntryType, setName, setPluginID`

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

### loglevel

    public int loglevel

### parallel

    public boolean parallel

### setAppendLogfile

    public boolean setAppendLogfile

### waitingToFinish

    public boolean waitingToFinish

### followingAbortRemotely

    public boolean followingAbortRemotely

### passingAllParameters

    public boolean passingAllParameters

Constructor Detail

### JobEntryJob

    public JobEntryJob(String name)

### JobEntryJob

    public JobEntryJob()

### JobEntryJob

    public JobEntryJob(JobEntryBase jeb)

Method Detail

### clone

    public Object clone()

  Specified by:
    `clone` in interface `JobEntryInterface`
  Overrides:
    `clone` in class `JobEntryBase`

### setFileName

    public void setFileName(String n)

### getFileName

    public String getFileName()

  Deprecated. use getFilename() instead.

  Returns:
    the filename

### getFilename

    public String getFilename()

  Specified by:
    `getFilename` in interface `JobEntryInterface`
  Overrides:
    `getFilename` in class `JobEntryBase`

### getRealFilename

    public String getRealFilename()

  Specified by:
    `getRealFilename` in interface `JobEntryInterface`
  Overrides:
    `getRealFilename` in class `JobEntryBase`

### setJobName

    public void setJobName(String jobname)

### getJobName

    public String getJobName()

### getDirectory

    public String getDirectory()

### setDirectory

    public void setDirectory(String directory)

### getLogFilename

    public String getLogFilename()

### getXML

    public String getXML()

  Specified by:
    `getXML` in interface `JobEntryInterface`
  Overrides:
    `getXML` in class `JobEntryBase`

### loadXML

    public void loadXML(Node entrynode,
                        List<org.pentaho.di.core.database.DatabaseMeta> databases,
                        List<SlaveServer> slaveServers,
                        Repository rep)
                 throws org.pentaho.di.core.exception.KettleXMLException

  Specified by:
    `loadXML` in interface `JobEntryInterface`
  Throws:
    `org.pentaho.di.core.exception.KettleXMLException`

### loadRep

    public void loadRep(Repository rep,
                        long 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`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### saveRep

    public void saveRep(Repository rep,
                        long id_job)
                 throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `saveRep` in interface `JobEntryInterface`
  Overrides:
    `saveRep` in class `JobEntryBase`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### execute

    public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result result,
                                              int nr,
                                              Repository rep,
                                              Job parentJob)
                                       throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `execute` in interface `JobEntryInterface`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### clear

    public void clear()

  Specified by:
    `clear` in interface `JobEntryInterface`
  Overrides:
    `clear` in class `JobEntryBase`

### evaluates

    public boolean evaluates()

  Description copied from class: `JobEntryBase`
  check whether or not this job entry evaluates.

  Specified by:
    `evaluates` in interface `JobEntryInterface`
  Overrides:
    `evaluates` in class `JobEntryBase`
  Returns:
    true if the job entry evaluates

### isUnconditional

    public boolean isUnconditional()

  Specified by:
    `isUnconditional` in interface `JobEntryInterface`
  Overrides:
    `isUnconditional` in class `JobEntryBase`

### getSQLStatements

    public List<org.pentaho.di.core.SQLStatement> getSQLStatements(Repository repository)
                                                            throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `getSQLStatements` in interface `JobEntryInterface`
  Overrides:
    `getSQLStatements` in class `JobEntryBase`
  Throws:
    `org.pentaho.di.core.exception.KettleException`

### getSQLStatements

    public List<org.pentaho.di.core.SQLStatement> getSQLStatements(Repository repository,
                                                                   org.pentaho.di.core.variables.VariableSpace space)
                                                            throws org.pentaho.di.core.exception.KettleException

  Specified by:
    `getSQLStatements` in interface `JobEntryInterface`
  Overrides:
    `getSQLStatements` in class `JobEntryBase`
  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.

### getResourceDependencies

    public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

  Description copied from class: `JobEntryBase`
  Get a list of all the resource dependencies that the step is depending on.

  Specified by:
    `getResourceDependencies` in interface `JobEntryInterface`
  Overrides:
    `getResourceDependencies` in class `JobEntryBase`
  Returns:
    a list of all the resource dependencies that the step is depending on

### exportResources

    public String exportResources(org.pentaho.di.core.variables.VariableSpace space,
                                  Map<String,ResourceDefinition> definitions,
                                  ResourceNamingInterface namingInterface,
                                  Repository repository)
                           throws org.pentaho.di.core.exception.KettleException

  We're going to load the transformation meta data referenced here. Then we're going to give it a new filename, modify that filename in this entries. The parent caller will have made a copy of it, so it should be OK to do so.

  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 name appropriately
    `repository` - The repository to load resources 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)

  Description copied from class: `JobEntryBase`
  Support for overrides not having to put in a check method

  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

### main

    public static void main(String[] args)

### getRemoteSlaveServerName

    public String getRemoteSlaveServerName()

  Returns:
    the remote slave server name

### setRemoteSlaveServerName

    public void setRemoteSlaveServerName(String remoteSlaveServerName)

  Parameters:
    `remoteSlaveServerName` - the remoteSlaveServer to set

### 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD