org.pentaho.di.trans.steps.mapping
Class MappingMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.mapping.MappingMeta
All Implemented Interfaces:
Cloneable, HasRepositoryInterface, StepAttributesInterface, StepMetaInterface

public class MappingMeta
extends BaseStepMeta
implements StepMetaInterface, HasRepositoryInterface

Meta-data for the Mapping step: contains name of the (sub-)transformation to execute

Since:
22-nov-2005
Author:
Matt

Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
MappingMeta()
           
 
Method Summary
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
          Checks the settings of this step and puts the findings in a remarks List.
 Object clone()
          Make an exact copy of this step, make sure to explicitly copy Collections etc.
 boolean excludeFromRowLayoutVerification()
          This method is added to exclude certain steps from layout checking.
 String exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository)
          Export resources.
 String getDirectoryPath()
           
 void getFields(RowMetaInterface row, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String getFileName()
           
 String[] getInfoSteps()
           
 List<MappingIODefinition> getInputMappings()
           
 MappingParameters getMappingParameters()
           
 List<MappingIODefinition> getOutputMappings()
           
 Repository getRepository()
           
 List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
          Get a list of all the resource dependencies that the step is depending on.
 ObjectLocationSpecificationMethod getSpecificationMethod()
           
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans)
          Get the executing step, needed by Trans to launch a step.
 StepDataInterface getStepData()
          Get a new instance of the appropriate data class.
 StepIOMetaInterface getStepIOMeta()
          Returns the Input/Output metadata for this step.
 TransMeta.TransformationType[] getSupportedTransformationTypes()
           
 String[] getTargetSteps()
           
 String getTransName()
           
 ObjectId getTransObjectId()
           
 String getXML()
          Produces the XML string that describes this step's information.
 boolean hasRepositoryReferences()
           
 boolean isAllowingMultipleInputs()
           
 boolean isAllowingMultipleOutputs()
           
static TransMeta loadMappingMeta(MappingMeta mappingMeta, Repository rep, VariableSpace space)
           
 void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Load the values for this step from an XML Node
 void lookupRepositoryReferences(Repository repository)
          Look up the references after import
 void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters)
          Read the steps information from a Kettle repository
 void resetStepIoMeta()
          Remove the cached StepIOMeta so it is recreated when it is next accessed.
 void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step)
          Save the steps data into a Kettle repository
 void searchInfoAndTargetSteps(List<StepMeta> steps)
          Change step names into step objects to allow them to be name-changed etc.
 void setAllowingMultipleInputs(boolean allowingMultipleInputs)
           
 void setAllowingMultipleOutputs(boolean allowingMultipleOutputs)
           
 void setDefault()
          Set default values
 void setDirectoryPath(String directoryPath)
           
 void setFileName(String fileName)
           
 void setInputMappings(List<MappingIODefinition> inputMappings)
           
 void setMappingParameters(MappingParameters mappingParameters)
           
 void setOutputMappings(List<MappingIODefinition> outputMappings)
           
 void setRepository(Repository repository)
           
 void setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
           
 void setTransName(String transName)
           
 void setTransObjectId(ObjectId transObjectId)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getStepInjectionMetadataEntries, getStepMetaInjectionInterface, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, setChanged, setChanged, setParentStepMeta, supportsErrorHandling
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getStepMetaInjectionInterface, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, setParentStepMeta, supportsErrorHandling
 

Constructor Detail

MappingMeta

public MappingMeta()
Method Detail

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException
Description copied from interface: StepMetaInterface
Load the values for this step from an XML Node

Specified by:
loadXML in interface StepMetaInterface
Parameters:
stepnode - the Node to get the info from
databases - The available list of databases to reference to
counters - Counters to reference.
Throws:
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 BaseStepMeta
Returns:
String containing the XML describing this step.

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException
Description copied from interface: StepMetaInterface
Read the steps information from a Kettle repository

Specified by:
readRep in interface StepMetaInterface
Parameters:
rep - The repository to read from
id_step - The step ID
databases - The databases to reference
counters - The counters to reference
Throws:
KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException
Description copied from interface: StepMetaInterface
Save the steps data into a Kettle repository

Specified by:
saveRep in interface StepMetaInterface
Parameters:
rep - The Kettle repository to save to
id_transformation - The transformation ID
id_step - The step ID
Throws:
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(RowMetaInterface row,
                      String origin,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws 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
origin - the name
info - the info
nextStep - the next step
space - the space
Throws:
KettleStepException - the kettle step exception

getInfoSteps

public String[] getInfoSteps()

getTargetSteps

public String[] getTargetSteps()

loadMappingMeta

public static final TransMeta loadMappingMeta(MappingMeta mappingMeta,
                                              Repository rep,
                                              VariableSpace space)
                                       throws KettleException
Throws:
KettleException

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepinfo,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)
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
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

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.

getDirectoryPath

public String getDirectoryPath()
Returns:
the directoryPath

setDirectoryPath

public void setDirectoryPath(String directoryPath)
Parameters:
directoryPath - the directoryPath to set

getFileName

public String getFileName()
Returns:
the fileName

setFileName

public void setFileName(String fileName)
Parameters:
fileName - the fileName to set

getTransName

public String getTransName()
Returns:
the transName

setTransName

public void setTransName(String transName)
Parameters:
transName - the transName to set

getInputMappings

public List<MappingIODefinition> getInputMappings()
Returns:
the inputMappings

setInputMappings

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

getOutputMappings

public List<MappingIODefinition> getOutputMappings()
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

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository)
                       throws KettleException
Description copied from class: BaseStepMeta
Export resources.

Specified by:
exportResources in interface StepMetaInterface
Overrides:
exportResources in class BaseStepMeta
Parameters:
space - the space
definitions - the definitions
resourceNamingInterface - the resource naming interface
repository - the repository
Returns:
the string
Throws:
KettleException - the kettle exception

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

getTransObjectId

public ObjectId getTransObjectId()
Returns:
the transObjectId

setTransObjectId

public void setTransObjectId(ObjectId transObjectId)
Parameters:
transObjectId - the transObjectId to set

getSpecificationMethod

public ObjectLocationSpecificationMethod getSpecificationMethod()
Returns:
the specificationMethod

setSpecificationMethod

public void setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
Parameters:
specificationMethod - the specificationMethod to set

getStepIOMeta

public StepIOMetaInterface getStepIOMeta()
Description copied from class: BaseStepMeta
Returns the Input/Output metadata for this step. By default, each step produces and accepts optional input.

Specified by:
getStepIOMeta in interface StepMetaInterface
Overrides:
getStepIOMeta in class BaseStepMeta

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

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 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:
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