org.pentaho.di.trans.steps.metainject

Class MetaInjectMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.metainject.MetaInjectMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaChangeListenerInterface, StepMetaInterface

public class MetaInjectMeta
extends BaseStepMeta
implements StepMetaInterface, StepMetaChangeListenerInterface

Since:

2007-07-05

Version:

3.0

Author:

matt

Field Summary

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
MetaInjectMeta()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Make an exact copy of this step, make sure to explicitly copy Collections etc.
boolean	excludeFromCopyDistributeVerification() This method is added to exclude certain steps from copy/distribute checking.
boolean	excludeFromRowLayoutVerification() This method is added to exclude certain steps from layout checking.
String	exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore)
String	getActiveReferencedObjectDescription()
String	getDirectoryPath()
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) Gets the fields.
String	getFileName()
String[]	getReferencedObjectDescriptions()
List<ResourceReference>	getResourceDependencies(TransMeta transMeta, StepMeta stepInfo) Get a list of all the resource dependencies that the step is depending on.
List<MetaInjectOutputField>	getSourceOutputFields()
String	getSourceStepName()
org.pentaho.di.core.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.
StepMeta	getStreamSourceStep()
String	getStreamSourceStepname()
String	getStreamTargetStepname()
String	getTargetFile()
Map<TargetStepAttribute,SourceStepField>	getTargetSourceMapping()
String	getTransName()
org.pentaho.di.repository.ObjectId	getTransObjectId()
String	getXML() Produces the XML string that describes this step's information.
boolean	isNoExecution()
boolean[]	isReferencedObjectEnabled()
Object	loadReferencedObject(int index, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.core.variables.VariableSpace space) Load the referenced object
Object	loadReferencedObject(int index, Repository rep, org.pentaho.di.core.variables.VariableSpace space) Deprecated.
static TransMeta	loadTransformationMeta(MetaInjectMeta injectMeta, Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.core.variables.VariableSpace space)
static TransMeta	loadTransformationMeta(MetaInjectMeta mappingMeta, Repository rep, org.pentaho.di.core.variables.VariableSpace space) Deprecated.
void	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 Node
void	onStepChange(TransMeta transMeta, StepMeta oldMeta, StepMeta newMeta) This method is called when a step was changed
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) Read the steps information from a Kettle repository
void	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 repository
void	searchInfoAndTargetSteps(List<StepMeta> steps) Change step names into step objects to allow them to be name-changed etc.
void	setDefault() Set default values
void	setDirectoryPath(String directoryPath)
void	setFileName(String fileName)
void	setNoExecution(boolean noExecution)
void	setSourceOutputFields(List<MetaInjectOutputField> sourceOutputFields)
void	setSourceStepName(String sourceStepName)
void	setSpecificationMethod(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod)
void	setStreamSourceStep(StepMeta streamSourceStep)
void	setStreamSourceStepname(String streamSourceStepname)
void	setStreamTargetStepname(String streamTargetStepname)
void	setTargetFile(String targetFile)
void	setTargetSourceMapping(Map<TargetStepAttribute,SourceStepField> targetSourceMapping)
void	setTransName(String transName)
void	setTransObjectId(org.pentaho.di.repository.ObjectId transObjectId)

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

analyseImpact, analyseImpact, cancelQueries, check, check, check, exportResources, extractStepMetadataEntries, findAttribute, findParent, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, 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, analyseImpact, cancelQueries, check, check, exportResources, extractStepMetadataEntries, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, setChanged, setParentStepMeta, supportsErrorHandling

Constructor Detail

MetaInjectMeta

public MetaInjectMeta()

Method Detail

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

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

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.

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 BaseStepMeta

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

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 BaseStepMeta

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 BaseStepMeta

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)

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

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.

getTargetSourceMapping

public Map<TargetStepAttribute,SourceStepField> getTargetSourceMapping()

setTargetSourceMapping

public void setTargetSourceMapping(Map<TargetStepAttribute,SourceStepField> targetSourceMapping)

getTransName

public String getTransName()

Returns:

the transName

setTransName

public void setTransName(String transName)

Parameters:

transName - the transName to set

getFileName

public String getFileName()

Returns:

the fileName

