org.pentaho.di.job.entries.waitforfile
Class JobEntryWaitForFile

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.waitforfile.JobEntryWaitForFile

All Implemented Interfaces:

Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryWaitForFile
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'wait for file' job entry. Its use is to wait for a file to appear.

Since:

10-02-2007

Author:

Sven Boden

Constructor Summary

JobEntryWaitForFile()

JobEntryWaitForFile(String n)

Method Summary

void	check(List<CheckResultInterface> remarks, JobMeta jobMeta) Support for overrides not having to put in a check method
Object	clone()
boolean	evaluates() check whether or not this job entry evaluates.
Result	execute(Result previousResult, int nr)
String	getCheckCycleTime()
String	getFilename()
String	getMaximumTimeout()
String	getRealCheckCycleTime()
String	getRealFilename()
String	getRealMaximumTimeout()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Get a list of all the resource dependencies that the step is depending on.
String	getXML()
boolean	isAddFilenameToResult()
boolean	isFileSizeCheck()
boolean	isSuccessOnTimeout()
void	loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)
void	loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
void	saveRep(Repository rep, ObjectId id_job)
void	setAddFilenameToResult(boolean addFilenameToResult)
void	setCheckCycleTime(String checkCycleTime)
void	setFilename(String filename)
void	setFileSizeCheck(boolean fileSizeCheck)
void	setMaximumTimeout(String maximumTimeout)
void	setSuccessOnTimeout(boolean successOnTimeout)

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

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

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

Constructor Detail

JobEntryWaitForFile

public JobEntryWaitForFile(String n)

JobEntryWaitForFile

public JobEntryWaitForFile()

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<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException

Specified by:

loadXML in interface JobEntryInterface

Throws:

KettleXMLException

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Throws:

KettleException

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Throws:

KettleException

setFilename

public void setFilename(String filename)

getFilename

public String getFilename()

Specified by:

getFilename in interface LoggingObjectInterface

Specified by:

getFilename in interface JobEntryInterface

Overrides:

getFilename in class JobEntryBase

Returns:

the filename

getRealFilename

public String getRealFilename()

Specified by:

getRealFilename in interface JobEntryInterface

Overrides:

getRealFilename in class JobEntryBase

execute

public Result execute(Result previousResult,
                      int nr)

Specified by:

execute in interface JobEntryInterface

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

isSuccessOnTimeout

public boolean isSuccessOnTimeout()

setSuccessOnTimeout

public void setSuccessOnTimeout(boolean successOnTimeout)

getCheckCycleTime

public String getCheckCycleTime()

getRealCheckCycleTime

public String getRealCheckCycleTime()

setCheckCycleTime

public void setCheckCycleTime(String checkCycleTime)

getMaximumTimeout

public String getMaximumTimeout()

getRealMaximumTimeout

public String getRealMaximumTimeout()

setMaximumTimeout

public void setMaximumTimeout(String maximumTimeout)

isFileSizeCheck

public boolean isFileSizeCheck()

setFileSizeCheck

public void setFileSizeCheck(boolean fileSizeCheck)

isAddFilenameToResult

public boolean isAddFilenameToResult()

setAddFilenameToResult

public void setAddFilenameToResult(boolean addFilenameToResult)

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