org.pentaho.di.job.entries.unzip

类 JobEntryUnZip

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.unzip.JobEntryUnZip

所有已实现的接口:

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

This defines a 'unzip' job entry. Its main use would be to unzip files in a directory

从以下版本开始:

25-09-2007

作者:

Samatar Hassan

字段概要

字段

限定符和类型	字段和说明
int	afterunzip
static int	IF_FILE_EXISTS_FAIL
static int	IF_FILE_EXISTS_OVERWRITE
static int	IF_FILE_EXISTS_OVERWRITE_DIFF_SIZE
static int	IF_FILE_EXISTS_OVERWRITE_EQUAL_SIZE
static int	IF_FILE_EXISTS_OVERWRITE_ZIP_BIG
static int	IF_FILE_EXISTS_OVERWRITE_ZIP_BIG_EQUAL
static int	IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL
static int	IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL_EQUAL
static int	IF_FILE_EXISTS_SKIP
static int	IF_FILE_EXISTS_UNIQ
String	SUCCESS_IF_AT_LEAST_X_FILES_UN_ZIPPED
String	SUCCESS_IF_ERRORS_LESS
String	SUCCESS_IF_NO_ERRORS
static String[]	typeIfFileExistsCode
static String[]	typeIfFileExistsDesc

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

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

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
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	getDatafromprevious()
String	getDateTimeFormat()
int	getIfFileExist()
static String	getIfFileExistsCode(int i)
static int	getIfFileExistsInt(String desc)
String	getLimit()
String	getMoveToDirectory()
String	getSourceDirectory()
String	getSuccessCondition()
protected String	getTargetFilename(org.apache.commons.vfs2.FileObject file)
String	getWildcard()
String	getWildcardExclude()
String	getWildcardSource()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
String	getZipFilename()
boolean	isAddFileToResult()
boolean	isCreateFolder()
boolean	isCreateMoveToDirectory()
boolean	isCreateRootFolder()
boolean	isDateInFilename()
boolean	isOriginalModificationDate()
boolean	isOriginalTimestamp()
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.
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	setAddOriginalTimestamp(boolean addOriginalTimestamp)
void	setCreateFolder(boolean createfolder)
void	setCreateMoveToDirectory(boolean createMoveToDirectory)
void	setCreateRootFolder(boolean rootzip)
void	setDatafromprevious(boolean isfromprevious)
void	setDateInFilename(boolean adddate)
void	setDateTimeFormat(String date_time_format)
void	setIfFileExists(int iffileexist)
void	setLimit(String nr_limitin)
void	setMoveToDirectory(String movetodirectory)
void	setOriginalModificationDate(boolean setOriginalModificationDate)
void	setSourceDirectory(String targetdirectoryin)
void	setSpecifyFormat(boolean SpecifyFormat)
void	setSuccessCondition(String success_condition)
void	setTimeInFilename(boolean addtime)
void	setWildcard(String wildcard)
void	setWildcardExclude(String wildcardexclude)
void	setWildcardSource(String wildcardSource)
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

字段详细资料

afterunzip

public int afterunzip

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

IF_FILE_EXISTS_SKIP

public static final int IF_FILE_EXISTS_SKIP

另请参阅:

常量字段值

IF_FILE_EXISTS_OVERWRITE

public static final int IF_FILE_EXISTS_OVERWRITE

另请参阅:

常量字段值

IF_FILE_EXISTS_UNIQ

public static final int IF_FILE_EXISTS_UNIQ

另请参阅:

常量字段值

IF_FILE_EXISTS_FAIL

public static final int IF_FILE_EXISTS_FAIL

另请参阅:

常量字段值

IF_FILE_EXISTS_OVERWRITE_DIFF_SIZE

public static final int IF_FILE_EXISTS_OVERWRITE_DIFF_SIZE

另请参阅:

常量字段值

IF_FILE_EXISTS_OVERWRITE_EQUAL_SIZE

public static final int IF_FILE_EXISTS_OVERWRITE_EQUAL_SIZE

另请参阅:

常量字段值

IF_FILE_EXISTS_OVERWRITE_ZIP_BIG

public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_BIG

另请参阅:

常量字段值

IF_FILE_EXISTS_OVERWRITE_ZIP_BIG_EQUAL

public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_BIG_EQUAL

另请参阅:

常量字段值

IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL

public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL

另请参阅:

常量字段值

IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL_EQUAL

public static final int IF_FILE_EXISTS_OVERWRITE_ZIP_SMALL_EQUAL

另请参阅:

常量字段值

typeIfFileExistsCode

public static final String[] typeIfFileExistsCode

typeIfFileExistsDesc

public static final String[] typeIfFileExistsDesc

构造器详细资料

JobEntryUnZip

public JobEntryUnZip(String n)

JobEntryUnZip

public JobEntryUnZip()

方法详细资料

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

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

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

getIfFileExistsInt

public static final int getIfFileExistsInt(String desc)

getIfFileExistsCode

public static final String getIfFileExistsCode(int i)

getIfFileExist

public int getIfFileExist()

返回:

Returns the iffileexist.

setIfFileExists

public void setIfFileExists(int iffileexist)

参数:

setIfFileExist - The iffileexist to set.

isCreateMoveToDirectory

public boolean isCreateMoveToDirectory()

setCreateMoveToDirectory

public void setCreateMoveToDirectory(boolean createMoveToDirectory)

setZipFilename

public void setZipFilename(String zipFilename)

setWildcard

public void setWildcard(String wildcard)

setWildcardExclude

public void setWildcardExclude(String wildcardexclude)

setSourceDirectory

public void setSourceDirectory(String targetdirectoryin)

setMoveToDirectory

public void setMoveToDirectory(String movetodirectory)

getSourceDirectory

public String getSourceDirectory()

getMoveToDirectory

public String getMoveToDirectory()

getZipFilename

public String getZipFilename()

getWildcardSource

public String getWildcardSource()

setWildcardSource

public void setWildcardSource(String wildcardSource)

getWildcard

public String getWildcard()

getWildcardExclude

public String getWildcardExclude()

setAddFileToResult

public void setAddFileToResult(boolean addfiletoresultin)

isAddFileToResult

public boolean isAddFileToResult()

setDateInFilename

public void setDateInFilename(boolean adddate)

setAddOriginalTimestamp

public void setAddOriginalTimestamp(boolean addOriginalTimestamp)

isOriginalTimestamp

public boolean isOriginalTimestamp()

setOriginalModificationDate

public void setOriginalModificationDate(boolean setOriginalModificationDate)

isOriginalModificationDate

public boolean isOriginalModificationDate()

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)

setDatafromprevious

public void setDatafromprevious(boolean isfromprevious)

getDatafromprevious

public boolean getDatafromprevious()

setCreateRootFolder

public void setCreateRootFolder(boolean rootzip)

isCreateRootFolder

public boolean isCreateRootFolder()

setCreateFolder

public void setCreateFolder(boolean createfolder)

isCreateFolder

public boolean isCreateFolder()

setLimit

public void setLimit(String nr_limitin)

getLimit

public String getLimit()

setSuccessCondition

public void setSuccessCondition(String success_condition)

getSuccessCondition

public String getSuccessCondition()

getTargetFilename

protected String getTargetFilename(org.apache.commons.vfs2.FileObject file)
                            throws org.apache.commons.vfs2.FileSystemException

参数:

string - the filename from

返回:

the calculated target filename

抛出:

org.apache.commons.vfs2.FileSystemException

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