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

java.lang.Object
  extended by org.pentaho.di.job.entry.JobEntryBase
      extended by org.pentaho.di.job.entries.special.JobEntrySpecial
All Implemented Interfaces:
Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntrySpecial
extends JobEntryBase
implements Cloneable, JobEntryInterface

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

Since:
05-11-2003
Author:
Matt

Field Summary
static int DAILY
           
static int INTERVAL
           
static int MONTHLY
           
static int NOSCHEDULING
           
static int WEEKLY
           
 
Constructor Summary
JobEntrySpecial()
           
JobEntrySpecial(String name, boolean start, boolean dummy)
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, JobMeta jobMeta)
          Support for overrides not having to put in a check method.
 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.
 Result execute(Result previousResult, int nr)
          Execute the job entry.
 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 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, ObjectId id_jobentry, List<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<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
          This method is called by PDI whenever a job entry needs to read its settings from XML.
 void saveRep(Repository rep, ObjectId id_job)
          This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
 void setDayOfMonth(int dayOfMonth)
           
 void setDummy(boolean dummy)
           
 void setHour(int hour)
           
 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)
           
 
Methods inherited from class org.pentaho.di.job.entry.JobEntryBase
clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getFilename, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getRegistrationDate, getRepository, getRepositoryDirectory, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, hasChanged, hasRepositoryReferences, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isEvaluation, isFTP, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isTransformation, listVariables, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, resetErrorsBeforeExecution, setChanged, setChanged, setContainerObjectId, setDescription, setID, setLogLevel, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface
clear, exportResources, getDescription, getDialogClassName, getFilename, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getResourceDependencies, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isEvaluation, isJob, isMail, isShell, isSpecial, isTransformation, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository
 

Field Detail

NOSCHEDULING

public static final int NOSCHEDULING
See Also:
Constant Field Values

INTERVAL

public static final int INTERVAL
See Also:
Constant Field Values

DAILY

public static final int DAILY
See Also:
Constant Field Values

WEEKLY

public static final int WEEKLY
See Also:
Constant Field Values

MONTHLY

public static final int MONTHLY
See Also:
Constant Field Values
Constructor Detail

JobEntrySpecial

public JobEntrySpecial()

JobEntrySpecial

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

clone

public Object clone()
Description copied from class: 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.

Specified by:
clone in interface JobEntryInterface
Overrides:
clone in class JobEntryBase
Returns:
a clone of the object

getXML

public String getXML()
Description copied from class: 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.

Specified by:
getXML in interface JobEntryInterface
Overrides:
getXML in class JobEntryBase
Returns:
the xml representation of the job entry

loadXML

public void loadXML(Node entrynode,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws KettleXMLException
Description copied from interface: 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.

Specified by:
loadXML in interface JobEntryInterface
Parameters:
entrynode - the top-level XML node
databases - the list of databases
slaveServers - the list of slave servers
rep - the repository object
Throws:
KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to read its configuration from a PDI repository. For JobEntryBase, this method performs no operations.

Specified by:
loadRep in interface JobEntryInterface
Overrides:
loadRep in class JobEntryBase
Parameters:
rep - the repository object
id_jobentry - the id of the job entry
databases - the list of databases
slaveServers - the list of slave servers
Throws:
KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException
Description copied from class: JobEntryBase
This method is called by PDI whenever a job entry needs to save its settings to a PDI repository. For JobEntryBase, this method performs no operations

Specified by:
saveRep in interface JobEntryInterface
Overrides:
saveRep in class JobEntryBase
Parameters:
rep - the repository object
id_job - the id_job
Throws:
KettleException - if any errors occur during the save

isStart

public boolean isStart()
Description copied from class: JobEntryBase
Checks if the job entry has started

Specified by:
isStart in interface JobEntryInterface
Overrides:
isStart in class JobEntryBase
Returns:
true if the job entry has started, false otherwise

isDummy

public boolean isDummy()
Description copied from class: JobEntryBase
Checks if the job entry is a dummy entry

Specified by:
isDummy in interface JobEntryInterface
Overrides:
isDummy in class JobEntryBase
Returns:
true if the job entry is a dummy entry, false otherwise

execute

public Result execute(Result previousResult,
                      int nr)
               throws KettleJobException
Description copied from interface: 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.

Specified by:
execute in interface JobEntryInterface
Parameters:
previousResult - the previous result
nr - the number of rows
Returns:
the Result object from execution of this job entry
Throws:
KettleJobException

evaluates

public boolean evaluates()
Description copied from class: JobEntryBase
This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

Specified by:
evaluates in interface JobEntryInterface
Overrides:
evaluates in class JobEntryBase
Returns:
false

isUnconditional

public boolean isUnconditional()
Description copied from class: JobEntryBase
This method must return true if the job entry supports the unconditional outgoing hop. For JobEntryBase, this method always returns true

Specified by:
isUnconditional in interface JobEntryInterface
Overrides:
isUnconditional in class JobEntryBase
Returns:
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)
Parameters:
dummy - the dummy to set

setStart

public void setStart(boolean start)
Parameters:
start - the start to set

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta)
Description copied from class: JobEntryBase
Support for overrides not having to put in a check method. For JobEntryBase, this method performs no operations.

Specified by:
check in interface JobEntryInterface
Overrides:
check in class JobEntryBase
Parameters:
remarks - CheckResults from checking the job entry
jobMeta - JobMeta information letting threading back to the JobMeta possible