org.pentaho.di.trans

Class StepWithMappingMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.core.util.serialization.BaseSerializingMeta

org.pentaho.di.trans.StepWithMappingMeta

All Implemented Interfaces:

Cloneable, HasRepositoryDirectories, StepAttributesInterface, StepMetaInterface

Direct Known Subclasses:

BaseStreamStepMeta, MappingMeta, SimpleMappingMeta, SingleThreaderMeta, TransExecutorMeta

public abstract class StepWithMappingMeta
extends BaseSerializingMeta
implements HasRepositoryDirectories, StepMetaInterface

This class is supposed to use in steps where the mapping to sub transformations takes place

Since:

02-jan-2017

Author:

Yury Bakhmutski

Field Summary

Fields

Modifier and Type	Field and Description
protected String	directoryPath
protected String	fileName
protected ObjectLocationSpecificationMethod	specificationMethod
protected String	transName
protected ObjectId	transObjectId

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
StepWithMappingMeta()

Method Summary

Modifier and Type	Method and Description
static void	activateParams(VariableSpace childVariableSpace, NamedParams childNamedParams, VariableSpace parent, String[] listParameters, String[] mappingVariables, String[] inputFields)
static void	activateParams(VariableSpace childVariableSpace, NamedParams childNamedParams, VariableSpace parent, String[] listParameters, String[] mappingVariables, String[] inputFields, boolean isPassingAllParameters)
static void	addMissingVariables(VariableSpace fromSpace, VariableSpace toSpace)
String	exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
String[]	getDirectories() If step has reference(s) to another transformation(s)/job(s) returns an array of repository directories.
String	getDirectoryPath()
String	getFileName()
List<MappingIODefinition>	getInputMappings()
List<MappingIODefinition>	getOutputMappings()
ObjectLocationSpecificationMethod	getSpecificationMethod()
ObjectLocationSpecificationMethod[]	getSpecificationMethods() If step has reference(s) to another transformation(s)/job(s) returns an array of specification method(s) defining the type of an access to a referenced file.
String	getTransName()
ObjectId	getTransObjectId()
static TransMeta	loadMappingMeta(StepWithMappingMeta mappingMeta, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space)
static TransMeta	loadMappingMeta(StepWithMappingMeta executorMeta, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, VariableSpace space, boolean share)
void	replaceFileName(String fileName)
static void	replaceVariableValues(VariableSpace childTransMeta, VariableSpace replaceBy)
void	setDirectories(String[] directories) If step has reference(s) to another transformation(s)/job(s) sets updated repository directories from incoming String array.
void	setDirectoryPath(String directoryPath)
void	setFileName(String fileName)
void	setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
void	setTransName(String transName)
void	setTransObjectId(ObjectId transObjectId)

Methods inherited from class org.pentaho.di.core.util.serialization.BaseSerializingMeta

copyObject, getXML, loadXML, readRep, saveRep, withVariables

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, analyseImpact, cancelQueries, check, check, check, clone, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, 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.step.StepMetaInterface

analyseImpact, analyseImpact, cancelQueries, check, check, cleanAfterHopFromRemove, cleanAfterHopFromRemove, cleanAfterHopToRemove, clone, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStep, getStepData, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXML, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, readRep, resetStepIoMeta, saveRep, saveRep, searchInfoAndTargetSteps, setChanged, setDefault, setParentStepMeta, supportsErrorHandling

Field Detail

specificationMethod

protected ObjectLocationSpecificationMethod specificationMethod

transName

protected String transName

fileName

protected String fileName

directoryPath

protected String directoryPath

transObjectId

protected ObjectId transObjectId

Constructor Detail

StepWithMappingMeta

public StepWithMappingMeta()

Method Detail

loadMappingMeta

public static TransMeta loadMappingMeta(StepWithMappingMeta mappingMeta,
                                        Repository rep,
                                        org.pentaho.metastore.api.IMetaStore metaStore,
                                        VariableSpace space)
                                 throws KettleException

Throws:

KettleException

loadMappingMeta

public static TransMeta loadMappingMeta(StepWithMappingMeta executorMeta,
                                        Repository rep,
                                        org.pentaho.metastore.api.IMetaStore metaStore,
                                        VariableSpace space,
                                        boolean share)
                                 throws KettleException

Throws:

KettleException

activateParams

public static void activateParams(VariableSpace childVariableSpace,
                                  NamedParams childNamedParams,
                                  VariableSpace parent,
                                  String[] listParameters,
                                  String[] mappingVariables,
                                  String[] inputFields)

activateParams

public static void activateParams(VariableSpace childVariableSpace,
                                  NamedParams childNamedParams,
                                  VariableSpace parent,
                                  String[] listParameters,
                                  String[] mappingVariables,
                                  String[] inputFields,
                                  boolean isPassingAllParameters)

getSpecificationMethod

public ObjectLocationSpecificationMethod getSpecificationMethod()

Returns:

the specificationMethod

getSpecificationMethods

public ObjectLocationSpecificationMethod[] getSpecificationMethods()

Description copied from interface: HasRepositoryDirectories

If step has reference(s) to another transformation(s)/job(s) returns an array of specification method(s) defining the type of an access to a referenced file. An implementation is considered to define the array order itself.

Specified by:

getSpecificationMethods in interface HasRepositoryDirectories

Returns:

String array of specification method(s)

setSpecificationMethod

public void setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)

Parameters:

specificationMethod - the specificationMethod to set

getDirectoryPath

public String getDirectoryPath()

Returns:

the directoryPath

setDirectoryPath

public void setDirectoryPath(String directoryPath)

Parameters:

directoryPath - the directoryPath to set

getDirectories

public String[] getDirectories()

Description copied from interface: HasRepositoryDirectories

If step has reference(s) to another transformation(s)/job(s) returns an array of repository directories. An implementation is considered to define the array order itself.

Specified by:

getDirectories in interface HasRepositoryDirectories

Returns:

String array of repository directories

setDirectories

public void setDirectories(String[] directories)

Description copied from interface: HasRepositoryDirectories

If step has reference(s) to another transformation(s)/job(s) sets updated repository directories from incoming String array. An implementation is considered to define the array order itself.

Specified by:

setDirectories in interface HasRepositoryDirectories

Parameters:

directories - Array of updated rep directories to set

getFileName

public String getFileName()

Returns:

the fileName

setFileName

public void setFileName(String fileName)

Parameters:

fileName - the fileName to set

replaceFileName

public void replaceFileName(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

getTransObjectId

public ObjectId getTransObjectId()

Returns:

the transObjectId

setTransObjectId

public void setTransObjectId(ObjectId transObjectId)

Parameters:

transObjectId - the transObjectId to set

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws KettleException

Specified by:

exportResources in interface StepMetaInterface

Overrides:

exportResources in class BaseStepMeta

Parameters:

space - the variable space to use

repository - The repository to optionally load other resources from (to be converted to XML)

metaStore - the metaStore in which non-kettle metadata could reside.

Returns:

the filename of the exported resource

Throws:

KettleException

addMissingVariables

public static void addMissingVariables(VariableSpace fromSpace,
                                       VariableSpace toSpace)

replaceVariableValues

public static void replaceVariableValues(VariableSpace childTransMeta,
                                         VariableSpace replaceBy)

getInputMappings

public List<MappingIODefinition> getInputMappings()

Returns:

the inputMappings

getOutputMappings

public List<MappingIODefinition> getOutputMappings()

Returns:

the outputMappings