JobEntryBase

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.pentaho.di.job.entry
Class JobEntryBase

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase

All Implemented Interfaces:: Cloneable, CheckResultSourceInterface, LoggingObjectInterface, VariableSpace, ResourceHolderInterface

Direct Known Subclasses:: 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 class JobEntryBase
extends Object
implements Cloneable, VariableSpace, CheckResultSourceInterface, ResourceHolderInterface, LoggingObjectInterface
extends Object
implements Cloneable, VariableSpace, CheckResultSourceInterface, ResourceHolderInterface, LoggingObjectInterface

Base class for the different types of job-entries...

Author:: Matt Created on 18-jun-04

Constructor Summary
`JobEntryBase()`
`JobEntryBase(String name, String description)`

Method Summary
`void`	`check(List<CheckResultInterface> remarks, JobMeta jobMeta)` Support for overrides not having to put in a check method
`void`	`clear()`
`Object`	`clone()`
`void`	`copyVariablesFrom(VariableSpace space)` Copy the variables from another space, without initializing with the defaults.
`String`	`environmentSubstitute(String aString)` Substitute the string using the current variable space.
`String[]`	`environmentSubstitute(String[] aString)` Replaces environment variables in an array of strings.
`boolean`	`equals(Object obj)`
`boolean`	`evaluates()` check whether or not this job entry evaluates.
`String`	`exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface namingInterface, Repository repository)`
`boolean`	`getBooleanValueOfVariable(String variableName, boolean defaultValue)` This method returns a boolean for the new variable check boxes.
`String`	`getContainerObjectId()`
`String`	`getDescription()`
`String`	`getDialogClassName()` This returns the expected name for the dialog that edits a job entry.
`String`	`getFilename()`
`String`	`getHolderType()` Gets the high-level type of resource holder.
`LogChannelInterface`	`getLogChannel()`
`String`	`getLogChannelId()`
`LogLevel`	`getLogLevel()`
`String`	`getName()`
`String`	`getObjectCopy()`
`ObjectId`	`getObjectId()`
`String`	`getObjectName()`
`ObjectRevision`	`getObjectRevision()`
`LoggingObjectType`	`getObjectType()`
`LoggingObjectInterface`	`getParent()`
`Job`	`getParentJob()`
`VariableSpace`	`getParentVariableSpace()` Get the parent of the variable space.
`String`	`getPluginId()`
`String`	`getRealFilename()`
`Date`	`getRegistrationDate()` Stub
`Repository`	`getRepository()`
`RepositoryDirectory`	`getRepositoryDirectory()`
`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`	`getTypeDesc()`
`String`	`getTypeId()` Deprecated. in favor of getPluginId()
`DatabaseMeta[]`	`getUsedDatabaseConnections()` This method returns all the database connections that are used by the job entry.
`String`	`getVariable(String variableName)` Get the value of a variable.
`String`	`getVariable(String variableName, String defaultValue)` Get the value of a variable with a default in case the variable is not found.
`String`	`getXML()`
`boolean`	`hasChanged()`
`boolean`	`hasRepositoryReferences()`
`void`	`initializeVariablesFrom(VariableSpace parent)` Initialize variable space using the defaults, copy over the variables from the parent (using copyVariablesFrom()), after this the "injected" variables should be inserted (injectVariables()).
`void`	`injectVariables(Map<String,String> prop)` Inject variables.
`boolean`	`isBasic()`
`boolean`	`isDebug()`
`boolean`	`isDetailed()`
`boolean`	`isDummy()`
`boolean`	`isEvaluation()`
`boolean`	`isFTP()`
`boolean`	`isHTTP()`
`boolean`	`isJob()`
`boolean`	`isMail()`
`boolean`	`isRowlevel()`
`boolean`	`isSFTP()`
`boolean`	`isShell()`
`boolean`	`isSpecial()`
`boolean`	`isStart()`
`boolean`	`isTransformation()`
`boolean`	`isUnconditional()`
`String[]`	`listVariables()` List the variables (not the values) that are currently in the variable space.
`void`	`loadRep(Repository rep, ObjectId id_jobentry, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)`
`void`	`loadXML(Node entrynode, List<DatabaseMeta> databases, List<SlaveServer> slaveServers)`
`void`	`logBasic(String message)`
`void`	`logBasic(String message, Object... arguments)`
`void`	`logDebug(String message)`
`void`	`logDebug(String message, Object... arguments)`
`void`	`logDetailed(String message)`
`void`	`logDetailed(String message, Object... arguments)`
`void`	`logError(String message)`
`void`	`logError(String message, Object... arguments)`
`void`	`logError(String message, Throwable e)`
`void`	`logMinimal(String message)`
`void`	`logMinimal(String message, Object... arguments)`
`void`	`logRowlevel(String message)`
`void`	`logRowlevel(String message, Object... arguments)`
`void`	`lookupRepositoryReferences(Repository repository)` Look up the references after import
`void`	`parseRepositoryObjects(Repository rep)`
`boolean`	`resetErrorsBeforeExecution()`
`void`	`saveRep(Repository rep, ObjectId id_job)`
`void`	`setChanged()`
`void`	`setChanged(boolean ch)`
`void`	`setContainerObjectId(String containerObjectId)`
`void`	`setDescription(String Description)`
`void`	`setID(long id)`
`void`	`setLogLevel(LogLevel logLevel)`
`void`	`setName(String name)`
`void`	`setObjectId(ObjectId id)`
`void`	`setParentJob(Job parentJob)`
`void`	`setParentVariableSpace(VariableSpace parent)` Set the parent variable space
`void`	`setPluginId(String configId)`
`void`	`setRepository(Repository repository)`
`void`	`setTypeId(String typeId)` Deprecated. in favor of setPluginId()
`void`	`setVariable(String variableName, String variableValue)` Sets a variable in the Kettle Variables list.
`void`	`shareVariablesWith(VariableSpace space)` Share a variable space from another variable space.
`String`	`toString()`

