org.pentaho.di.job.entries.trans

Class JobEntryTrans

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

org.pentaho.di.job.entries.trans.JobEntryTrans

All Implemented Interfaces:

Cloneable, AttributesInterface, CheckResultSourceInterface, ExtensionDataInterface, LoggingObjectInterface, VariableSpace, JobEntryInterface, JobEntryRunConfigurableInterface, HasRepositoryDirectories, ResourceHolderInterface

public class JobEntryTrans
extends JobEntryBase
implements Cloneable, JobEntryInterface, HasRepositoryDirectories, JobEntryRunConfigurableInterface

This is the job entry that defines a transformation to be run.

Since:

1-Oct-2003, rewritten on 18-June-2004

Author:

Matt Casters

Field Summary

Fields

Modifier and Type	Field and Description
boolean	addDate
boolean	addTime
boolean	argFromPrevious
String[]	arguments
boolean	clearResultFiles
boolean	clearResultRows
boolean	createParentFolder
boolean	execPerRow
boolean	followingAbortRemotely
String	logext
String	logfile
LogLevel	logFileLevel
String[]	parameterFieldNames
String[]	parameters
String[]	parameterValues
boolean	paramsFromPrevious
boolean	setAppendLogfile
boolean	setLogfile
boolean	waitingToFinish

Fields inherited from class org.pentaho.di.job.entry.JobEntryBase

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

Constructor Summary

Constructors

Constructor and Description
JobEntryTrans()
JobEntryTrans(String name)

Method Summary

Modifier and Type	Method and Description
void	check(List<CheckResultInterface> remarks, JobMeta jobMeta, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Allows JobEntry objects to check themselves for consistency
void	clear() Clears all variable values
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 result, int nr) Execute this job entry and return the result.
String	exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface namingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) We're going to load the transformation meta data referenced here.
String[]	getDirectories() If step has reference(s) to another transformation(s)/job(s) returns an array of repository directories.
String	getDirectory()
String	getDirectoryPath()
String	getFilename() Gets the filename of the job entry.
String	getFileName() Deprecated. use getFilename() instead
protected String	getLogfile()
String	getLogFilename()
String	getRealFilename() Gets the real filename of the job entry, by substituting any environment variables present in the filename.
String[]	getReferencedObjectDescriptions()
String	getRemoteSlaveServerName()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Gets a list of all the resource dependencies that the step is depending on.
String	getRunConfiguration()
ObjectLocationSpecificationMethod	getSpecificationMethod()
ObjectLocationSpecificationMethod[]	getSpecificationMethods() If step has reference(s) to another transformation(s)/job(s) returns an array of specification method(s) defining the type of an access to a referenced file.
List<SQLStatement>	getSQLStatements(Repository repository, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space) Gets the SQL statements needed by this job entry to execute successfully, given a set of variables.
Trans	getTrans()
TransMeta	getTransMeta(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space)
TransMeta	getTransMeta(Repository rep, VariableSpace space) Deprecated. use getTransMeta(Repository, IMetaStore, VariableSpace)
String	getTransname()
ObjectId	getTransObjectId()
String	getXML() This method is called by PDI whenever a job entry needs to serialize its settings to XML.
boolean	hasRepositoryReferences() Checks whether the job entry has repository references.
boolean	isClustering()
boolean	isFollowingAbortRemotely()
boolean	isLoggingRemoteWork()
boolean	isPassingAllParameters()
boolean[]	isReferencedObjectEnabled()
boolean	isUnconditional() This method must return true if the job entry supports the unconditional outgoing hop.
boolean	isWaitingToFinish()
Object	loadReferencedObject(int index, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space) Load the referenced object
void	loadRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, 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, org.pentaho.metastore.api.IMetaStore metaStore) This method is called by PDI whenever a job entry needs to read its settings from XML.
void	lookupRepositoryReferences(Repository repository) Look up the references after import
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_job) This method is called by PDI whenever a job entry needs to save its settings to a PDI repository.
void	setClustering(boolean clustering)
void	setDirectories(String[] directories) If step has reference(s) to another transformation(s)/job(s) sets updated repository directories from incoming String array.
void	setDirectory(String directory)
void	setDirectoryPath(String directoryPath)
void	setFileName(String n)
void	setFollowingAbortRemotely(boolean followingAbortRemotely)
void	setLoggingRemoteWork(boolean loggingRemoteWork)
void	setParentJobMeta(JobMeta parentJobMeta) At save and run time, the system will attempt to set the jobMeta so that it can be accessed by the jobEntries if necessary.
void	setPassingAllParameters(boolean passingAllParameters)
void	setRemoteSlaveServerName(String remoteSlaveServerName)
void	setRunConfiguration(String runConfiguration)
void	setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
void	setTransname(String transname)
void	setTransObjectId(ObjectId transObjectId)
void	setWaitingToFinish(boolean waitingToFinish)

