org.pentaho.di.job.entries.setvariables
Class JobEntrySetVariables

java.lang.Object
  org.pentaho.di.job.entry.JobEntryBase
      org.pentaho.di.job.entries.setvariables.JobEntrySetVariables

All Implemented Interfaces:

Cloneable, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, JobEntryInterface, ResourceHolderInterface

public class JobEntrySetVariables
extends JobEntryBase
implements Cloneable, JobEntryInterface

This defines a 'Set variables' job entry.

Since:

06-05-2007

Author:

Samatar Hassan

Field Summary

String	filename
int	fileVariableType
boolean	replaceVars
static int	VARIABLE_TYPE_CURRENT_JOB
static int	VARIABLE_TYPE_JVM
static int	VARIABLE_TYPE_PARENT_JOB
static int	VARIABLE_TYPE_ROOT_JOB
String[]	variableName
int[]	variableType
String[]	variableValue

Constructor Summary

JobEntrySetVariables()

JobEntrySetVariables(String n)

Method Summary

void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta) Support for overrides not having to put in a check method
Object	clone()
boolean	evaluates() check whether or not this job entry evaluates.
org.pentaho.di.core.Result	execute(org.pentaho.di.core.Result result, int nr)
String	getFilename()
int	getFileVariableType()
List<ResourceReference>	getResourceDependencies(JobMeta jobMeta) Get a list of all the resource dependencies that the step is depending on.
int[]	getVariableType()
static int	getVariableType(String variableType)
static String	getVariableTypeCode(int variableType)
static String	getVariableTypeDescription(int variableType)
static String[]	getVariableTypeDescriptions()
String[]	getVariableValue()
String	getXML()
boolean	isReplaceVars()
void	loadRep(Repository rep, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers)
void	loadXML(Node entrynode, List<org.pentaho.di.core.database.DatabaseMeta> databases, List<SlaveServer> slaveServers, Repository rep)
void	saveRep(Repository rep, org.pentaho.di.repository.ObjectId id_job)
void	setFilename(String filename)
void	setFileVariableType(int fileVariableType)
void	setReplaceVars(boolean replaceVars)
void	setVariableName(String[] fieldValue)
void	setVariableType(int[] localVariable)

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

clear, copyVariablesFrom, environmentSubstitute, environmentSubstitute, equals, exportResources, getBooleanValueOfVariable, getContainerObjectId, getDescription, getDialogClassName, getHolderType, getLogChannel, getLogChannelId, getLogLevel, getName, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getParent, getParentJob, getParentVariableSpace, getPluginId, getRealFilename, getRegistrationDate, getRepository, getRepositoryDirectory, 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, isUnconditional, 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, getLogChannel, getName, getObjectId, getParentJob, getPluginId, getRealFilename, getSQLStatements, getSQLStatements, getTypeId, getUsedDatabaseConnections, hasChanged, hasRepositoryReferences, isDummy, isEvaluation, isJob, isMail, isShell, isSpecial, isStart, isTransformation, isUnconditional, lookupRepositoryReferences, resetErrorsBeforeExecution, setChanged, setChanged, setDescription, setName, setObjectId, setParentJob, setPluginId, setRepository

Field Detail

replaceVars

public boolean replaceVars

variableName

public String[] variableName

variableValue

public String[] variableValue

variableType

public int[] variableType

filename

public String filename

fileVariableType

public int fileVariableType

VARIABLE_TYPE_JVM

public static final int VARIABLE_TYPE_JVM

See Also:

Constant Field Values

VARIABLE_TYPE_CURRENT_JOB

public static final int VARIABLE_TYPE_CURRENT_JOB

See Also:

Constant Field Values

VARIABLE_TYPE_PARENT_JOB

public static final int VARIABLE_TYPE_PARENT_JOB

See Also:

Constant Field Values

VARIABLE_TYPE_ROOT_JOB

public static final int VARIABLE_TYPE_ROOT_JOB

See Also:

Constant Field Values

Constructor Detail

