org.pentaho.di.job.entries.zipfile

类 JobEntryZipFile

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

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

所有已实现的接口:

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

从以下版本开始:

27-02-2007

作者:

Samatar Hassan

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	JobEntryZipFile.ZipJobEntryPatternFileSelector Helper class providing pattern restrictions for file names to be zipped

字段概要

字段

限定符和类型	字段和说明
int	afterZip
int	compressionRate
int	ifZipFileExists

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

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

构造器概要

构造器

构造器和说明
JobEntryZipFile()
JobEntryZipFile(String n) Default constructor.

方法概要

限定符和类型	方法和说明
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.
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	getStoredSourcePathDepth()
String	getWildcard()
String	getWildcardExclude()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
String	getZipFilename()
boolean	isAddFileToResult()
boolean	isCreateMoveToDirectory()
boolean	isDateInFilename()
boolean	isIncludingSubFolders()
boolean	isSpecifyFormat()
boolean	isTimeInFilename()
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.
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.
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.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.
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	setStoredSourcePathDepth(String storedSourcePathDepth)
void	setTimeInFilename(boolean addtime)
void	setWildcard(String wildcard)
void	setWildcardExclude(String wildcardexclude)
void	setZipFilename(String zipFilename)

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

字段详细资料

compressionRate

public int compressionRate

ifZipFileExists

public int ifZipFileExists

afterZip

public int afterZip

构造器详细资料

JobEntryZipFile

public JobEntryZipFile(String n)

Default constructor.

JobEntryZipFile

public JobEntryZipFile()

方法详细资料

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

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

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)

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

getFullFilename

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

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

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,
                  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

isIncludingSubFolders

public boolean isIncludingSubFolders()

返回:

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

setIncludingSubFolders

public void setIncludingSubFolders(boolean includesSubFolders)

参数:

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

getStoredSourcePathDepth

public String getStoredSourcePathDepth()

setStoredSourcePathDepth

public void setStoredSourcePathDepth(String storedSourcePathDepth)