org.pentaho.di.job.entries.zipfile
Class JobEntryZipFile

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.zipfile.JobEntryZipFile

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

This defines a 'zip file' job entry. Its main use would be to zip files in a directory and process zipped files (deleted or move).

Since:

27-02-2007

Author:

Samatar Hassan

Field Summary

int	afterzip
int	compressionrate
int	ifzipfileexists

Constructor Summary

JobEntryZipFile()

JobEntryZipFile(String n)
Default constructor.

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)
boolean	getcreateparentfolder()
boolean	getDatafromprevious()
String	getDateTimeFormat()
String	getFullFilename(String filename, boolean add_date, boolean add_time, boolean specify_format, String datetime_folder)
String	getMoveToDirectory()
String	getSourceDirectory()
String	getWildcard()
String	getWildcardExclude()
String	getXML()
String	getZipFilename()
boolean	isAddFileToResult()
boolean	isCreateMoveToDirectory()
boolean	isDateInFilename()
boolean	isIncludingSubFolders()
boolean	isSpecifyFormat()
boolean	isTimeInFilename()
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)
boolean	processRowFile(Job parentJob, org.pentaho.di.core.Result result, String realZipfilename, String realWildcard, String realWildcardExclude, String realSourceDirectoryOrFile, String realMovetodirectory, boolean createparentfolder)
void	saveRep(Repository rep, org.pentaho.di.repository.ObjectId id_job)
void	setAddFileToResult(boolean addfiletoresultin)
void	setCreateMoveToDirectory(boolean createMoveToDirectory)
void	setcreateparentfolder(boolean createparentfolder)
void	setDatafromprevious(boolean isfromprevious)
void	setDateInFilename(boolean adddate)
void	setDateTimeFormat(String date_time_format)
void	setIncludingSubFolders(boolean includesSubFolders)
void	setMoveToDirectory(String movetodirectory)
void	setSourceDirectory(String sourcedirectory)
void	setSpecifyFormat(boolean SpecifyFormat)
void	setTimeInFilename(boolean addtime)
void	setWildcard(String wildcard)
void	setWildcardExclude(String wildcardexclude)
void	setZipFilename(String zipFilename)

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

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

Field Detail

compressionrate

public int compressionrate

ifzipfileexists

public int ifzipfileexists

afterzip

public int afterzip

Constructor Detail

JobEntryZipFile

public JobEntryZipFile(String n)

Default constructor.

JobEntryZipFile

public JobEntryZipFile()

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

processRowFile

public boolean processRowFile(Job parentJob,
                              org.pentaho.di.core.Result result,
                              String realZipfilename,
                              String realWildcard,
                              String realWildcardExclude,
                              String realSourceDirectoryOrFile,
                              String realMovetodirectory,
                              boolean createparentfolder)

execute

public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result previousResult,
                                          int nr)

Specified by:

execute in interface JobEntryInterface

getFullFilename

public String getFullFilename(String filename,
                              boolean add_date,
                              boolean add_time,
                              boolean specify_format,
                              String datetime_folder)

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

setZipFilename

public void setZipFilename(String zipFilename)

setWildcard

public void setWildcard(String wildcard)

setWildcardExclude

public void setWildcardExclude(String wildcardexclude)

setSourceDirectory

public void setSourceDirectory(String sourcedirectory)

setMoveToDirectory

public void setMoveToDirectory(String movetodirectory)

getSourceDirectory

public String getSourceDirectory()

getMoveToDirectory

public String getMoveToDirectory()

getZipFilename

public String getZipFilename()

isCreateMoveToDirectory

public boolean isCreateMoveToDirectory()

setCreateMoveToDirectory

public void setCreateMoveToDirectory(boolean createMoveToDirectory)

getWildcard

public String getWildcard()

getWildcardExclude

public String getWildcardExclude()

setAddFileToResult

public void setAddFileToResult(boolean addfiletoresultin)

isAddFileToResult

public boolean isAddFileToResult()

setcreateparentfolder

public void setcreateparentfolder(boolean createparentfolder)

setDateInFilename

public void setDateInFilename(boolean adddate)

isDateInFilename

public boolean isDateInFilename()

setTimeInFilename

public void setTimeInFilename(boolean addtime)

isTimeInFilename

public boolean isTimeInFilename()

isSpecifyFormat

public boolean isSpecifyFormat()

setSpecifyFormat

public void setSpecifyFormat(boolean SpecifyFormat)

getDateTimeFormat

public String getDateTimeFormat()

setDateTimeFormat

public void setDateTimeFormat(String date_time_format)

getcreateparentfolder

public boolean getcreateparentfolder()

setDatafromprevious

public void setDatafromprevious(boolean isfromprevious)

getDatafromprevious

public boolean getDatafromprevious()

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

isIncludingSubFolders

public boolean isIncludingSubFolders()

Returns:

true if the search for files to zip in a folder include sub-folders

setIncludingSubFolders

public void setIncludingSubFolders(boolean includesSubFolders)

Parameters:

includesSubFolders - Set to true if the search for files to zip in a folder needs to include sub-folders