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
-
Field Summary
Fields inherited from class org.pentaho.di.trans.StepWithMappingMeta
directoryPath, fileName, specificationMethod, transName, transObjectId
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
attributes, databases, log, loggingObject, parentStepMeta, STEP_ATTRIBUTES_FILE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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) Checks the settings of this step and puts the findings in a remarks List.clone()
Make an exact copy of this step, make sure to explicitly copy Collections etc.boolean
This method is added to exclude certain steps from layout checking.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) Gets the fields.String[]
org.pentaho.metastore.api.IMetaStore
String[]
getResourceDependencies
(TransMeta transMeta, StepMeta stepInfo) Get a list of all the resource dependencies that the step is depending on.org.pentaho.di.core.ObjectLocationSpecificationMethod
getStep
(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, Trans trans) Get the executing step, needed by Trans to launch a step.Get a new instance of the appropriate data class.Returns the Input/Output metadata for this step.String[]
getXML()
Produces the XML string that describes this step's information.boolean
boolean
boolean
boolean[]
static final TransMeta
loadMappingMeta
(MappingMeta mappingMeta, Repository rep, org.pentaho.di.core.variables.VariableSpace space) Deprecated.loadReferencedObject
(int index, Repository rep, org.pentaho.di.core.variables.VariableSpace space) Deprecated.loadReferencedObject
(int index, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.core.variables.VariableSpace space) Load the referenced objectvoid
loadXML
(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Nodevoid
lookupRepositoryReferences
(Repository repository) Look up the references after importvoid
readRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) Read the steps information from a Kettle repositoryvoid
saveRep
(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) Save the steps data into a Kettle repositoryvoid
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
Set default valuesvoid
setInputMappings
(List<MappingIODefinition> inputMappings) void
setMappingParameters
(MappingParameters mappingParameters) void
setMetaStore
(org.pentaho.metastore.api.IMetaStore metaStore) void
setOutputMappings
(List<MappingIODefinition> outputMappings) void
setRepository
(Repository repository) void
setSpecificationMethod
(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod) Methods inherited from class org.pentaho.di.trans.StepWithMappingMeta
activateParams, activateParams, addMissingVariables, exportResources, getDirectories, getDirectoryPath, getFileName, getSpecificationMethods, getTransName, getTransObjectId, loadMappingMeta, loadMappingMeta, replaceFileName, replaceVariableValues, replaceVariableValues, setDirectories, setDirectoryPath, setFileName, setTransName, setTransObjectId
Methods inherited from class org.pentaho.di.core.util.serialization.BaseSerializingMeta
withVariables
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, isBasic, isDebug, isDetailed, isRowLevel, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, readRep, readRep, resetStepIoMeta, saveRep, setChanged, setChanged, setParentStepMeta, setStepIOMeta, supportsErrorHandling
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.pentaho.di.trans.ISubTransAwareMeta
getDirectoryPath, getFileName, getParentStepMeta, getTransName, getTransObjectId
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, excludeFromCopyDistributeVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getSQLStatements, getStepMetaInjectionInterface, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, loadXML, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, setChanged, setParentStepMeta, supportsErrorHandling
-
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 interfaceStepMetaInterface
- Overrides:
loadXML
in classBaseSerializingMeta
- Parameters:
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tometaStore
- 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
Description copied from interface:StepMetaInterface
Make an exact copy of this step, make sure to explicitly copy Collections etc.- Specified by:
clone
in interfaceStepMetaInterface
- Overrides:
clone
in classBaseStepMeta
- Returns:
- an exact copy of this step
-
getXML
Description copied from class:BaseStepMeta
Produces the XML string that describes this step's information.- Specified by:
getXML
in interfaceStepMetaInterface
- Overrides:
getXML
in classBaseSerializingMeta
- 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 interfaceStepMetaInterface
- Overrides:
readRep
in classBaseSerializingMeta
- Parameters:
rep
- The repository to read frommetaStore
- The MetaStore to read external information fromid_step
- The step IDdatabases
- 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 interfaceStepMetaInterface
- Overrides:
saveRep
in classBaseSerializingMeta
- Parameters:
rep
- The Kettle repository to save tometaStore
- the metaStore to optionally write toid_transformation
- The transformation IDid_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 interfaceStepMetaInterface
-
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 interfaceStepMetaInterface
- Overrides:
getFields
in classBaseStepMeta
- Parameters:
row
- the input row meta that is modified in this method to reflect the output row metadata of the steporigin
- Name of the step to use as input for the origin field in the valuesinfo
- Fields used as extra lookup informationnextStep
- the next step that is targetedspace
- the space The variable space to use to replace variablesrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- 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
-
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 interfaceStepMetaInterface
- Overrides:
check
in classBaseStepMeta
- Parameters:
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepMeta
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the stepspace
- the variable space to resolve variable expressions withrepository
- the repository to use to load Kettle metadata objects impacting the output fieldsmetaStore
- 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 interfaceStepMetaInterface
- Parameters:
stepMeta
- The step infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettr
- The transformation infotrans
- The launching transformation
-
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 interfaceStepMetaInterface
- Returns:
- The appropriate StepDataInterface class.
-
getInputMappings
- Overrides:
getInputMappings
in classStepWithMappingMeta
- Returns:
- the inputMappings
-
setInputMappings
- Parameters:
inputMappings
- the inputMappings to set
-
getOutputMappings
- Overrides:
getOutputMappings
in classStepWithMappingMeta
- Returns:
- the outputMappings
-
setOutputMappings
- Parameters:
outputMappings
- the outputMappings to set
-
getMappingParameters
- Returns:
- the mappingParameters
-
setMappingParameters
- Parameters:
mappingParameters
- the mappingParameters to set
-
getResourceDependencies
Description copied from class:BaseStepMeta
Get a list of all the resource dependencies that the step is depending on.- Specified by:
getResourceDependencies
in interfaceStepMetaInterface
- Overrides:
getResourceDependencies
in classBaseStepMeta
- Returns:
- a list of all the resource dependencies that the step is depending on
-
getRepository
- Specified by:
getRepository
in interfaceHasRepositoryInterface
- Returns:
- the repository
-
setRepository
- Specified by:
setRepository
in interfaceHasRepositoryInterface
- Parameters:
repository
- the repository to set
-
getSpecificationMethod
public org.pentaho.di.core.ObjectLocationSpecificationMethod getSpecificationMethod()- Specified by:
getSpecificationMethod
in interfaceISubTransAwareMeta
- Overrides:
getSpecificationMethod
in classStepWithMappingMeta
- Returns:
- the specificationMethod
-
setSpecificationMethod
public void setSpecificationMethod(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod) - Overrides:
setSpecificationMethod
in classStepWithMappingMeta
- Parameters:
specificationMethod
- the specificationMethod to set
-
getStepIOMeta
Description copied from interface:StepMetaInterface
Returns the Input/Output metadata for this step.- Specified by:
getStepIOMeta
in interfaceStepMetaInterface
- Overrides:
getStepIOMeta
in classBaseStepMeta
-
excludeFromRowLayoutVerification
public boolean excludeFromRowLayoutVerification()Description copied from class:BaseStepMeta
This method is added to exclude certain steps from layout checking.- Specified by:
excludeFromRowLayoutVerification
in interfaceStepMetaInterface
- Overrides:
excludeFromRowLayoutVerification
in classBaseStepMeta
-
searchInfoAndTargetSteps
Description copied from class:BaseStepMeta
Change step names into step objects to allow them to be name-changed etc.- Specified by:
searchInfoAndTargetSteps
in interfaceStepMetaInterface
- Overrides:
searchInfoAndTargetSteps
in classBaseStepMeta
- Parameters:
steps
- the steps to reference
-
getSupportedTransformationTypes
- Specified by:
getSupportedTransformationTypes
in interfaceStepMetaInterface
- Overrides:
getSupportedTransformationTypes
in classBaseStepMeta
- Returns:
- The supported transformation types that this step supports.
-
hasRepositoryReferences
public boolean hasRepositoryReferences()- Specified by:
hasRepositoryReferences
in interfaceStepMetaInterface
- Overrides:
hasRepositoryReferences
in classBaseStepMeta
- 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 interfaceStepMetaInterface
- Overrides:
lookupRepositoryReferences
in classBaseStepMeta
- 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
- Specified by:
getReferencedObjectDescriptions
in interfaceStepMetaInterface
- Overrides:
getReferencedObjectDescriptions
in classBaseStepMeta
- Returns:
- The objects referenced in the step, like a mapping, a transformation, a job, ...
-
isReferencedObjectEnabled
public boolean[] isReferencedObjectEnabled()- Specified by:
isReferencedObjectEnabled
in interfaceStepMetaInterface
- Overrides:
isReferencedObjectEnabled
in classBaseStepMeta
- 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 classBaseStepMeta
- Parameters:
index
- the object index to loadrep
- the repositoryspace
- 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 interfaceStepMetaInterface
- Overrides:
loadReferencedObject
in classBaseStepMeta
- Parameters:
index
- the object index to loadrep
- the repositorymetaStore
- the MetaStore to usespace
- 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)
-