org.pentaho.di.job.entry
Interface JobEntryInterface

All Known Implementing Classes:

JobEntryAbort, JobEntryAddResultFilenames, JobEntryCheckDbConnections, JobEntryCheckFilesLocked, JobEntryColumnsExist, JobEntryConnectedToRepository, JobEntryCopyFiles, JobEntryCopyMoveResultFilenames, JobEntryCreateFile, JobEntryCreateFolder, JobEntryDelay, JobEntryDeleteFile, JobEntryDeleteFiles, JobEntryDeleteFolders, JobEntryDeleteResultFilenames, JobEntryDosToUnix, JobEntryDTDValidator, JobEntryEmpty, JobEntryEval, JobEntryEvalFilesMetrics, JobEntryEvalTableContent, JobEntryExportRepository, JobEntryFileCompare, JobEntryFileExists, JobEntryFilesExist, JobEntryFolderIsEmpty, JobEntryFoldersCompare, JobEntryFTP, JobEntryFTPDelete, JobEntryFTPPUT, JobEntryFTPSGet, JobEntryFTPSPUT, JobEntryGetPOP, JobEntryHTTP, JobEntryJob, JobEntryMail, JobEntryMailValidator, JobEntryMoveFiles, JobEntryMSAccessBulkLoad, JobEntryMsgBoxInfo, JobEntryMssqlBulkLoad, JobEntryMysqlBulkFile, JobEntryMysqlBulkLoad, JobEntryPGPDecryptFiles, JobEntryPGPEncryptFiles, JobEntryPGPVerify, JobEntryPing, JobEntrySetVariables, JobEntrySFTP, JobEntrySFTPPUT, JobEntryShell, JobEntrySimpleEval, JobEntrySNMPTrap, JobEntrySpecial, JobEntrySQL, JobEntrySSH2GET, JobEntrySSH2PUT, JobEntrySuccess, JobEntrySyslog, JobEntryTableExists, JobEntryTalendJobExec, JobEntryTrans, JobEntryTruncateTables, JobEntryUnZip, JobEntryWaitForFile, JobEntryWaitForSQL, JobEntryWebServiceAvailable, JobEntryWriteToFile, JobEntryWriteToLog, JobEntryXMLWellFormed, JobEntryXSDValidator, JobEntryXSLT, JobEntryZipFile

public interface JobEntryInterface

Interface for the different JobEntry classes.

Since:

18-06-04

Author:

Matt

Method Summary

void	check(List<CheckResultInterface> remarks, JobMeta jobMeta) Allows JobEntry objects to check themselves for consistency
void	clear()
Object	clone()
boolean	evaluates()
Result	execute(Result prev_result, int nr)
String	exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface namingInterface, Repository repository) Exports the object to a flat-file system, adding content with filename keys to a set of definitions.
String	getDescription()
String	getDialogClassName() Get the name of the class that implements the dialog for this job entry JobEntryBase provides a default
String	getFilename()
LogChannelInterface	getLogChannel()
String	getName()
ObjectId	getObjectId()
Job	getParentJob()
String	getPluginId()
String	getRealFilename()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Get a list of all the resource dependencies that the step is depending on.
List<SQLStatement>	getSQLStatements(Repository repository)
List<SQLStatement>	getSQLStatements(Repository repository, VariableSpace space)
String	getTypeId() Deprecated. in favor of getPluginId()
DatabaseMeta[]	getUsedDatabaseConnections() This method returns all the database connections that are used by the job entry.
String	getXML()
boolean	hasChanged()
boolean	hasRepositoryReferences()
boolean	isDummy()
boolean	isEvaluation()
boolean	isJob()
boolean	isMail()
boolean	isShell()
boolean	isSpecial()
boolean	isStart()
boolean	isTransformation()
boolean	isUnconditional()
void	loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)
void	loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
void	lookupRepositoryReferences(Repository repository) Look up the references after import
boolean	resetErrorsBeforeExecution()
void	saveRep(Repository rep, ObjectId id_job)
void	setChanged()
void	setChanged(boolean ch)
void	setDescription(String description)
void	setName(String name)
void	setObjectId(ObjectId id)
void	setParentJob(Job job)
void	setPluginId(String pluginId)
void	setRepository(Repository repository)

