Package org.pentaho.di.trans.steps.mapping

Class MappingMeta

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.mapping.MappingMeta
All Implemented Interfaces:
Cloneable, HasRepositoryDirectories, HasRepositoryInterface, ISubTransAwareMeta, StepAttributesInterface, StepMetaInterface
public class MappingMeta extends StepWithMappingMeta implements StepMetaInterface, HasRepositoryInterface, ISubTransAwareMeta
Meta-data for the Mapping step: contains name of the (sub-)transformation to execute
Since:
22-nov-2005
Author:
Matt

  • Constructor Details

    • MappingMeta

      public MappingMeta()

  • Method Details

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

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

    • 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

    • getFields

      public void getFields(org.pentaho.di.core.row.RowMetaInterface row, 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:
      row - 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

    • getInfoSteps

      public String[] getInfoSteps()

    • getTargetSteps

      public String[] getTargetSteps()

    • loadMappingMeta

      @Deprecated public static final TransMeta loadMappingMeta(MappingMeta mappingMeta, 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 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 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

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

    • getInputMappings

      public List<MappingIODefinition> getInputMappings()
      Overrides:
      getInputMappings in class StepWithMappingMeta
      Returns:
      the inputMappings

    • setInputMappings

      public void setInputMappings(List<MappingIODefinition> inputMappings)
      Parameters:
      inputMappings - the inputMappings to set

    • getOutputMappings

      public List<MappingIODefinition> getOutputMappings()
      Overrides:
      getOutputMappings in class StepWithMappingMeta
      Returns:
      the outputMappings

    • setOutputMappings

      public void setOutputMappings(List<MappingIODefinition> outputMappings)
      Parameters:
      outputMappings - the outputMappings to set

    • getMappingParameters

      public MappingParameters getMappingParameters()
      Returns:
      the mappingParameters

    • setMappingParameters

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

    • 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

    • 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

    • getSpecificationMethod

      public org.pentaho.di.core.ObjectLocationSpecificationMethod getSpecificationMethod()
      Specified by:
      getSpecificationMethod in interface ISubTransAwareMeta
      Overrides:
      getSpecificationMethod in class StepWithMappingMeta
      Returns:
      the specificationMethod

    • setSpecificationMethod

      public void setSpecificationMethod(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod)
      Overrides:
      setSpecificationMethod in class StepWithMappingMeta
      Parameters:
      specificationMethod - the specificationMethod to set

    • 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

    • excludeFromRowLayoutVerification

      public boolean excludeFromRowLayoutVerification()
      Description copied from class: BaseStepMeta
      This method is added to exclude certain steps from layout checking.
      Specified by:
      excludeFromRowLayoutVerification in interface StepMetaInterface
      Overrides:
      excludeFromRowLayoutVerification 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

    • isAllowingMultipleInputs

      public boolean isAllowingMultipleInputs()
      Returns:
      the allowingMultipleInputs

    • setAllowingMultipleInputs

      public void setAllowingMultipleInputs(boolean allowingMultipleInputs)
      Parameters:
      allowingMultipleInputs - the allowingMultipleInputs to set

    • isAllowingMultipleOutputs

      public boolean isAllowingMultipleOutputs()
      Returns:
      the allowingMultipleOutputs

    • setAllowingMultipleOutputs

      public void setAllowingMultipleOutputs(boolean allowingMultipleOutputs)
      Parameters:
      allowingMultipleOutputs - the allowingMultipleOutputs 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, 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

      @Deprecated public Object loadReferencedObject(int index, Repository rep, org.pentaho.di.core.variables.VariableSpace space) throws org.pentaho.di.core.exception.KettleException
      Deprecated.
      Description copied from class: BaseStepMeta
      Load the referenced object
      Overrides:
      loadReferencedObject in class BaseStepMeta
      Parameters:
      index - the object index to load
      rep - the repository
      space - the variable space to use
      Returns:
      the referenced object once loaded
      Throws:
      org.pentaho.di.core.exception.KettleException

    • 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
      metaStore - the MetaStore to use
      space - the variable space 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)