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

java.lang.Object
  extended by org.pentaho.di.job.entry.JobEntryBase
      extended by org.pentaho.di.job.entries.setvariables.JobEntrySetVariables
All Implemented Interfaces:
Cloneable, CheckResultSourceInterface, LoggingObjectInterface, 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<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 evaluates()
          This method must return true if the job entry supports the true/false outgoing hops.
 Result execute(Result result, int nr)
          Execute the job entry.
 String getFilename()
          Gets the filename of the job entry.
 int getFileVariableType()
           
 List<ResourceReference> getResourceDependencies(JobMeta jobMeta)
          Gets 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()
          This method is called by PDI whenever a job entry needs to serialize its settings to XML.
 boolean isReplaceVars()
           
 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.
 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 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()
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

execute

public Result execute(Result result,
                      int nr)
               throws KettleException
Description copied from interface: JobEntryInterface
Execute the job entry. The previous result and number of rows are provided to the method for the purpose of chaining job entries, transformations, etc.

Specified by:
execute in interface JobEntryInterface
Parameters:
result - the previous result
nr - the number of rows
Returns:
the Result object from execution of this job entry
Throws:
KettleException - if any Kettle exceptions occur

setReplaceVars

public void setReplaceVars(boolean replaceVars)

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

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

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

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:
the filename
See Also:
LoggingObjectInterface.getFilename()

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