Method Detail

execute

Result execute(Result prev_result,
               int nr)
               throws KettleException

Throws:

KettleException

setParentJob

void setParentJob(Job job)

getParentJob

Job getParentJob()

getLogChannel

LogChannelInterface getLogChannel()

setRepository

void setRepository(Repository repository)

clear

void clear()

getObjectId

ObjectId getObjectId()

setObjectId

void setObjectId(ObjectId id)

getName

String getName()

setName

void setName(String name)

getTypeId

String getTypeId()

Deprecated. in favor of getPluginId()

getPluginId

String getPluginId()

setPluginId

void setPluginId(String pluginId)

getDescription

String getDescription()

setDescription

void setDescription(String description)

setChanged

void setChanged()

setChanged

void setChanged(boolean ch)

hasChanged

boolean hasChanged()

loadXML

void loadXML(Node entrynode,
             List<DatabaseMeta> databases,
             List<SlaveServer> slaveServers,
             Repository rep)
             throws KettleXMLException

Throws:

KettleXMLException

getXML

String getXML()

saveRep

void saveRep(Repository rep,
             ObjectId id_job)
             throws KettleException

Throws:

KettleException

loadRep

void loadRep(Repository rep,
             ObjectId id_jobentry,
             List<DatabaseMeta> databases,
             List<SlaveServer> slaveServers)
             throws KettleException

Throws:

KettleException

isStart

boolean isStart()

isDummy

boolean isDummy()

clone

Object clone()

resetErrorsBeforeExecution

boolean resetErrorsBeforeExecution()

evaluates

boolean evaluates()

isUnconditional

boolean isUnconditional()

isEvaluation

boolean isEvaluation()

isTransformation

boolean isTransformation()

isJob

boolean isJob()

isShell

boolean isShell()

isMail

boolean isMail()

isSpecial

boolean isSpecial()

getSQLStatements

List<SQLStatement> getSQLStatements(Repository repository)
                                    throws KettleException

Throws:

KettleException

getSQLStatements

List<SQLStatement> getSQLStatements(Repository repository,
                                    VariableSpace space)
                                    throws KettleException

Throws:

KettleException

getDialogClassName

String getDialogClassName()

Get the name of the class that implements the dialog for this job entry JobEntryBase provides a default

getFilename

String getFilename()

getRealFilename

String getRealFilename()

getUsedDatabaseConnections

DatabaseMeta[] getUsedDatabaseConnections()

This method returns all the database connections that are used by the job entry.

Returns:

an array of database connections meta-data. Return an empty array if no connections are used.

check

void check(List<CheckResultInterface> remarks,
           JobMeta jobMeta)

Allows JobEntry objects to check themselves for consistency

Parameters:

remarks - List of CheckResult objects indicating check status

jobMeta - JobMeta

getResourceDependencies

List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

Get a list of all the resource dependencies that the step is depending on.

Returns:

a list of all the resource dependencies that the step is depending on

exportResources

String exportResources(VariableSpace space,
                       Map<String,ResourceDefinition> definitions,
                       ResourceNamingInterface namingInterface,
                       Repository repository)
                       throws KettleException

Exports the object to a flat-file system, adding content with filename keys to a set of definitions. The supplied resource naming interface allows the object to name appropriately without worrying about those parts of the implementation specific details.

Parameters:

space - The variable space to resolve (environment) variables with.

definitions - The map containing the filenames and content

namingInterface - The resource naming interface allows the object to name appropriately

repository - The repository to load resources from

Returns:

The filename for this object. (also contained in the definitions map)

Throws:

KettleException - in case something goes wrong during the export

hasRepositoryReferences

boolean hasRepositoryReferences()

Returns:

True if the job entry defines one or more references to a repository object.

lookupRepositoryReferences

void lookupRepositoryReferences(Repository repository)
                                throws KettleException

Look up the references after import

Parameters:

repository - the repository to reference.

Throws:

KettleException