setFileName

public void setFileName(String fileName)

Parameters:

fileName - the fileName to set

getDirectoryPath

public String getDirectoryPath()

Returns:

the directoryPath

setDirectoryPath

public void setDirectoryPath(String directoryPath)

Parameters:

directoryPath - the directoryPath to set

getTransObjectId

public org.pentaho.di.repository.ObjectId getTransObjectId()

Returns:

the transObjectId

setTransObjectId

public void setTransObjectId(org.pentaho.di.repository.ObjectId transObjectId)

Parameters:

transObjectId - the transObjectId to set

getSpecificationMethod

public org.pentaho.di.core.ObjectLocationSpecificationMethod getSpecificationMethod()

Returns:

the specificationMethod

setSpecificationMethod

public void setSpecificationMethod(org.pentaho.di.core.ObjectLocationSpecificationMethod specificationMethod)

Parameters:

specificationMethod - the specificationMethod to set

loadTransformationMeta

@Deprecated
public static final TransMeta loadTransformationMeta(MetaInjectMeta 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

loadTransformationMeta

public static final TransMeta loadTransformationMeta(MetaInjectMeta injectMeta,
                               Repository rep,
                               org.pentaho.metastore.api.IMetaStore metaStore,
                               org.pentaho.di.core.variables.VariableSpace space)
                                              throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

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(org.pentaho.di.core.variables.VariableSpace space,
                     Map<String,ResourceDefinition> definitions,
                     ResourceNamingInterface resourceNamingInterface,
                     Repository repository,
                     org.pentaho.metastore.api.IMetaStore metaStore)
                       throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException

excludeFromCopyDistributeVerification

public boolean excludeFromCopyDistributeVerification()

Description copied from class: BaseStepMeta

This method is added to exclude certain steps from copy/distribute checking.

Specified by:

excludeFromCopyDistributeVerification in interface StepMetaInterface

Overrides:

excludeFromCopyDistributeVerification 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

getSourceStepName

public String getSourceStepName()

Returns:

the sourceStepName

setSourceStepName

public void setSourceStepName(String sourceStepName)

Parameters:

sourceStepName - the sourceStepName to set

getTargetFile

public String getTargetFile()

Returns:

the targetFile

setTargetFile

public void setTargetFile(String targetFile)

Parameters:

targetFile - the targetFile to set

isNoExecution

public boolean isNoExecution()

Returns:

the noExecution

setNoExecution

public void setNoExecution(boolean noExecution)

Parameters:

noExecution - the noExecution 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.

getActiveReferencedObjectDescription

public String getActiveReferencedObjectDescription()

Specified by:

getActiveReferencedObjectDescription in interface StepMetaInterface

Overrides:

getActiveReferencedObjectDescription in class BaseStepMeta

Returns:

A description of the active referenced object in a transformation. Null if nothing special needs to be done or if the active metadata isn't different from design.

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:

meta - The metadata that references

index - the object index to load

rep - the repository

metaStore - metaStore

space - the variable space to use

Returns:

the referenced object once loaded

Throws:

org.pentaho.di.core.exception.KettleException

getStreamSourceStepname

public String getStreamSourceStepname()

setStreamSourceStepname

public void setStreamSourceStepname(String streamSourceStepname)

getStreamSourceStep

public StepMeta getStreamSourceStep()

setStreamSourceStep

public void setStreamSourceStep(StepMeta streamSourceStep)

getStreamTargetStepname

public String getStreamTargetStepname()

setStreamTargetStepname

public void setStreamTargetStepname(String streamTargetStepname)

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

getSourceOutputFields

public List<MetaInjectOutputField> getSourceOutputFields()

setSourceOutputFields

public void setSourceOutputFields(List<MetaInjectOutputField> sourceOutputFields)

onStepChange

public void onStepChange(TransMeta transMeta,
                StepMeta oldMeta,
                StepMeta newMeta)

Description copied from interface: StepMetaChangeListenerInterface

This method is called when a step was changed

Specified by:

onStepChange in interface StepMetaChangeListenerInterface

Parameters:

transMeta - TransMeta which include this steps

oldMeta - the previous meta, which changed

newMeta - the updated meta with new variables values