Methods inherited from class org.pentaho.di.job.entry.JobEntryBase

check, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, fieldSubstitute, getAttribute, getAttributes, getAttributesMap, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getExtensionDataMap, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getMetaStore, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentJobMeta, getParentVariableSpace, getPluginId, getRegistrationDate, getRepository, getRepositoryDirectory, getSQLStatements, getSQLStatements, getTypeDesc, getTypeId, getUsedDatabaseConnections, getVariable, getVariable, getVariables, hasChanged, hashCode, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDummy, isEvaluation, isForcingSeparateLogging, isFTP, isGatheringMetrics, isHTTP, isJob, isMail, isRowlevel, isSFTP, isShell, isSpecial, isStart, isTransformation, listVariables, loadReferencedObject, loadRep, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, parseRepositoryObjects, resetErrorsBeforeExecution, saveRep, setAttribute, setAttributes, setAttributesMap, setChanged, setChanged, setContainerObjectId, setDescription, setForcingSeparateLogging, setGatheringMetrics, setID, setLogLevel, setMetaStore, setName, setObjectId, setParentJob, setParentVariableSpace, setPluginId, setRepository, setTypeId, setVariable, shareVariablesWith, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.job.entry.JobEntryInterface

check, exportResources, getDescription, getDialogClassName, getLogChannel, getName, getObjectId, getParentJob, getParentJobMeta, getPluginId, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, loadReferencedObject, loadRep, loadXML, resetErrorsBeforeExecution, saveRep, setChanged, setChanged, setDescription, setMetaStore, setName, setObjectId, setParentJob, setPluginId, setRepository

Methods inherited from interface org.pentaho.di.job.entry.JobEntryRunConfigurableInterface

setChanged

Field Detail

arguments

public String[] arguments

argFromPrevious

public boolean argFromPrevious

paramsFromPrevious

public boolean paramsFromPrevious

execPerRow

public boolean execPerRow

parameters

public String[] parameters

parameterFieldNames

public String[] parameterFieldNames

parameterValues

public String[] parameterValues

clearResultRows

public boolean clearResultRows

clearResultFiles

public boolean clearResultFiles

createParentFolder

public boolean createParentFolder

setLogfile

public boolean setLogfile

setAppendLogfile

public boolean setAppendLogfile

logfile

public String logfile

logext

public String logext

addDate

public boolean addDate

addTime

public boolean addTime

logFileLevel

public LogLevel logFileLevel

waitingToFinish

public boolean waitingToFinish

followingAbortRemotely

public boolean followingAbortRemotely

Constructor Detail

JobEntryTrans

public JobEntryTrans(String name)

JobEntryTrans

public JobEntryTrans()

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

setFileName

public void setFileName(String n)

getFileName

@Deprecated
public String getFileName()

Deprecated. use getFilename() instead

Returns:

the filename

getFilename

public String getFilename()

Description copied from class: JobEntryBase

Gets the filename of the job entry. For JobEntryBase, this method always returns null

Specified by:

getFilename in interface LoggingObjectInterface

Specified by:

getFilename in interface JobEntryInterface

Overrides:

getFilename in class JobEntryBase

Returns:

null

See Also:

LoggingObjectInterface.getFilename()

getRealFilename

public String getRealFilename()

Description copied from class: JobEntryBase

Gets the real filename of the job entry, by substituting any environment variables present in the filename. For JobEntryBase, this method always returns null

Specified by:

getRealFilename in interface JobEntryInterface

Overrides:

getRealFilename in class JobEntryBase

Returns:

null

setTransname

public void setTransname(String transname)

getTransname

public String getTransname()

getDirectory

public String getDirectory()

setDirectory

public void setDirectory(String directory)

getDirectories

public String[] getDirectories()

Description copied from interface: HasRepositoryDirectories

If step has reference(s) to another transformation(s)/job(s) returns an array of repository directories. An implementation is considered to define the array order itself.

Specified by:

getDirectories in interface HasRepositoryDirectories

Returns:

String array of repository directories

setDirectories

public void setDirectories(String[] directories)

