org.pentaho.di.job.entries.waitforfile

类 JobEntryWaitForFile

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.waitforfile.JobEntryWaitForFile

所有已实现的接口:

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

This defines a 'wait for file' job entry. Its use is to wait for a file to appear.

从以下版本开始:

10-02-2007

作者:

Sven Boden

字段概要

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

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

构造器概要

构造器

构造器和说明
JobEntryWaitForFile()
JobEntryWaitForFile(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.
String	getCheckCycleTime()
String	getFilename() Gets the filename of the job entry.
String	getMaximumTimeout()
String	getRealCheckCycleTime()
String	getRealFilename() Gets the real filename of the job entry, by substituting any environment variables present in the filename.
String	getRealMaximumTimeout()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Gets a list of all the resource dependencies that the step is depending on.
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	isAddFilenameToResult()
boolean	isFileSizeCheck()
boolean	isSuccessOnTimeout()
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	setAddFilenameToResult(boolean addFilenameToResult)
void	setCheckCycleTime(String checkCycleTime)
void	setFilename(String filename)
void	setFileSizeCheck(boolean fileSizeCheck)
void	setMaximumTimeout(String maximumTimeout)
void	setSuccessOnTimeout(boolean successOnTimeout)

从类继承的方法 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, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getReferencedObjectDescriptions, getRegistrationDate, getRepository, getRepositoryDirectory, 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, getLogChannel, getName, getObjectId, getParentJob, getParentJobMeta, getPluginId, getReferencedObjectDescriptions, 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

构造器详细资料

JobEntryWaitForFile

public JobEntryWaitForFile(String n)

JobEntryWaitForFile

public JobEntryWaitForFile()

方法详细资料

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

setFilename

public void setFilename(String filename)

getFilename

public String getFilename()

从类复制的说明: JobEntryBase

Gets the filename of the job entry. For JobEntryBase, this method always returns null

指定者:

getFilename 在接口中 org.pentaho.di.core.logging.LoggingObjectInterface

指定者:

getFilename 在接口中 JobEntryInterface

覆盖:

getFilename 在类中 JobEntryBase

返回:

null

另请参阅:

LoggingObjectInterface.getFilename()

getRealFilename

public String getRealFilename()

从类复制的说明: JobEntryBase

Gets the real filename of the job entry, by substituting any environment variables present in the filename. For JobEntryBase, this method always returns null

指定者:

getRealFilename 在接口中 JobEntryInterface

覆盖:

getRealFilename 在类中 JobEntryBase

返回:

null

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

isSuccessOnTimeout

public boolean isSuccessOnTimeout()

setSuccessOnTimeout

public void setSuccessOnTimeout(boolean successOnTimeout)

getCheckCycleTime

public String getCheckCycleTime()

getRealCheckCycleTime

public String getRealCheckCycleTime()

setCheckCycleTime

public void setCheckCycleTime(String checkCycleTime)

getMaximumTimeout

public String getMaximumTimeout()

getRealMaximumTimeout

public String getRealMaximumTimeout()

setMaximumTimeout

public void setMaximumTimeout(String maximumTimeout)

isFileSizeCheck

public boolean isFileSizeCheck()

setFileSizeCheck

public void setFileSizeCheck(boolean fileSizeCheck)

isAddFilenameToResult

public boolean isAddFilenameToResult()

setAddFilenameToResult

public void setAddFilenameToResult(boolean addFilenameToResult)

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

从类复制的说明: JobEntryBase

Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.

指定者:

getResourceDependencies 在接口中 JobEntryInterface

覆盖:

getResourceDependencies 在类中 JobEntryBase

返回:

an empty list of ResourceReferences

另请参阅:

ResourceReference

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