org.pentaho.di.job.entries.copyfiles

类 JobEntryCopyFiles

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

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

所有已实现的接口:

Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryCopyFiles
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'copy files' job entry.

从以下版本开始:

06-05-2007

作者:

Samatar Hassan

字段概要

字段

限定符和类型	字段和说明
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

从类继承的字段 org.pentaho.di.job.entry.JobEntryBase

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

构造器概要

构造器

构造器和说明
JobEntryCopyFiles()
JobEntryCopyFiles(String n)

方法概要

限定符和类型	方法和说明
void	allocate(int nrFields)
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.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.
org.pentaho.di.core.Result	execute(org.pentaho.di.core.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, org.pentaho.di.repository.ObjectId id_jobentry, int a)
void	loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.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, org.pentaho.di.repository.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<org.pentaho.di.core.database.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, org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.ObjectId id_jobentry, int i, String value)
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.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, org.pentaho.di.repository.ObjectId id_job, org.pentaho.di.repository.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)

从类继承的方法 org.pentaho.di.job.entry.JobEntryBase

check, clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getEntryStepSetVariable, getEntryStepSetVariablesMap, 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, setEntryStepSetVariable, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

从类继承的方法 java.lang.Object

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

从接口继承的方法 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

字段详细资料

SOURCE_CONFIGURATION_NAME

public static final String SOURCE_CONFIGURATION_NAME

另请参阅:

常量字段值

SOURCE_FILE_FOLDER

public static final String SOURCE_FILE_FOLDER

另请参阅:

常量字段值

DESTINATION_CONFIGURATION_NAME

public static final String DESTINATION_CONFIGURATION_NAME

另请参阅:

常量字段值

DESTINATION_FILE_FOLDER

public static final String DESTINATION_FILE_FOLDER

另请参阅:

常量字段值

LOCAL_SOURCE_FILE

public static final String LOCAL_SOURCE_FILE

另请参阅:

常量字段值

LOCAL_DEST_FILE

public static final String LOCAL_DEST_FILE

另请参阅:

常量字段值

STATIC_SOURCE_FILE

public static final String STATIC_SOURCE_FILE

另请参阅:

常量字段值

STATIC_DEST_FILE

public static final String STATIC_DEST_FILE

另请参阅:

常量字段值

DEST_URL

public static final String DEST_URL

另请参阅:

常量字段值

SOURCE_URL

public static final String SOURCE_URL

另请参阅:

常量字段值

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

构造器详细资料

JobEntryCopyFiles

public JobEntryCopyFiles(String n)

JobEntryCopyFiles

public JobEntryCopyFiles()

方法详细资料

allocate

public void allocate(int nrFields)

clone

public Object clone()

从类复制的说明: 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.

指定者:

clone 在接口中 JobEntryInterface

覆盖:

clone 在类中 JobEntryBase

返回:

a clone of the object

getXML

public String getXML()

从类复制的说明: 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.

指定者:

getXML 在接口中 JobEntryInterface

覆盖:

getXML 在类中 JobEntryBase

返回:

the xml representation of the job entry

loadXML

public void loadXML(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.KettleXMLException

从接口复制的说明: 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.

指定者:

loadXML 在接口中 JobEntryInterface

覆盖:

loadXML 在类中 JobEntryBase

参数:

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.

抛出:

org.pentaho.di.core.exception.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,
                               org.pentaho.di.repository.ObjectId id_jobentry,
                               int a)
                        throws org.pentaho.di.core.exception.KettleException

抛出:

org.pentaho.di.core.exception.KettleException

loadDestinationRep

protected String loadDestinationRep(Repository rep,
                                    org.pentaho.di.repository.ObjectId id_jobentry,
                                    int a)
                             throws org.pentaho.di.core.exception.KettleException

抛出:

org.pentaho.di.core.exception.KettleException

saveSourceRep

protected void saveSourceRep(Repository rep,
                             org.pentaho.di.repository.ObjectId id_job,
                             org.pentaho.di.repository.ObjectId id_jobentry,
                             int i,
                             String value)
                      throws org.pentaho.di.core.exception.KettleException

抛出:

org.pentaho.di.core.exception.KettleException

saveDestinationRep

protected void saveDestinationRep(Repository rep,
                                  org.pentaho.di.repository.ObjectId id_job,
                                  org.pentaho.di.repository.ObjectId id_jobentry,
                                  int i,
                                  String value)
                           throws org.pentaho.di.core.exception.KettleException

抛出:

org.pentaho.di.core.exception.KettleException

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    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

从接口复制的说明: 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.

指定者:

loadRep 在接口中 JobEntryInterface

覆盖:

loadRep 在类中 JobEntryBase

参数:

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

抛出:

org.pentaho.di.core.exception.KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException

从接口复制的说明: 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.

指定者:

saveRep 在接口中 JobEntryInterface

覆盖:

saveRep 在类中 JobEntryBase

参数:

rep - the repository

metaStore - the MetaStore to use

id_job - the id_job

抛出:

org.pentaho.di.core.exception.KettleException - if any errors occur during the save

execute

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

从接口复制的说明: 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.

指定者:

execute 在接口中 JobEntryInterface

参数:

previousResult - the previous result

nr - the number of rows

返回:

the Result object from execution of this job entry

抛出:

org.pentaho.di.core.exception.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<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  org.pentaho.di.core.variables.VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

从类复制的说明: JobEntryBase

Allows JobEntry objects to check themselves for consistency

指定者:

check 在接口中 JobEntryInterface

覆盖:

check 在类中 JobEntryBase

参数:

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

从类复制的说明: JobEntryBase

This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

指定者:

evaluates 在接口中 JobEntryInterface

覆盖:

evaluates 在类中 JobEntryBase

返回:

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)