Package org.pentaho.di.trans.steps.setvariable

Class SetVariableMeta

java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.steps.setvariable.SetVariableMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface
public class SetVariableMeta extends BaseStepMeta implements StepMetaInterface
Sets environment variables based on content in certain fields of a single input row. Created on 27-apr-2006

  • Field Details

    • VARIABLE_TYPE_JVM

      public static final int VARIABLE_TYPE_JVM
      See Also:

    • VARIABLE_TYPE_PARENT_JOB

      public static final int VARIABLE_TYPE_PARENT_JOB
      See Also:

    • VARIABLE_TYPE_GRAND_PARENT_JOB

      public static final int VARIABLE_TYPE_GRAND_PARENT_JOB
      See Also:

    • VARIABLE_TYPE_ROOT_JOB

      public static final int VARIABLE_TYPE_ROOT_JOB
      See Also:

  • Constructor Details

    • SetVariableMeta

      public SetVariableMeta()

  • Method Details

    • getFieldName

      public String[] getFieldName()
      Returns:
      Returns the fieldName.

    • setFieldName

      public void setFieldName(String[] fieldName)
      Parameters:
      fieldName - The fieldName to set.

    • setVariableName

      public void setVariableName(String[] fieldValue)
      Parameters:
      fieldValue - The fieldValue to set.

    • getVariableName

      public String[] getVariableName()
      Returns:
      Returns the fieldValue.

    • getVariableType

      public int[] getVariableType()
      Returns:
      Returns the local variable flag: true if this variable is only valid in the parents job.

    • getDefaultValue

      public String[] getDefaultValue()
      Returns:
      Returns the defaultValue.

    • setDefaultValue

      public void setDefaultValue(String[] defaultValue)
      Parameters:
      defaultValue - The defaultValue to set.

    • 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()

    • loadXML

      public void loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleXMLException
      Description copied from interface: StepMetaInterface
      Load the values for this step from an XML Node
      Specified by:
      loadXML in interface StepMetaInterface
      Overrides:
      loadXML in class BaseStepMeta
      Parameters:
      stepnode - the Node to get the info from
      databases - The available list of databases to reference to
      metaStore - the metastore to optionally load external reference metadata from
      Throws:
      org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

    • allocate

      public void allocate(int count)

    • clone

      public Object clone()
      Description copied from interface: StepMetaInterface
      Make an exact copy of this step, make sure to explicitly copy Collections etc.
      Specified by:
      clone in interface StepMetaInterface
      Overrides:
      clone in class BaseStepMeta
      Returns:
      an exact copy of this step

    • setDefault

      public void setDefault()
      Description copied from interface: StepMetaInterface
      Set default values
      Specified by:
      setDefault in interface StepMetaInterface

    • getXML

      public String getXML()
      Description copied from class: BaseStepMeta
      Produces the XML string that describes this step's information.
      Specified by:
      getXML in interface StepMetaInterface
      Overrides:
      getXML in class BaseStepMeta
      Returns:
      String containing the XML describing this step.

    • readRep

      public void readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: StepMetaInterface
      Read the steps information from a Kettle repository
      Specified by:
      readRep in interface StepMetaInterface
      Overrides:
      readRep in class BaseStepMeta
      Parameters:
      rep - The repository to read from
      metaStore - The MetaStore to read external information from
      id_step - The step ID
      databases - The databases to reference
      Throws:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • saveRep

      public void saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) throws org.pentaho.di.core.exception.KettleException
      Description copied from interface: StepMetaInterface
      Save the steps data into a Kettle repository
      Specified by:
      saveRep in interface StepMetaInterface
      Overrides:
      saveRep in class BaseStepMeta
      Parameters:
      rep - The Kettle repository to save to
      metaStore - the metaStore to optionally write to
      id_transformation - The transformation ID
      id_step - The step ID
      Throws:
      org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

    • check

      public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
      Description copied from interface: StepMetaInterface
      Checks the settings of this step and puts the findings in a remarks List.
      Specified by:
      check in interface StepMetaInterface
      Overrides:
      check in class BaseStepMeta
      Parameters:
      remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
      stepMeta - The stepMeta to help checking
      prev - The fields coming from the previous step
      input - The input step names
      output - The output step names
      info - The fields that are used as information by the step
      space - the variable space to resolve variable expressions with
      repository - the repository to use to load Kettle metadata objects impacting the output fields
      metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

    • getStep

      public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
      Description copied from interface: StepMetaInterface
      Get the executing step, needed by Trans to launch a step.
      Specified by:
      getStep in interface StepMetaInterface
      Parameters:
      stepMeta - The step info
      stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
      cnr - The copy nr to get
      transMeta - The transformation info
      trans - The launching transformation

    • getStepData

      public StepDataInterface getStepData()
      Description copied from interface: StepMetaInterface
      Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.
      Specified by:
      getStepData in interface StepMetaInterface
      Returns:
      The appropriate StepDataInterface class.

    • isUsingFormatting

      public boolean isUsingFormatting()
      Returns:
      the usingFormatting

    • setUsingFormatting

      public void setUsingFormatting(boolean usingFormatting)
      Parameters:
      usingFormatting - the usingFormatting to set