Package org.pentaho.di.trans.steps.transexecutor

Class TransExecutorMeta

java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.core.util.serialization.BaseSerializingMeta
org.pentaho.di.trans.StepWithMappingMeta
org.pentaho.di.trans.steps.transexecutor.TransExecutorMeta
All Implemented Interfaces:
Cloneable, HasRepositoryDirectories, HasRepositoryInterface, ISubTransAwareMeta, StepAttributesInterface, StepMetaInterface
public class TransExecutorMeta extends StepWithMappingMeta implements StepMetaInterface, HasRepositoryInterface, ISubTransAwareMeta
Meta-data for the Trans Executor step.
Since:
18-mar-2013
Author:
Matt

  • Constructor Details

    • TransExecutorMeta

      public TransExecutorMeta()

  • Method Details

    • allocate

      public void allocate(int nrFields)

    • 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

    • 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 BaseSerializingMeta
      Returns:
      String containing the XML describing this step.

    • 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 BaseSerializingMeta
      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.)

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

    • setDefault

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

    • addFieldToRow

      protected void addFieldToRow(org.pentaho.di.core.row.RowMetaInterface row, String fieldName, int type) throws org.pentaho.di.core.exception.KettleStepException
      Throws:
      org.pentaho.di.core.exception.KettleStepException

    • addFieldToRow

      protected void addFieldToRow(org.pentaho.di.core.row.RowMetaInterface row, String fieldName, int type, int length, int precision) throws org.pentaho.di.core.exception.KettleStepException
      Throws:
      org.pentaho.di.core.exception.KettleStepException

    • getFields

      public void getFields(org.pentaho.di.core.row.RowMetaInterface inputRowMeta, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) throws org.pentaho.di.core.exception.KettleStepException
      Description copied from class: BaseStepMeta
      Gets the fields.
      Specified by:
      getFields in interface StepMetaInterface
      Overrides:
      getFields in class BaseStepMeta
      Parameters:
      inputRowMeta - the input row meta that is modified in this method to reflect the output row metadata of the step
      name - Name of the step to use as input for the origin field in the values
      info - Fields used as extra lookup information
      nextStep - the next step that is targeted
      space - the space The variable space to use to replace variables
      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
      Throws:
      org.pentaho.di.core.exception.KettleStepException - the kettle step exception

    • getInfoSteps

      public String[] getInfoSteps()

    • loadTransMeta

      @Deprecated public static TransMeta loadTransMeta(TransExecutorMeta executorMeta, Repository rep, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
      Deprecated.
      Throws:
      org.pentaho.di.core.exception.KettleException

    • check

      public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, 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
      stepinfo - 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 tr, 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
      tr - The transformation info
      trans - The launching transformation

    • getResourceDependencies

      public List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
      Description copied from class: BaseStepMeta
      Get a list of all the resource dependencies that the step is depending on.
      Specified by:
      getResourceDependencies in interface StepMetaInterface
      Overrides:
      getResourceDependencies in class BaseStepMeta
      Returns:
      a list of all the resource dependencies that the step is depending on

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

    • getStepIOMeta

      public StepIOMetaInterface getStepIOMeta()
      Description copied from interface: StepMetaInterface
      Returns the Input/Output metadata for this step.
      Specified by:
      getStepIOMeta in interface StepMetaInterface
      Overrides:
      getStepIOMeta in class BaseStepMeta

    • handleStreamSelection

      public void handleStreamSelection(StreamInterface stream)
      When an optional stream is selected, this method is called to handled the ETL metadata implications of that.
      Specified by:
      handleStreamSelection in interface StepMetaInterface
      Overrides:
      handleStreamSelection in class BaseStepMeta
      Parameters:
      stream - The optional stream to handle.

    • resetStepIoMeta

      public void resetStepIoMeta()
      Remove the cached StepIOMeta so it is recreated when it is next accessed.
      Specified by:
      resetStepIoMeta in interface StepMetaInterface
      Overrides:
      resetStepIoMeta in class BaseStepMeta

    • searchInfoAndTargetSteps

      public void searchInfoAndTargetSteps(List<StepMeta> steps)
      Description copied from class: BaseStepMeta
      Change step names into step objects to allow them to be name-changed etc.
      Specified by:
      searchInfoAndTargetSteps in interface StepMetaInterface
      Overrides:
      searchInfoAndTargetSteps in class BaseStepMeta
      Parameters:
      steps - the steps to reference

    • getSupportedTransformationTypes

      public TransMeta.TransformationType[] getSupportedTransformationTypes()
      Specified by:
      getSupportedTransformationTypes in interface StepMetaInterface
      Overrides:
      getSupportedTransformationTypes in class BaseStepMeta
      Returns:
      The supported transformation types that this step supports.

    • hasRepositoryReferences

      public boolean hasRepositoryReferences()
      Specified by:
      hasRepositoryReferences in interface StepMetaInterface
      Overrides:
      hasRepositoryReferences in class BaseStepMeta
      Returns:
      True if the job entry defines one or more references to a repository object.

    • lookupRepositoryReferences

      public void lookupRepositoryReferences(Repository repository) throws org.pentaho.di.core.exception.KettleException
      Description copied from class: BaseStepMeta
      Look up the references after import
      Specified by:
      lookupRepositoryReferences in interface StepMetaInterface
      Overrides:
      lookupRepositoryReferences in class BaseStepMeta
      Parameters:
      repository - the repository to reference.
      Throws:
      org.pentaho.di.core.exception.KettleException

    • getMappingParameters

      public TransExecutorParameters getMappingParameters()
      Returns:
      the mappingParameters

    • setMappingParameters

      public void setMappingParameters(TransExecutorParameters mappingParameters)
      Parameters:
      mappingParameters - the mappingParameters to set

    • getRepository

      public Repository getRepository()
      Specified by:
      getRepository in interface HasRepositoryInterface
      Returns:
      the repository

    • setRepository

      public void setRepository(Repository repository)
      Specified by:
      setRepository in interface HasRepositoryInterface
      Parameters:
      repository - the repository to set

    • getParameters

      public TransExecutorParameters getParameters()
      Returns:
      the parameters

    • setParameters

      public void setParameters(TransExecutorParameters parameters)
      Parameters:
      parameters - the parameters to set

    • getExecutionTimeField

      public String getExecutionTimeField()
      Returns:
      the executionTimeField

    • setExecutionTimeField

      public void setExecutionTimeField(String executionTimeField)
      Parameters:
      executionTimeField - the executionTimeField to set

    • getExecutionResultField

      public String getExecutionResultField()
      Returns:
      the executionResultField

    • setExecutionResultField

      public void setExecutionResultField(String executionResultField)
      Parameters:
      executionResultField - the executionResultField to set

    • getExecutionNrErrorsField

      public String getExecutionNrErrorsField()
      Returns:
      the executionNrErrorsField

    • setExecutionNrErrorsField

      public void setExecutionNrErrorsField(String executionNrErrorsField)
      Parameters:
      executionNrErrorsField - the executionNrErrorsField to set

    • getExecutionLinesReadField

      public String getExecutionLinesReadField()
      Returns:
      the executionLinesReadField

    • setExecutionLinesReadField

      public void setExecutionLinesReadField(String executionLinesReadField)
      Parameters:
      executionLinesReadField - the executionLinesReadField to set

    • getExecutionLinesWrittenField

      public String getExecutionLinesWrittenField()
      Returns:
      the executionLinesWrittenField

    • setExecutionLinesWrittenField

      public void setExecutionLinesWrittenField(String executionLinesWrittenField)
      Parameters:
      executionLinesWrittenField - the executionLinesWrittenField to set

    • getExecutionLinesInputField

      public String getExecutionLinesInputField()
      Returns:
      the executionLinesInputField

    • setExecutionLinesInputField

      public void setExecutionLinesInputField(String executionLinesInputField)
      Parameters:
      executionLinesInputField - the executionLinesInputField to set

    • getExecutionLinesOutputField

      public String getExecutionLinesOutputField()
      Returns:
      the executionLinesOutputField

    • setExecutionLinesOutputField

      public void setExecutionLinesOutputField(String executionLinesOutputField)
      Parameters:
      executionLinesOutputField - the executionLinesOutputField to set

    • getExecutionLinesRejectedField

      public String getExecutionLinesRejectedField()
      Returns:
      the executionLinesRejectedField

    • setExecutionLinesRejectedField

      public void setExecutionLinesRejectedField(String executionLinesRejectedField)
      Parameters:
      executionLinesRejectedField - the executionLinesRejectedField to set

    • getExecutionLinesUpdatedField

      public String getExecutionLinesUpdatedField()
      Returns:
      the executionLinesUpdatedField

    • setExecutionLinesUpdatedField

      public void setExecutionLinesUpdatedField(String executionLinesUpdatedField)
      Parameters:
      executionLinesUpdatedField - the executionLinesUpdatedField to set

    • getExecutionLinesDeletedField

      public String getExecutionLinesDeletedField()
      Returns:
      the executionLinesDeletedField

    • setExecutionLinesDeletedField

      public void setExecutionLinesDeletedField(String executionLinesDeletedField)
      Parameters:
      executionLinesDeletedField - the executionLinesDeletedField to set

    • getExecutionFilesRetrievedField

      public String getExecutionFilesRetrievedField()
      Returns:
      the executionFilesRetrievedField

    • setExecutionFilesRetrievedField

      public void setExecutionFilesRetrievedField(String executionFilesRetrievedField)
      Parameters:
      executionFilesRetrievedField - the executionFilesRetrievedField to set

    • getExecutionExitStatusField

      public String getExecutionExitStatusField()
      Returns:
      the executionExitStatusField

    • setExecutionExitStatusField

      public void setExecutionExitStatusField(String executionExitStatusField)
      Parameters:
      executionExitStatusField - the executionExitStatusField to set

    • getExecutionLogTextField

      public String getExecutionLogTextField()
      Returns:
      the executionLogTextField

    • setExecutionLogTextField

      public void setExecutionLogTextField(String executionLogTextField)
      Parameters:
      executionLogTextField - the executionLogTextField to set

    • getExecutionLogChannelIdField

      public String getExecutionLogChannelIdField()
      Returns:
      the executionLogChannelIdField

    • setExecutionLogChannelIdField

      public void setExecutionLogChannelIdField(String executionLogChannelIdField)
      Parameters:
      executionLogChannelIdField - the executionLogChannelIdField to set

    • getGroupSize

      public String getGroupSize()
      Returns:
      the groupSize

    • setGroupSize

      public void setGroupSize(String groupSize)
      Parameters:
      groupSize - the groupSize to set

    • getGroupField

      public String getGroupField()
      Returns:
      the groupField

    • setGroupField

      public void setGroupField(String groupField)
      Parameters:
      groupField - the groupField to set

    • getGroupTime

      public String getGroupTime()
      Returns:
      the groupTime

    • setGroupTime

      public void setGroupTime(String groupTime)
      Parameters:
      groupTime - the groupTime to set

    • excludeFromCopyDistributeVerification

      public boolean excludeFromCopyDistributeVerification()
      Description copied from class: BaseStepMeta
      This method is added to exclude certain steps from copy/distribute checking.
      Specified by:
      excludeFromCopyDistributeVerification in interface StepMetaInterface
      Overrides:
      excludeFromCopyDistributeVerification in class BaseStepMeta

    • getExecutionResultTargetStep

      public String getExecutionResultTargetStep()
      Returns:
      the executionResultTargetStep

    • setExecutionResultTargetStep

      public void setExecutionResultTargetStep(String executionResultTargetStep)
      Parameters:
      executionResultTargetStep - the executionResultTargetStep to set

    • getExecutionResultTargetStepMeta

      public StepMeta getExecutionResultTargetStepMeta()
      Returns:
      the executionResultTargetStepMeta

    • setExecutionResultTargetStepMeta

      public void setExecutionResultTargetStepMeta(StepMeta executionResultTargetStepMeta)
      Parameters:
      executionResultTargetStepMeta - the executionResultTargetStepMeta to set

    • getResultFilesFileNameField

      public String getResultFilesFileNameField()
      Returns:
      the resultFilesFileNameField

    • setResultFilesFileNameField

      public void setResultFilesFileNameField(String resultFilesFileNameField)
      Parameters:
      resultFilesFileNameField - the resultFilesFileNameField to set

    • getReferencedObjectDescriptions

      public String[] getReferencedObjectDescriptions()
      Specified by:
      getReferencedObjectDescriptions in interface StepMetaInterface
      Overrides:
      getReferencedObjectDescriptions in class BaseStepMeta
      Returns:
      The objects referenced in the step, like a mapping, a transformation, ...

    • isReferencedObjectEnabled

      public boolean[] isReferencedObjectEnabled()
      Specified by:
      isReferencedObjectEnabled in interface StepMetaInterface
      Overrides:
      isReferencedObjectEnabled in class BaseStepMeta
      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, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
      Load the referenced object
      Specified by:
      loadReferencedObject in interface StepMetaInterface
      Overrides:
      loadReferencedObject in class BaseStepMeta
      Parameters:
      index - the object index to load
      rep - the repository
      space - the variable space to use
      metaStore - the MetaStore to use
      Returns:
      the referenced object once loaded
      Throws:
      org.pentaho.di.core.exception.KettleException

    • getMetaStore

      public org.pentaho.metastore.api.IMetaStore getMetaStore()

    • setMetaStore

      public void setMetaStore(org.pentaho.metastore.api.IMetaStore metaStore)

    • getOutputRowsSourceStep

      public String getOutputRowsSourceStep()

    • setOutputRowsSourceStep

      public void setOutputRowsSourceStep(String outputRowsSourceStep)

    • getOutputRowsSourceStepMeta

      public StepMeta getOutputRowsSourceStepMeta()

    • setOutputRowsSourceStepMeta

      public void setOutputRowsSourceStepMeta(StepMeta outputRowsSourceStepMeta)

    • getOutputRowsField

      public String[] getOutputRowsField()

    • setOutputRowsField

      public void setOutputRowsField(String[] outputRowsField)

    • getOutputRowsType

      public int[] getOutputRowsType()

    • setOutputRowsType

      public void setOutputRowsType(int[] outputRowsType)

    • getOutputRowsLength

      public int[] getOutputRowsLength()

    • setOutputRowsLength

      public void setOutputRowsLength(int[] outputRowsLength)

    • getOutputRowsPrecision

      public int[] getOutputRowsPrecision()

    • setOutputRowsPrecision

      public void setOutputRowsPrecision(int[] outputRowsPrecision)

    • getResultFilesTargetStep

      public String getResultFilesTargetStep()

    • setResultFilesTargetStep

      public void setResultFilesTargetStep(String resultFilesTargetStep)

    • getResultFilesTargetStepMeta

      public StepMeta getResultFilesTargetStepMeta()

    • setResultFilesTargetStepMeta

      public void setResultFilesTargetStepMeta(StepMeta resultFilesTargetStepMeta)

    • getExecutorsOutputStep

      public String getExecutorsOutputStep()

    • setExecutorsOutputStep

      public void setExecutorsOutputStep(String executorsOutputStep)

    • getExecutorsOutputStepMeta

      public StepMeta getExecutorsOutputStepMeta()

    • setExecutorsOutputStepMeta

      public void setExecutorsOutputStepMeta(StepMeta executorsOutputStepMeta)

    • cleanAfterHopFromRemove

      public boolean cleanAfterHopFromRemove()
      Description copied from interface: StepMetaInterface
      Action remove hop exiting this step
      Specified by:
      cleanAfterHopFromRemove in interface StepMetaInterface
      Returns:
      step was changed

    • cleanAfterHopFromRemove

      public boolean cleanAfterHopFromRemove(StepMeta toStep)
      Description copied from interface: StepMetaInterface

      Action remove hop exiting this step

      Specified by:
      cleanAfterHopFromRemove in interface StepMetaInterface
      Parameters:
      toStep - the to-step of the hop being removed
      Returns:
      step was changed