org.pentaho.di.job.entries.writetolog
Class JobEntryWriteToLog

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.writetolog.JobEntryWriteToLog

All Implemented Interfaces:

Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntryWriteToLog
extends JobEntryBase
implements Cloneable, JobEntryInterface

Job entry type to output message to the job log.

Since:

08-08-2007

Author:

Samatar

Field Summary

LogLevel

entryLogLevel

Constructor Summary

JobEntryWriteToLog()

JobEntryWriteToLog(String n)

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	evaluate(Result result) Output message to job log.
boolean	evaluates() This method must return true if the job entry supports the true/false outgoing hops.
Result	execute(Result prev_result, int nr) Execute this job entry and return the result.
String	getLogMessage()
String	getLogSubject()
String	getRealLogMessage()
String	getRealLogSubject()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
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.
boolean	resetErrorsBeforeExecution() Checks whether a reset of the number of errors is required before execution.
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	setLogMessage(String s)
void	setLogSubject(String logsubjectin)

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, isDummy, isEvaluation, isFTP, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, listVariables, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, parseRepositoryObjects, 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, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, lookupRepositoryReferences, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository

Field Detail

entryLogLevel

public LogLevel entryLogLevel

Constructor Detail

JobEntryWriteToLog

public JobEntryWriteToLog(String n)

JobEntryWriteToLog

public JobEntryWriteToLog()

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

evaluate

public boolean evaluate(Result result)

Output message to job log.

execute

public Result execute(Result prev_result,
                      int nr)

Execute this job entry and return the result. In this case it means, just set the result boolean in the Result class.

Specified by:

execute in interface JobEntryInterface

Parameters:

prev_result - The result of the previous execution

nr - the number of rows

Returns:

The Result of the execution.

resetErrorsBeforeExecution

public boolean resetErrorsBeforeExecution()

Description copied from class: JobEntryBase

Checks whether a reset of the number of errors is required before execution.

Specified by:

resetErrorsBeforeExecution in interface JobEntryInterface

Overrides:

resetErrorsBeforeExecution in class JobEntryBase

Returns:

true if a reset of the number of errors is required before execution, false otherwise

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

getRealLogMessage

public String getRealLogMessage()

getRealLogSubject

public String getRealLogSubject()

getLogMessage

public String getLogMessage()

getLogSubject

public String getLogSubject()

setLogMessage

public void setLogMessage(String s)

setLogSubject

public void setLogSubject(String logsubjectin)

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