JobEntrySetVariables

public JobEntrySetVariables(String n)

JobEntrySetVariables

public JobEntrySetVariables()

Method Detail

clone

public Object clone()

Specified by:

clone in interface JobEntryInterface

Overrides:

clone in class JobEntryBase

getXML

public String getXML()

Specified by:

getXML in interface JobEntryInterface

Overrides:

getXML in class JobEntryBase

loadXML

public void loadXML(Node entrynode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers,
                    Repository rep)
             throws org.pentaho.di.core.exception.KettleXMLException

Specified by:

loadXML in interface JobEntryInterface

Throws:

org.pentaho.di.core.exception.KettleXMLException

loadRep

public void loadRep(Repository rep,
                    org.pentaho.di.repository.ObjectId id_jobentry,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    List<SlaveServer> slaveServers)
             throws org.pentaho.di.core.exception.KettleException

Specified by:

loadRep in interface JobEntryInterface

Overrides:

loadRep in class JobEntryBase

Throws:

org.pentaho.di.core.exception.KettleException

saveRep

public void saveRep(Repository rep,
                    org.pentaho.di.repository.ObjectId id_job)
             throws org.pentaho.di.core.exception.KettleException

Specified by:

saveRep in interface JobEntryInterface

Overrides:

saveRep in class JobEntryBase

Throws:

org.pentaho.di.core.exception.KettleException

execute

public org.pentaho.di.core.Result execute(org.pentaho.di.core.Result result,
                                          int nr)
                                   throws org.pentaho.di.core.exception.KettleException

Specified by:

execute in interface JobEntryInterface

Throws:

org.pentaho.di.core.exception.KettleException

setReplaceVars

public void setReplaceVars(boolean replaceVars)

evaluates

public boolean evaluates()

Description copied from class: JobEntryBase

check whether or not this job entry evaluates.

Specified by:

evaluates in interface JobEntryInterface

Overrides:

evaluates in class JobEntryBase

Returns:

true if the job entry evaluates

isReplaceVars

public boolean isReplaceVars()

getVariableValue

public String[] getVariableValue()

setVariableName

public void setVariableName(String[] fieldValue)

Parameters:

fieldValue - The fieldValue to set.

getVariableType

public int[] getVariableType()

Returns:

Returns the local variable flag: true if this variable is only valid in the parents job.

getVariableTypeCode

public static final String getVariableTypeCode(int variableType)

Parameters:

variableType - The variable type, see also VARIABLE_TYPE_...

Returns:

the variable type code for this variable type

getVariableTypeDescription

public static final String getVariableTypeDescription(int variableType)

Parameters:

variableType - The variable type, see also VARIABLE_TYPE_...

Returns:

the variable type description for this variable type

getVariableType

public static final int getVariableType(String variableType)

Parameters:

variableType - The code or description of the variable type

Returns:

The variable type

setVariableType

public void setVariableType(int[] localVariable)

Parameters:

localVariable - The localVariable to set.

getVariableTypeDescriptions

public static final String[] getVariableTypeDescriptions()

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  JobMeta jobMeta)

Description copied from class: JobEntryBase

Support for overrides not having to put in a check method

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

getResourceDependencies

public List<ResourceReference> getResourceDependencies(JobMeta jobMeta)

Description copied from class: JobEntryBase

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

Specified by:

getResourceDependencies in interface JobEntryInterface

Overrides:

getResourceDependencies in class JobEntryBase

Returns:

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

getFilename

public String getFilename()

Specified by:

getFilename in interface org.pentaho.di.core.logging.LoggingObjectInterface

Specified by:

getFilename in interface JobEntryInterface

Overrides:

getFilename in class JobEntryBase

Returns:

the filename

setFilename

public void setFilename(String filename)

Parameters:

filename - the filename to set

getFileVariableType

public int getFileVariableType()

Returns:

the fileVariableType

setFileVariableType

public void setFileVariableType(int fileVariableType)

Parameters:

fileVariableType - the fileVariableType to set