Methods inherited from class java.lang.Object
`getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

JobEntryBase

public JobEntryBase()

JobEntryBase

public JobEntryBase(String name,
                    String description)

Method Detail

equals

public boolean equals(Object obj)

Overrides:: equals in class Object

clear

public void clear()

setObjectId

public void setObjectId(ObjectId id)

setID

public void setID(long id)

getObjectId

public ObjectId getObjectId()

Specified by:: getObjectId in interface CheckResultSourceInterface
Specified by:: getObjectId in interface LoggingObjectInterface
Specified by:: getObjectId in interface ResourceHolderInterface

Returns:: The ID of the source generating the CheckResult

getTypeDesc

public String getTypeDesc()

setName

public void setName(String name)

getName

public String getName()

Specified by:: getName in interface CheckResultSourceInterface
Specified by:: getName in interface ResourceHolderInterface

Returns:: The name of the source generating the CheckResult

setDescription

public void setDescription(String Description)

getDescription

public String getDescription()

Specified by:: getDescription in interface CheckResultSourceInterface
Specified by:: getDescription in interface ResourceHolderInterface

Returns:: The description of the source generating the CheckResult

setChanged

public void setChanged()

setChanged

public void setChanged(boolean ch)

hasChanged

public boolean hasChanged()

isStart

public boolean isStart()

isDummy

public boolean isDummy()

isEvaluation

public boolean isEvaluation()

isJob

public boolean isJob()

isMail

public boolean isMail()

isShell

public boolean isShell()

isSpecial

public boolean isSpecial()

isTransformation

public boolean isTransformation()

isFTP

public boolean isFTP()

isSFTP

public boolean isSFTP()

isHTTP

public boolean isHTTP()

getXML

public String getXML()

loadXML

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

Throws:: KettleXMLException

parseRepositoryObjects

public void parseRepositoryObjects(Repository rep)
                            throws KettleException

Throws:: KettleException

loadRep

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

Throws:: KettleException

saveRep

public void saveRep(Repository rep,
                    ObjectId id_job)
             throws KettleException

Throws:: KettleException

clone

public Object clone()

Overrides:: clone in class Object

toString

public String toString()

Overrides:: toString in class Object

resetErrorsBeforeExecution

public boolean resetErrorsBeforeExecution()

Returns:: true if a reset of the number of errors is required before execution.

evaluates

public boolean evaluates()

check whether or not this job entry evaluates.

Returns:: true if the job entry evaluates

isUnconditional

public boolean isUnconditional()

getSQLStatements

public List<SQLStatement> getSQLStatements(Repository repository)
                                    throws KettleException

Throws:: KettleException

getSQLStatements

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

Throws:: KettleException

getFilename

public String getFilename()

Specified by:: getFilename in interface LoggingObjectInterface

Returns:: the filename

getRealFilename

public String getRealFilename()

getUsedDatabaseConnections

public 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.