org.pentaho.di.job.entries.movefiles
Class JobEntryMoveFiles

java.lang.Object
  extended by org.pentaho.di.job.entry.JobEntryBase
      extended by org.pentaho.di.job.entries.movefiles.JobEntryMoveFiles
All Implemented Interfaces:
Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryMoveFiles
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'move files' job entry.

Since:
25-02-2008
Author:
Samatar Hassan

Field Summary
 boolean add_result_filesname
           
 boolean arg_from_previous
           
 boolean create_destination_folder
           
 boolean create_move_to_folder
           
 String[] destination_filefolder
           
 boolean destination_is_a_file
           
 boolean include_subfolders
           
 boolean move_empty_folders
           
 boolean simulate
           
 String[] source_filefolder
           
 String SUCCESS_IF_AT_LEAST_X_FILES_UN_ZIPPED
           
 String SUCCESS_IF_ERRORS_LESS
           
 String SUCCESS_IF_NO_ERRORS
           
 String[] wildcard
           
 
Constructor Summary
JobEntryMoveFiles()
           
JobEntryMoveFiles(String n)
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, JobMeta jobMeta)
          Support for overrides not having to put in a check method.
 Object clone()
          This method is called when a job entry is duplicated in Spoon.
 boolean evaluates()
          This method must return true if the job entry supports the true/false outgoing hops.
 Result execute(Result previousResult, int nr)
          Execute the job entry.
 String getDateTimeFormat()
           
 String getDestinationFolder()
           
 String getIfFileExists()
           
 String getIfMovedFileExists()
           
 String getMovedDateTimeFormat()
           
 String getNrErrorsLessThan()
           
 String getSuccessCondition()
           
 String getXML()
          This method is called by PDI whenever a job entry needs to serialize its settings to XML.
 boolean isAddDate()
           
 boolean isAddDateBeforeExtension()
           
 boolean isAddMovedDate()
           
 boolean isAddMovedDateBeforeExtension()
           
 boolean isAddMovedTime()
           
 boolean isAddTime()
           
 boolean isDoNotKeepFolderStructure()
           
 boolean isSpecifyFormat()
           
 boolean isSpecifyMoveFormat()
           
 void loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)
          This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository.
 void loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
          This method is called by PDI whenever a job entry needs to read its settings from XML.
 void saveRep(Repository rep, ObjectId id_job)
          This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
 void setAddDate(boolean adddate)
           
 void setAddDateBeforeExtension(boolean AddDateBeforeExtension)
           
 void setAddMovedDate(boolean add_moved_date)
           
 void setAddMovedDateBeforeExtension(boolean AddMovedDateBeforeExtension)
           
 void setAddMovedTime(boolean add_moved_time)
           
 void setAddresultfilesname(boolean add_result_filesnamein)
           
 void setAddTime(boolean addtime)
           
 void setArgFromPrevious(boolean argfrompreviousin)
           
 void setCreateDestinationFolder(boolean create_destination_folder)
           
 void setCreateMoveToFolder(boolean create_move_to_folder)
           
 void setDateTimeFormat(String date_time_format)
           
 void setDestinationFolder(String destinationFolder)
           
 void setDestinationIsAFile(boolean destination_is_a_file)
           
 void setDoNotKeepFolderStructure(boolean DoNotKeepFolderStructure)
           
 void setIfFileExists(String iffileexists)
           
 void setIfMovedFileExists(String ifmovedfileexists)
           
 void setIncludeSubfolders(boolean include_subfoldersin)
           
 void setMovedDateTimeFormat(String moved_date_time_format)
           
 void setMoveEmptyFolders(boolean move_empty_foldersin)
           
 void setNrErrorsLessThan(String nr_errors_less_than)
           
 void setSimulate(boolean simulate)
           
 void setSpecifyFormat(boolean SpecifyFormat)
           
 void setSpecifyMoveFormat(boolean SpecifyMoveFormat)
           
 void setSuccessCondition(String success_condition)
           
 
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

move_empty_folders

public boolean move_empty_folders

arg_from_previous

public boolean arg_from_previous

include_subfolders

public boolean include_subfolders

add_result_filesname

public boolean add_result_filesname

destination_is_a_file

public boolean destination_is_a_file

create_destination_folder

public boolean create_destination_folder

source_filefolder

public String[] source_filefolder

destination_filefolder

public String[] destination_filefolder

wildcard

public String[] wildcard

SUCCESS_IF_AT_LEAST_X_FILES_UN_ZIPPED

public String SUCCESS_IF_AT_LEAST_X_FILES_UN_ZIPPED

SUCCESS_IF_ERRORS_LESS

public String SUCCESS_IF_ERRORS_LESS

SUCCESS_IF_NO_ERRORS

public String SUCCESS_IF_NO_ERRORS

create_move_to_folder

public boolean create_move_to_folder

simulate

public boolean simulate
Constructor Detail

JobEntryMoveFiles

public JobEntryMoveFiles(String n)

JobEntryMoveFiles

public JobEntryMoveFiles()
Method Detail

clone

public Object clone()
Description copied from class: JobEntryBase
This method is called when a job entry is duplicated in Spoon. It needs to return a deep copy of this job entry object. It is essential that the implementing class creates proper deep copies if the job entry configuration is stored in modifiable objects, such as lists or custom helper objects.

