org.pentaho.di.job.entries.writetofile
Class JobEntryWriteToFile

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.writetofile.JobEntryWriteToFile

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 JobEntryWriteToFile
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'write to file' job entry. Its main use would be to create empty trigger files that can be used to control the flow in ETL cycles.

Since:

28-01-2007

Author:

Samatar Hassan

Constructor Summary

JobEntryWriteToFile()

JobEntryWriteToFile(String n)

Method Summary

void	check(List<org.pentaho.di.core.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.
org.pentaho.di.core.Result	execute(org.pentaho.di.core.Result previousResult, int nr)
String	getContent()
String	getEncoding()
String	getFilename()
String	getRealFilename()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Get a list of all the resource dependencies that the step is depending on.
String	getXML()
boolean	isAppendFile()
boolean	isCreateParentFolder()
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	setAppendFile(boolean appendFile)
void	setContent(String content)
void	setCreateParentFolder(boolean createParentFolder)
void	setEncoding(String encoding)
void	setFilename(String filename)

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

JobEntryWriteToFile

public JobEntryWriteToFile(String n)

JobEntryWriteToFile

public JobEntryWriteToFile()

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

setFilename

public void setFilename(String filename)

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

setContent

public void setContent(String content)

getContent

public String getContent()

setEncoding

public void setEncoding(String encoding)

getEncoding

public String getEncoding()

getRealFilename

public String getRealFilename()

Specified by:

getRealFilename in interface JobEntryInterface

Overrides:

getRealFilename in class JobEntryBase

execute

public org.pentaho.di.core.Result execute(org.pentaho.di.core.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

isAppendFile

public boolean isAppendFile()

setAppendFile

public void setAppendFile(boolean appendFile)

isCreateParentFolder

public boolean isCreateParentFolder()

setCreateParentFolder

public void setCreateParentFolder(boolean createParentFolder)

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