org.pentaho.di.job.entries.special

类 JobEntrySpecial

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.special.JobEntrySpecial

所有已实现的接口:

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

直接已知子类:

MissingEntry

public class JobEntrySpecial
extends JobEntryBase
implements Cloneable, JobEntryInterface

This class can contain a few special job entries such as Start and Dummy.

从以下版本开始:

05-11-2003

作者:

Matt

字段概要

字段

限定符和类型	字段和说明
static int	CRON
static int	DAILY
static int	INTERVAL
static int	MONTHLY
static int	NOSCHEDULING
static int	WEEKLY

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

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

构造器概要

构造器

构造器和说明
JobEntrySpecial()
JobEntrySpecial(String name, boolean start, boolean dummy)

方法概要

限定符和类型	方法和说明
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	getCron()
int	getDayOfMonth()
int	getHour()
int	getIntervalMinutes()
int	getIntervalSeconds()
int	getMinutes()
int	getSchedulerType()
int	getWeekDay()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	isDummy() Checks if the job entry is a dummy entry
boolean	isInitStart()
boolean	isRepeat()
boolean	isStart() Checks if the job entry has started
boolean	isUnconditional() This method must return true if the job entry supports the unconditional outgoing hop.
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	setCron(String cron)
void	setDayOfMonth(int dayOfMonth)
void	setDummy(boolean dummy)
void	setHour(int hour)
void	setInitStart(boolean initStart)
void	setIntervalMinutes(int intervalMinutes)
void	setIntervalSeconds(int intervalSeconds)
void	setMinutes(int minutes)
void	setRepeat(boolean repeat)
void	setSchedulerType(int schedulerType)
void	setStart(boolean start)
void	setWeekDay(int weekDay)

从类继承的方法 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, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isReferencedObjectEnabled, isRowlevel, isSFTP, isShell, isSpecial, isTransformation, 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, isEvaluation, isJob, isMail, isReferencedObjectEnabled, isShell, isSpecial, isTransformation, loadReferencedObject, loadReferencedObject, loadRep, loadXML, lookupRepositoryReferences, resetErrorsBeforeExecution, saveRep, setChanged, setChanged, setDescription, setMetaStore, setName, setObjectId, setParentJob, setParentJobMeta, setPluginId, setRepository

字段详细资料

NOSCHEDULING

public static final int NOSCHEDULING

另请参阅:

常量字段值

INTERVAL

public static final int INTERVAL

另请参阅:

常量字段值

DAILY

public static final int DAILY

另请参阅:

常量字段值

WEEKLY

public static final int WEEKLY

另请参阅:

常量字段值

MONTHLY

public static final int MONTHLY

另请参阅:

常量字段值

CRON

public static final int CRON

另请参阅:

常量字段值

构造器详细资料

JobEntrySpecial

public JobEntrySpecial()

JobEntrySpecial

public JobEntrySpecial(String name,
                       boolean start,
                       boolean dummy)

方法详细资料

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

isStart

public boolean isStart()

从类复制的说明: JobEntryBase

Checks if the job entry has started

指定者:

isStart 在接口中 JobEntryInterface

覆盖:

isStart 在类中 JobEntryBase

返回:

true if the job entry has started, false otherwise

isDummy

public boolean isDummy()

从类复制的说明: JobEntryBase

Checks if the job entry is a dummy entry

指定者:

isDummy 在接口中 JobEntryInterface

覆盖:

isDummy 在类中 JobEntryBase

返回:

true if the job entry is a dummy entry, false otherwise

execute

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

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

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

isUnconditional

public boolean isUnconditional()

从类复制的说明: JobEntryBase

This method must return true if the job entry supports the unconditional outgoing hop. For JobEntryBase, this method always returns true

指定者:

isUnconditional 在接口中 JobEntryInterface

覆盖:

isUnconditional 在类中 JobEntryBase

返回:

true

getSchedulerType

public int getSchedulerType()

getHour

public int getHour()

getMinutes

public int getMinutes()

getWeekDay

public int getWeekDay()

getDayOfMonth

public int getDayOfMonth()

setDayOfMonth

public void setDayOfMonth(int dayOfMonth)

setHour

public void setHour(int hour)

setMinutes

public void setMinutes(int minutes)

setWeekDay

public void setWeekDay(int weekDay)

setSchedulerType

public void setSchedulerType(int schedulerType)

isRepeat

public boolean isRepeat()

setRepeat

public void setRepeat(boolean repeat)

getIntervalSeconds

public int getIntervalSeconds()

setIntervalSeconds

public void setIntervalSeconds(int intervalSeconds)

getIntervalMinutes

public int getIntervalMinutes()

setIntervalMinutes

public void setIntervalMinutes(int intervalMinutes)

setDummy

public void setDummy(boolean dummy)

参数:

dummy - the dummy to set

setStart

public void setStart(boolean start)

参数:

start - the start to set

isInitStart

public boolean isInitStart()

返回:

initStart

setInitStart

public void setInitStart(boolean initStart)

参数:

initStart - the initStart to set

getCron

public String getCron()

返回:

cron

setCron

public void setCron(String cron)

参数:

cron - the cron to set

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