Specified by:
clone in interface JobEntryInterface
Overrides:
clone in class JobEntryBase
Returns:
a clone of the object

getXML

public String getXML()
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to serialize its settings to XML. It is called when saving a job in Spoon. The method returns an XML string, containing the serialized settings. The string contains a series of XML tags, typically one tag per setting. The helper class org.pentaho.di.core.xml.XMLHandler is typically used to construct the XML string.

Specified by:
getXML in interface JobEntryInterface
Overrides:
getXML in class JobEntryBase
Returns:
the xml representation of the job entry

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException
Description copied from interface: JobEntryInterface
This method is called by PDI whenever a job entry needs to read its settings from XML. The XML node containing the job entry�s settings is passed in as an argument. Again, the helper class org.pentaho.di.core.xml.XMLHandler is typically used to conveniently read the settings from the XML node.

Specified by:
loadXML in interface JobEntryInterface
Parameters:
entrynode - the top-level XML node
databases - the list of databases
slaveServers - the list of slave servers
rep - the repository object
Throws:
KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. For JobEntryBase, this method performs no operations.

Specified by:
loadRep in interface JobEntryInterface
Overrides:
loadRep in class JobEntryBase
Parameters:
rep - the repository object
id_jobentry - the id of the job entry
databases - the list of databases
slaveServers - the list of slave servers
Throws:
KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. For JobEntryBase, this method performs no operations

Specified by:
saveRep in interface JobEntryInterface
Overrides:
saveRep in class JobEntryBase
Parameters:
rep - the repository object
id_job - the id_job
Throws:
KettleException - if any errors occur during the save

execute

public Result execute(Result previousResult,
                      int nr)
               throws KettleException
Description copied from interface: JobEntryInterface
Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.

Specified by:
execute in interface JobEntryInterface
Parameters:
previousResult - the previous result
nr - the number of rows
Returns:
the Result object from execution of this job entry
Throws:
KettleException - if any Kettle exceptions occur

setAddDate

public void setAddDate(boolean adddate)

isAddDate

public boolean isAddDate()

isAddMovedDate

public boolean isAddMovedDate()

setAddMovedDate

public void setAddMovedDate(boolean add_moved_date)

isAddMovedTime

public boolean isAddMovedTime()

setAddMovedTime

public void setAddMovedTime(boolean add_moved_time)

setIfFileExists

public void setIfFileExists(String iffileexists)

getIfFileExists

public String getIfFileExists()

setIfMovedFileExists

public void setIfMovedFileExists(String ifmovedfileexists)

getIfMovedFileExists

public String getIfMovedFileExists()

setAddTime

public void setAddTime(boolean addtime)

isAddTime

public boolean isAddTime()

setAddDateBeforeExtension

public void setAddDateBeforeExtension(boolean AddDateBeforeExtension)

setAddMovedDateBeforeExtension

public void setAddMovedDateBeforeExtension(boolean AddMovedDateBeforeExtension)

isSpecifyFormat

public boolean isSpecifyFormat()

setSpecifyFormat

public void setSpecifyFormat(boolean SpecifyFormat)

setSpecifyMoveFormat

public void setSpecifyMoveFormat(boolean SpecifyMoveFormat)

isSpecifyMoveFormat

public boolean isSpecifyMoveFormat()

getDateTimeFormat

public String getDateTimeFormat()

setDateTimeFormat

public void setDateTimeFormat(String date_time_format)

getMovedDateTimeFormat

public String getMovedDateTimeFormat()

setMovedDateTimeFormat

public void setMovedDateTimeFormat(String moved_date_time_format)

isAddDateBeforeExtension

public boolean isAddDateBeforeExtension()

isAddMovedDateBeforeExtension

public boolean isAddMovedDateBeforeExtension()

isDoNotKeepFolderStructure

public boolean isDoNotKeepFolderStructure()

setDestinationFolder

public void setDestinationFolder(String destinationFolder)

getDestinationFolder

public String getDestinationFolder()

setDoNotKeepFolderStructure

public void setDoNotKeepFolderStructure(boolean DoNotKeepFolderStructure)

setMoveEmptyFolders

public void setMoveEmptyFolders(boolean move_empty_foldersin)

setIncludeSubfolders

public void setIncludeSubfolders(boolean include_subfoldersin)

setAddresultfilesname

public void setAddresultfilesname(boolean add_result_filesnamein)

setArgFromPrevious

public void setArgFromPrevious(boolean argfrompreviousin)

setDestinationIsAFile

public void setDestinationIsAFile(boolean destination_is_a_file)

setCreateDestinationFolder

public void setCreateDestinationFolder(boolean create_destination_folder)

setCreateMoveToFolder

public void setCreateMoveToFolder(boolean create_move_to_folder)

setNrErrorsLessThan

public void setNrErrorsLessThan(String nr_errors_less_than)

getNrErrorsLessThan

public String getNrErrorsLessThan()

setSimulate

public void setSimulate(boolean simulate)

setSuccessCondition

public void setSuccessCondition(String success_condition)

getSuccessCondition

public String getSuccessCondition()

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. For JobEntryBase, this method performs no operations.

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

evaluates

public boolean evaluates()
Description copied from class: JobEntryBase
This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:
evaluates in interface JobEntryInterface
Overrides:
evaluates in class JobEntryBase
Returns:
false