org.pentaho.di.job.entries.copyfiles

Class JobEntryCopyFiles

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.copyfiles.JobEntryCopyFiles

All Implemented Interfaces:

Cloneable, AttributesInterface, CheckResultSourceInterface, ExtensionDataInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryCopyFiles
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'copy files' job entry.

Since:

06-05-2007

Author:

Samatar Hassan

Field Summary

Fields

Modifier and Type	Field and Description
boolean	add_result_filesname
boolean	arg_from_previous
boolean	copy_empty_folders
boolean	create_destination_folder
static String	DEST_URL
static String	DESTINATION_CONFIGURATION_NAME
static String	DESTINATION_FILE_FOLDER
String[]	destination_filefolder
boolean	destination_is_a_file
boolean	include_subfolders
static String	LOCAL_DEST_FILE
static String	LOCAL_SOURCE_FILE
boolean	overwrite_files
boolean	remove_source_files
static String	SOURCE_CONFIGURATION_NAME
static String	SOURCE_FILE_FOLDER
String[]	source_filefolder
static String	SOURCE_URL
static String	STATIC_DEST_FILE
static String	STATIC_SOURCE_FILE
String[]	wildcard

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

attributesMap, containerObjectId, extensionDataMap, log, metaStore, parentJob, parentJobMeta, rep, variables

Constructor Summary

Constructors

Constructor and Description
JobEntryCopyFiles()
JobEntryCopyFiles(String n)

Method Summary

Modifier and Type	Method and Description
void	allocate(int nrFields)
void	check(List<CheckResultInterface> remarks, JobMeta jobMeta, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Allows JobEntry objects to check themselves for consistency
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	getConfigurationBy(String url)
String	getUrlPath(String incomingURL)
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	isAddresultfilesname()
boolean	isArgFromPrevious()
boolean	isCopyEmptyFolders()
boolean	isCreateDestinationFolder()
boolean	isDestinationIsAFile()
boolean	isIncludeSubfolders()
boolean	isoverwrite_files()
boolean	isRemoveSourceFiles()
protected String	loadDestination(Node fnode)
protected String	loadDestinationRep(Repository rep, ObjectId id_jobentry, int a)
void	loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, 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.
protected String	loadSource(Node fnode)
protected String	loadSourceRep(Repository rep, ObjectId id_jobentry, int a)
String	loadURL(String url, String ncName, org.pentaho.metastore.api.IMetaStore metastore, Map<String,String> mappings)
void	loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore) This method is called by PDI whenever a job entry needs to read its settings from XML.
protected void	saveDestination(StringBuilder retval, String destination)
protected void	saveDestinationRep(Repository rep, ObjectId id_job, ObjectId id_jobentry, int i, String value)
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_job) This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
protected void	saveSource(StringBuilder retval, String source)
protected void	saveSourceRep(Repository rep, ObjectId id_job, ObjectId id_jobentry, int i, String value)
void	setAddresultfilesname(boolean add_result_filesnamein)
void	setArgFromPrevious(boolean argfrompreviousin)
void	setConfigurationMappings(Map<String,String> mappings)
void	setCopyEmptyFolders(boolean copy_empty_foldersin)
void	setCreateDestinationFolder(boolean create_destination_folder)
void	setDestinationIsAFile(boolean destination_is_a_file)
void	setIncludeSubfolders(boolean include_subfoldersin)
void	setoverwrite_files(boolean overwrite_filesin)
void	setRemoveSourceFiles(boolean remove_source_filesin)

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

check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getExtensionDataMap, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getRealFilename, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, getResourceDependencies, getSQLStatements, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariables, hasChanged, hashCode, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, isUnconditional, listVariables, loadReferencedObject, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

check, clear, exportResources, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getParentJobMeta, getPluginId, getRealFilename, getReferencedObjectDescriptions, getResourceDependencies, getSQLStatements, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isReferencedObjectEnabled, isShell, isSpecial, isStart, isTransformation, isUnconditional, loadReferencedObject, loadReferencedObject, loadRep, loadXML, lookupRepositoryReferences, resetErrorsBeforeExecution, saveRep, setChanged, setChanged, setDescription, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setPluginId, setRepository

Field Detail

SOURCE_CONFIGURATION_NAME

public static final String SOURCE_CONFIGURATION_NAME

See Also:

Constant Field Values

SOURCE_FILE_FOLDER

public static final String SOURCE_FILE_FOLDER

See Also:

Constant Field Values

DESTINATION_CONFIGURATION_NAME

public static final String DESTINATION_CONFIGURATION_NAME

See Also:

Constant Field Values

DESTINATION_FILE_FOLDER

public static final String DESTINATION_FILE_FOLDER

See Also:

Constant Field Values

LOCAL_SOURCE_FILE

public static final String LOCAL_SOURCE_FILE

See Also:

Constant Field Values

LOCAL_DEST_FILE