Description copied from interface: HasRepositoryDirectories

If step has reference(s) to another transformation(s)/job(s) sets updated repository directories from incoming String array. An implementation is considered to define the array order itself.

Specified by:

setDirectories in interface HasRepositoryDirectories

Parameters:

directories - Array of updated rep directories to set

getLogFilename

public String getLogFilename()

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,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             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

Overrides:

loadXML in class JobEntryBase

Parameters:

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.

Throws:

KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_jobentry,
                    List<DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws KettleException

Description copied from interface: 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.

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Parameters:

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

Throws:

KettleException - if any errors occur during the load

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_job)
             throws KettleException

Description copied from interface: 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.

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Parameters:

rep - the repository

metaStore - the MetaStore to use

id_job - the id_job

Throws:

KettleException - if any errors occur during the save

clear

public void clear()

Description copied from class: JobEntryBase

Clears all variable values

Specified by:

clear in interface JobEntryInterface

Overrides:

clear in class JobEntryBase

execute

public Result execute(Result result,
                      int nr)
               throws KettleException

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:

result - The result of the previous execution

nr - the job entry number

Returns:

The Result of the execution.

Throws:

KettleException - if any Kettle exceptions occur

getTransMeta

@Deprecated
public TransMeta getTransMeta(Repository rep,
                                          VariableSpace space)
                                   throws KettleException

Deprecated. use getTransMeta(Repository, IMetaStore, VariableSpace)

Parameters:

rep -

space -

Returns:

Throws:

KettleException

getTransMeta

public TransMeta getTransMeta(Repository rep,
                              org.pentaho.metastore.api.IMetaStore metaStore,
                              VariableSpace space)
                       throws KettleException

Throws:

KettleException

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

getSQLStatements

public List<SQLStatement> getSQLStatements(Repository repository,
                                           org.pentaho.metastore.api.IMetaStore metaStore,
                                           VariableSpace space)
                                    throws KettleException

Description copied from class: JobEntryBase

Gets the SQL statements needed by this job entry to execute successfully, given a set of variables. For JobEntryBase, this method returns an empty list.

Specified by:

getSQLStatements in interface JobEntryInterface

Overrides:

getSQLStatements in class JobEntryBase

Parameters:

repository - the repository object

metaStore - the MetaStore to use

space - a variable space object containing variable bindings

Returns:

an empty list

Throws:

KettleException - if any errors occur during the generation of SQL statements

getDirectoryPath

public String getDirectoryPath()

Returns:

Returns the directoryPath.

setDirectoryPath

public void setDirectoryPath(String directoryPath)

Parameters:

directoryPath - The directoryPath to set.

isClustering

public boolean isClustering()

Returns:

the clustering

setClustering

public void setClustering(boolean clustering)

Parameters:

clustering - the clustering to set

check

