Package org.pentaho.di.trans.streaming.common

Class BaseStreamStepMeta

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.streaming.common.BaseStreamStepMeta
All Implemented Interfaces:
Cloneable, HasRepositoryDirectories, ISubTransAwareMeta, StepAttributesInterface, StepMetaInterface
public abstract class BaseStreamStepMeta extends StepWithMappingMeta implements StepMetaInterface, ISubTransAwareMeta

  • Field Details

  • Constructor Details

    • BaseStreamStepMeta

      public BaseStreamStepMeta()

  • Method Details

    • getSubStep

      public String getSubStep()

    • setSubStep

      public void setSubStep(String subStep)

    • setTransformationPath

      public void setTransformationPath(String transformationPath)

    • setBatchSize

      public void setBatchSize(String batchSize)

    • setPrefetchCount

      public void setPrefetchCount(String prefetchCount)

    • setBatchDuration

      public void setBatchDuration(String batchDuration)

    • setParallelism

      public void setParallelism(String parallelism)

    • setDefault

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

    • getTransformationPath

      public String getTransformationPath()

    • getBatchSize

      public String getBatchSize()

    • getPrefetchCount

      public String getPrefetchCount()

    • getBatchDuration

      public String getBatchDuration()

    • getParallelism

      public String getParallelism()

    • getMessageDataType

      public int getMessageDataType()

    • replaceFileName

      public void replaceFileName(String fileName)
      Overrides:
      replaceFileName in class StepWithMappingMeta
      Parameters:
      fileName - the fileName to set

    • 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

    • getFileName

      public String getFileName()
      Specified by:
      getFileName in interface ISubTransAwareMeta
      Overrides:
      getFileName in class StepWithMappingMeta
      Returns:
      the fileName

    • 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

    • 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, a job, ...

    • 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
      Description copied from interface: StepMetaInterface
      Load the referenced object
      Specified by:
      loadReferencedObject in interface StepMetaInterface
      Overrides:
      loadReferencedObject in class BaseStepMeta
      Parameters:
      index - the referenced object index to load (in case there are multiple references)
      rep - the repository
      metaStore - the MetaStore to use
      space - the variable space to use
      Returns:
      the referenced object once loaded
      Throws:
      org.pentaho.di.core.exception.KettleException

    • getRowMeta

      public abstract org.pentaho.di.core.row.RowMeta getRowMeta(String origin, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleStepException
      Throws:
      org.pentaho.di.core.exception.KettleStepException

    • getFields

      public void getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta, String origin, 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:
      rowMeta - the input row meta that is modified in this method to reflect the output row metadata of the step
      origin - 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