public static final String LOCAL_DEST_FILE

See Also:

Constant Field Values

STATIC_SOURCE_FILE

public static final String STATIC_SOURCE_FILE

See Also:

Constant Field Values

STATIC_DEST_FILE

public static final String STATIC_DEST_FILE

See Also:

Constant Field Values

DEST_URL

public static final String DEST_URL

See Also:

Constant Field Values

SOURCE_URL

public static final String SOURCE_URL

See Also:

Constant Field Values

copy_empty_folders

public boolean copy_empty_folders

arg_from_previous

public boolean arg_from_previous

overwrite_files

public boolean overwrite_files

include_subfolders

public boolean include_subfolders

add_result_filesname

public boolean add_result_filesname

remove_source_files

public boolean remove_source_files

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

Constructor Detail

JobEntryCopyFiles

public JobEntryCopyFiles(String n)

JobEntryCopyFiles

public JobEntryCopyFiles()

Method Detail

allocate

public void allocate(int nrFields)

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,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             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

Overrides:

loadXML in class JobEntryBase

Parameters:

entrynode - the top-level XML node

databases - the list of databases

slaveServers - the list of slave servers

rep - the repository object

metaStore - The metaStore to optionally load from.

Throws:

KettleXMLException - if any errors occur during the loading of the XML

loadSource

protected String loadSource(Node fnode)

loadDestination

protected String loadDestination(Node fnode)

saveSource

protected void saveSource(StringBuilder retval,
                          String source)

saveDestination

protected void saveDestination(StringBuilder retval,
                               String destination)

loadSourceRep

protected String loadSourceRep(Repository rep,
                               ObjectId id_jobentry,
                               int a)
                        throws KettleException

Throws:

KettleException

loadDestinationRep

protected String loadDestinationRep(Repository rep,
                                    ObjectId id_jobentry,
                                    int a)
                             throws KettleException

Throws:

KettleException

saveSourceRep

protected void saveSourceRep(Repository rep,
                             ObjectId id_job,
                             ObjectId id_jobentry,
                             int i,
                             String value)
                      throws KettleException

Throws:

KettleException

saveDestinationRep

protected void saveDestinationRep(Repository rep,
                                  ObjectId id_job,
                                  ObjectId id_jobentry,
                                  int i,
                                  String value)
                           throws KettleException

Throws:

KettleException

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. The job entry id given in the arguments should be used as the identifier when using the repository's serialization methods.

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Parameters:

rep - the repository object

metaStore - the MetaStore to use

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,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_job)
             throws KettleException

Description copied from interface: JobEntryInterface

This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. The repository object passed in as the first argument provides a convenient set of methods for serializing job entry settings. When calling repository serialization methods, job id and job entry id are required. The job id is passed in to saveRep() as an argument, and the job entry id can be obtained by a call to getObjectId() inherited from the base class.

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Parameters:

rep - the repository

metaStore - the MetaStore to use

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

setCopyEmptyFolders

public void setCopyEmptyFolders(boolean copy_empty_foldersin)

isCopyEmptyFolders

public boolean isCopyEmptyFolders()

setoverwrite_files

public void setoverwrite_files(boolean overwrite_filesin)

isoverwrite_files

public boolean isoverwrite_files()

setIncludeSubfolders

public void setIncludeSubfolders(boolean include_subfoldersin)

isIncludeSubfolders

public boolean isIncludeSubfolders()

setAddresultfilesname

public void setAddresultfilesname(boolean add_result_filesnamein)

isAddresultfilesname

public boolean isAddresultfilesname()

setArgFromPrevious

public void setArgFromPrevious(boolean argfrompreviousin)

isArgFromPrevious

public boolean isArgFromPrevious()

setRemoveSourceFiles

public void setRemoveSourceFiles(boolean remove_source_filesin)

isRemoveSourceFiles

public boolean isRemoveSourceFiles()

setDestinationIsAFile

public void setDestinationIsAFile(boolean destination_is_a_file)

isDestinationIsAFile

public boolean isDestinationIsAFile()

setCreateDestinationFolder

public void setCreateDestinationFolder(boolean create_destination_folder)

isCreateDestinationFolder

public boolean isCreateDestinationFolder()

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from class: JobEntryBase

Allows JobEntry objects to check themselves for consistency

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:

remarks - List of CheckResult objects indicating consistency status

jobMeta - the metadata object for the job entry

space - the variable space to resolve string expressions with variables with

repository - the repository to load Kettle objects from

metaStore - the MetaStore to load common elements from

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

loadURL

public String loadURL(String url,
                      String ncName,
                      org.pentaho.metastore.api.IMetaStore metastore,
                      Map<String,String> mappings)

setConfigurationMappings

public void setConfigurationMappings(Map<String,String> mappings)

getConfigurationBy

public String getConfigurationBy(String url)

getUrlPath

public String getUrlPath(String incomingURL)