public void check(List<CheckResultInterface> remarks,
                  JobMeta jobMeta,
                  VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from class: JobEntryBase

Allows JobEntry objects to check themselves for consistency

Specified by:

check in interface JobEntryInterface

Overrides:

check in class JobEntryBase

Parameters:

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

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

Description copied from class: JobEntryBase

Gets a list of all the resource dependencies that the step is depending on. In JobEntryBase, this method returns an empty resource dependency list.

Specified by:

getResourceDependencies in interface JobEntryInterface

Overrides:

getResourceDependencies in class JobEntryBase

Returns:

an empty list of ResourceReferences

See Also:

ResourceReference

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface namingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws KettleException

We're going to load the transformation meta data referenced here. Then we're going to give it a new filename, modify that filename in this entries. The parent caller will have made a copy of it, so it should be OK to do so.

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.

Specified by:

exportResources in interface JobEntryInterface

Overrides:

exportResources in class JobEntryBase

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 be named appropriately

repository - The repository to load resources from

metaStore - the metaStore to load external metadata from

Returns:

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

Throws:

KettleException - in case something goes wrong during the export

getLogfile

protected String getLogfile()

getRemoteSlaveServerName

public String getRemoteSlaveServerName()

Returns:

the remote slave server name

setRemoteSlaveServerName

public void setRemoteSlaveServerName(String remoteSlaveServerName)

Specified by:

setRemoteSlaveServerName in interface JobEntryRunConfigurableInterface

Parameters:

remoteSlaveServerName - the remote slave server name to set

isWaitingToFinish

public boolean isWaitingToFinish()

Returns:

the waitingToFinish

setWaitingToFinish

public void setWaitingToFinish(boolean waitingToFinish)

Parameters:

waitingToFinish - the waitingToFinish to set

isFollowingAbortRemotely

public boolean isFollowingAbortRemotely()

Returns:

the followingAbortRemotely

setFollowingAbortRemotely

public void setFollowingAbortRemotely(boolean followingAbortRemotely)

Parameters:

followingAbortRemotely - the followingAbortRemotely to set

isLoggingRemoteWork

public boolean isLoggingRemoteWork()

setLoggingRemoteWork

public void setLoggingRemoteWork(boolean loggingRemoteWork)

Specified by:

setLoggingRemoteWork in interface JobEntryRunConfigurableInterface

isPassingAllParameters

public boolean isPassingAllParameters()

Returns:

the passingAllParameters

setPassingAllParameters

public void setPassingAllParameters(boolean passingAllParameters)

Parameters:

passingAllParameters - the passingAllParameters to set

getRunConfiguration

public String getRunConfiguration()

Specified by:

getRunConfiguration in interface JobEntryRunConfigurableInterface

setRunConfiguration

public void setRunConfiguration(String runConfiguration)

Specified by:

setRunConfiguration in interface JobEntryRunConfigurableInterface

getTrans

public Trans getTrans()

getTransObjectId

public ObjectId getTransObjectId()

Returns:

the transObjectId

setTransObjectId

public void setTransObjectId(ObjectId transObjectId)

Parameters:

transObjectId - the transObjectId to set

getSpecificationMethod

public ObjectLocationSpecificationMethod getSpecificationMethod()

Returns:

the specificationMethod

getSpecificationMethods

public ObjectLocationSpecificationMethod[] getSpecificationMethods()

Description copied from interface: HasRepositoryDirectories

If step has reference(s) to another transformation(s)/job(s) returns an array of specification method(s) defining the type of an access to a referenced file. An implementation is considered to define the array order itself.

Specified by:

getSpecificationMethods in interface HasRepositoryDirectories

Returns:

String array of specification method(s)

setSpecificationMethod

public void setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)

Parameters:

specificationMethod - the specificationMethod to set

hasRepositoryReferences

public boolean hasRepositoryReferences()

Description copied from class: JobEntryBase

Checks whether the job entry has repository references. For JobEntryBase, this method always returns false

Specified by:

hasRepositoryReferences in interface JobEntryInterface

Overrides:

hasRepositoryReferences in class JobEntryBase

Returns:

false

lookupRepositoryReferences

public void lookupRepositoryReferences(Repository repository)
                                throws KettleException

Look up the references after import

Specified by:

lookupRepositoryReferences in interface JobEntryInterface

Overrides:

lookupRepositoryReferences in class JobEntryBase

Parameters:

repository - the repository to reference.

Throws:

KettleException - if any errors occur during the lookup

getReferencedObjectDescriptions

public String[] getReferencedObjectDescriptions()

Specified by:

getReferencedObjectDescriptions in interface JobEntryInterface

Overrides:

getReferencedObjectDescriptions in class JobEntryBase

Returns:

The objects referenced in the step, like a a transformation, a job, a mapper, a reducer, a combiner, ...

isReferencedObjectEnabled

public boolean[] isReferencedObjectEnabled()

Specified by:

isReferencedObjectEnabled in interface JobEntryInterface

Overrides:

isReferencedObjectEnabled in class JobEntryBase

Returns:

true for each referenced object that is enabled or has a valid reference definition.

loadReferencedObject

public Object loadReferencedObject(int index,
                                   Repository rep,
                                   org.pentaho.metastore.api.IMetaStore metaStore,
                                   VariableSpace space)
                            throws KettleException

Load the referenced object

Specified by:

loadReferencedObject in interface JobEntryInterface

Overrides:

loadReferencedObject in class JobEntryBase

Parameters:

index - the referenced object index to load (in case there are multiple references)

rep - the repository

metaStore - metaStore

space - the variable space to use

Returns:

the referenced object once loaded

Throws:

KettleException

setParentJobMeta

public void setParentJobMeta(JobMeta parentJobMeta)

Description copied from class: JobEntryBase

At save and run time, the system will attempt to set the jobMeta so that it can be accessed by the jobEntries if necessary.

Specified by:

setParentJobMeta in interface JobEntryInterface

Overrides:

setParentJobMeta in class JobEntryBase

Parameters:

parentJobMeta - the JobMeta to which this JobEntryInterface belongs