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, StepMetaInterface

public class MetaInjectMeta
extends BaseStepMeta
implements StepMetaInterface

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

MetaInjectMeta()

Method Summary

void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, 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	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	getDirectoryPath()
void	getFields(RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Get the fields that are emitted by this step
String	getFileName()
String	getSourceStepName()
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.
Map<TargetStepAttribute,SourceStepField>	getTargetSourceMapping()
String	getTransName()
ObjectId	getTransObjectId()
String	getXML() Produces the XML string that describes this step's information.
static TransMeta	loadTransformationMeta(MetaInjectMeta 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	readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) Read the steps information from a Kettle repository
void	saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
void	setDefault() Set default values
void	setDirectoryPath(String directoryPath)
void	setFileName(String fileName)
void	setSourceStepName(String sourceStepName)
void	setSpecificationMethod(ObjectLocationSpecificationMethod specificationMethod)
void	setTargetSourceMapping(Map<TargetStepAttribute,SourceStepField> targetSourceMapping)
void	setTransName(String transName)
void	setTransObjectId(ObjectId transObjectId)

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

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

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)

getFields

public void getFields(RowMetaInterface rowMeta,
                      String origin,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException

Description copied from interface: StepMetaInterface

Get the fields that are emitted by this step

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

rowMeta - The fields that are entering the step. These are changed to reflect the output metadata.

origin - The name of the step to be used as origin

info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]

nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.

space - TODO

Throws:

KettleStepException - when an error occurred searching for the 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.

getTargetSourceMapping

public Map<TargetStepAttribute,SourceStepField> getTargetSourceMapping()

setTargetSourceMapping

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

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  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

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

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

loadTransformationMeta

public static final TransMeta loadTransformationMeta(MetaInjectMeta mappingMeta,
                                                     Repository rep,
                                                     VariableSpace space)
                                              throws KettleException

Throws:

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