org.pentaho.di.job.entries.setvariables

类 JobEntrySetVariables

java.lang.Object

org.pentaho.di.job.entry.JobEntryBase

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

所有已实现的接口:

Cloneable, org.pentaho.di.core.AttributesInterface, org.pentaho.di.core.CheckResultSourceInterface, org.pentaho.di.core.ExtensionDataInterface, 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.

从以下版本开始:

06-05-2007

作者:

Samatar Hassan

字段概要

字段

限定符和类型	字段和说明
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
static String[]	variableTypeCode
String[]	variableValue

从类继承的字段 org.pentaho.di.job.entry.JobEntryBase

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

构造器概要

构造器

构造器和说明
JobEntrySetVariables()
JobEntrySetVariables(String n)

方法概要

限定符和类型	方法和说明
void	allocate(int nrFields)
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, JobMeta jobMeta, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Allows JobEntry objects to check themselves for consistency
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.
org.pentaho.di.core.Result	execute(org.pentaho.di.core.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, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_jobentry, List<org.pentaho.di.core.database.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<org.pentaho.di.core.database.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	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.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)

从类继承的方法 org.pentaho.di.job.entry.JobEntryBase

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

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.pentaho.di.job.entry.JobEntryInterface

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

字段详细资料

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

另请参阅:

常量字段值

VARIABLE_TYPE_CURRENT_JOB

public static final int VARIABLE_TYPE_CURRENT_JOB

另请参阅:

常量字段值

VARIABLE_TYPE_PARENT_JOB

public static final int VARIABLE_TYPE_PARENT_JOB

另请参阅:

常量字段值

VARIABLE_TYPE_ROOT_JOB

public static final int VARIABLE_TYPE_ROOT_JOB

另请参阅:

常量字段值

variableTypeCode

public static final String[] variableTypeCode

构造器详细资料

JobEntrySetVariables

public JobEntrySetVariables(String n)

JobEntrySetVariables

public JobEntrySetVariables()

方法详细资料

allocate

public void allocate(int nrFields)

clone

public Object clone()

从类复制的说明: 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.

指定者:

clone 在接口中 JobEntryInterface

覆盖:

clone 在类中 JobEntryBase

返回:

a clone of the object

getXML

public String getXML()

从类复制的说明: 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.

指定者:

getXML 在接口中 JobEntryInterface

覆盖:

getXML 在类中 JobEntryBase

返回:

the xml representation of the job entry

loadXML

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

从接口复制的说明: 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.

指定者:

loadXML 在接口中 JobEntryInterface

覆盖:

loadXML 在类中 JobEntryBase

参数:

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.

抛出:

org.pentaho.di.core.exception.KettleXMLException - if any errors occur during the loading of the XML

loadRep

public void loadRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    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

从接口复制的说明: 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.

指定者:

loadRep 在接口中 JobEntryInterface

覆盖:

loadRep 在类中 JobEntryBase

参数:

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

抛出:

org.pentaho.di.core.exception.KettleException - if any errors occur during the load

saveRep

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

从接口复制的说明: 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.

指定者:

saveRep 在接口中 JobEntryInterface

覆盖:

saveRep 在类中 JobEntryBase

参数:

rep - the repository

metaStore - the MetaStore to use

id_job - the id_job

抛出:

org.pentaho.di.core.exception.KettleException - if any errors occur during the save

execute

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

从接口复制的说明: 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.

指定者:

execute 在接口中 JobEntryInterface

参数:

result - the previous result

nr - the number of rows

返回:

the Result object from execution of this job entry

抛出:

org.pentaho.di.core.exception.KettleException - if any Kettle exceptions occur

setReplaceVars

public void setReplaceVars(boolean replaceVars)

evaluates

public boolean evaluates()

从类复制的说明: JobEntryBase

This method must return true if the job entry supports the true/false outgoing hops. For JobEntryBase, this method always returns false

指定者:

evaluates 在接口中 JobEntryInterface

覆盖:

evaluates 在类中 JobEntryBase

返回:

false

isReplaceVars

public boolean isReplaceVars()

getVariableValue

public String[] getVariableValue()

setVariableName

public void setVariableName(String[] fieldValue)

参数:

fieldValue - The fieldValue to set.

getVariableType

public int[] getVariableType()

返回:

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

getVariableTypeCode

public static final String getVariableTypeCode(int variableType)

参数:

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

返回:

the variable type code for this variable type

getVariableTypeDescription

public static final String getVariableTypeDescription(int variableType)

参数:

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

返回:

the variable type description for this variable type

getVariableType

public static final int getVariableType(String variableType)

参数:

variableType - The code or description of the variable type

返回:

The variable type

setVariableType

public void setVariableType(int[] localVariable)

参数:

localVariable - The localVariable to set.

getVariableTypeDescriptions

public static final String[] getVariableTypeDescriptions()

check

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

从类复制的说明: JobEntryBase

Allows JobEntry objects to check themselves for consistency

指定者:

check 在接口中 JobEntryInterface

覆盖:

check 在类中 JobEntryBase

参数:

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)

从类复制的说明: 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.

指定者:

getResourceDependencies 在接口中 JobEntryInterface

覆盖:

getResourceDependencies 在类中 JobEntryBase

返回:

an empty list of ResourceReferences

另请参阅:

ResourceReference

getFilename

public String getFilename()

从类复制的说明: JobEntryBase

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

指定者:

getFilename 在接口中 org.pentaho.di.core.logging.LoggingObjectInterface

指定者:

getFilename 在接口中 JobEntryInterface

覆盖:

getFilename 在类中 JobEntryBase

返回:

the filename

另请参阅:

LoggingObjectInterface.getFilename()

setFilename

public void setFilename(String filename)

参数:

filename - the filename to set

getFileVariableType

public int getFileVariableType()

返回:

the fileVariableType

setFileVariableType

public void setFileVariableType(int fileVariableType)

参数:

fileVariableType - the fileVariableType to set