org.pentaho.di.job.entries.shell
Class JobEntryShell

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.shell.JobEntryShell

All Implemented Interfaces:

Cloneable, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryShell
extends JobEntryBase
implements Cloneable, JobEntryInterface

Shell type of Job Entry. You can define shell scripts to be executed in a Job.

Since:

01-10-2003, rewritten on 18-06-2004

Author:

Matt

Field Summary

boolean	addDate
boolean	addTime
boolean	argFromPrevious
String[]	arguments
boolean	execPerRow
boolean	insertScript
String	logext
String	logfile
org.pentaho.di.core.logging.LogLevel	logFileLevel
String	script
boolean	setAppendLogfile
boolean	setLogfile

Constructor Summary

JobEntryShell()

JobEntryShell(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)
String	getFilename()
String	getLogFilename()
String	getRealFilename()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Get a list of all the resource dependencies that the step is depending on.
String	getScript()
String	getWorkDirectory()
String	getXML()
boolean	isUnconditional()
void	loadRep(Repository rep, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers)
void	loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
void	saveRep(Repository rep, org.pentaho.di.repository.ObjectId id_job)
void	setFileName(String n)
void	setScript(String scriptin)
void	setWorkDirectory(String n)

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRegistrationDate, getRepository, getRepositoryDirectory, 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, 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

exportResources, getDescription, getDialogClassName, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository

Field Detail

arguments

public String[] arguments

argFromPrevious

public boolean argFromPrevious

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

execPerRow

public boolean execPerRow

setAppendLogfile

public boolean setAppendLogfile

insertScript

public boolean insertScript

script

public String script

Constructor Detail

JobEntryShell

public JobEntryShell(String name)

JobEntryShell

public JobEntryShell()

Method Detail

clone

public Object clone()

Specified by:

clone in interface JobEntryInterface

Overrides:

clone in class JobEntryBase

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

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Throws:

org.pentaho.di.core.exception.KettleException

saveRep

public void saveRep(Repository rep,
                    org.pentaho.di.repository.ObjectId 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

clear

public void clear()

Specified by:

clear in interface JobEntryInterface

Overrides:

clear in class JobEntryBase

setFileName

public void setFileName(String n)

getFilename

public String getFilename()

Specified by:

getFilename in interface org.pentaho.di.core.logging.LoggingObjectInterface

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

setWorkDirectory

public void setWorkDirectory(String n)

getWorkDirectory

public String getWorkDirectory()

setScript

public void setScript(String scriptin)

getScript

public String getScript()

getLogFilename

public String getLogFilename()

execute

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

Specified by:

execute in interface JobEntryInterface

Throws:

org.pentaho.di.core.exception.KettleException

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

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

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