StepMetaInterface

Method Summary
`void`	`analyseImpact(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)` Each step must be able to report on the impact it has on a database, table field, etc.
`void`	`cancelQueries()` Call this to cancel trailing database queries (too long running, etc)
`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`	`exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository)`
`String`	`getDialogClassName()` Get the name of the class that implements the dialog for this job entry JobEntryBase provides a default
`void`	`getFields(RowMetaInterface inputRowMeta, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)` Get the fields that are emitted by this step
`List<StreamInterface>`	`getOptionalStreams()`
`StepMeta`	`getParentStepMeta()`
`RowMetaInterface`	`getRequiredFields(VariableSpace space)` The natural way of data flow in a transformation is source-to-target.
`List<ResourceReference>`	`getResourceDependencies(TransMeta transMeta, StepMeta stepMeta)` Get a list of all the resource dependencies that the step is depending on.
`SQLStatement`	`getSQLStatements(TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev)` Standard method to return an SQLStatement object with SQL statements that the step needs in order to work correctly.
`StepInterface`	`getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, 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.
`StepMetaInjectionInterface`	`getStepMetaInjectionInterface()`
`TransMeta.TransformationType[]`	`getSupportedTransformationTypes()`
`RowMetaInterface`	`getTableFields()`
`Map<String,String>`	`getUsedArguments()` Default a step doesn't use any arguments.
`DatabaseMeta[]`	`getUsedDatabaseConnections()` This method returns all the database connections that are used by the step.
`String[]`	`getUsedLibraries()`
`String`	`getXML()` Get the XML that represents the values in this step
`void`	`handleStreamSelection(StreamInterface stream)` When an optional stream is selected, this method is called to handled the ETL metadata implications of that.
`boolean`	`hasRepositoryReferences()`
`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()` For steps that handle dynamic input (info) or output (target) streams, it is useful to be able to force the recreate the StepIoMeta definition.
`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`	`setDefault()` Set default values
`void`	`setParentStepMeta(StepMeta parentStepMeta)` Provide original lineage for this metadata object
`boolean`	`supportsErrorHandling()`

Method Detail

setDefault

void setDefault()

Set default values

getFields

void getFields(RowMetaInterface inputRowMeta,
               String name,
               RowMetaInterface[] info,
               StepMeta nextStep,
               VariableSpace space)
               throws KettleStepException

Get the fields that are emitted by this step

Parameters:: inputRowMeta - The fields that are entering the step. These are changed to reflect the output metadata.; name - 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.

getXML

String getXML()
              throws KettleException

Get the XML that represents the values in this step

Returns:: the XML that represents the metadata in this step
Throws:: KettleException - in case there is a conversion or XML encoding error

loadXML

void loadXML(Node stepnode,
             List<DatabaseMeta> databases,
             Map<String,Counter> counters)
             throws KettleXMLException

Load the values for this step from an XML Node

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

saveRep

void saveRep(Repository rep,
             ObjectId id_transformation,
             ObjectId id_step)
             throws KettleException

Save the steps data into a Kettle repository

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)

readRep

void readRep(Repository rep,
             ObjectId id_step,
             List<DatabaseMeta> databases,
             Map<String,Counter> counters)
             throws KettleException

Read the steps information from a Kettle repository

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)

check

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.

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

clone

Object clone()

Make an exact copy of this step, make sure to explicitly copy Collections etc.

Returns:: an exact copy of this step

getTableFields

RowMetaInterface getTableFields()

Returns:: The fields used by this step, this is being used for the Impact analyses.

excludeFromRowLayoutVerification

boolean excludeFromRowLayoutVerification()

This method is added to exclude certain steps from layout checking.

Since:: 2.5.0

excludeFromCopyDistributeVerification

boolean excludeFromCopyDistributeVerification()

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

Since:: 4.0.0

getDialogClassName

String getDialogClassName()

Get the name of the class that implements the dialog for this job entry JobEntryBase provides a default

getStep

StepInterface getStep(StepMeta stepMeta,
                      StepDataInterface stepDataInterface,
                      int copyNr,
                      TransMeta transMeta,
                      Trans trans)

Get the executing step, needed by Trans to launch a step.

Parameters:: stepMeta - The step info; stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.; copyNr - The copy nr to get; transMeta - The transformation info; trans - The launching transformation

getStepData

StepDataInterface getStepData()

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.

Returns:: The appropriate StepDataInterface class.

analyseImpact

void analyseImpact(List<DatabaseImpact> impact,
                   TransMeta transMeta,
                   StepMeta stepMeta,
                   RowMetaInterface prev,
                   String[] input,
                   String[] output,
                   RowMetaInterface info)
                   throws KettleStepException

Each step must be able to report on the impact it has on a database, table field, etc.

Parameters:: impact - The list of impacts @see org.pentaho.di.transMeta.DatabaseImpact; transMeta - The transformation information; stepMeta - The step information; prev - The fields entering this step; input - The previous step names; output - The output step names; info - The fields used as information by this step
Throws:: KettleStepException

getSQLStatements

SQLStatement getSQLStatements(TransMeta transMeta,
                              StepMeta stepMeta,
                              RowMetaInterface prev)
                              throws KettleStepException

Standard method to return an SQLStatement object with SQL statements that the step needs in order to work correctly. This can mean "create table", "create index" statements but also "alter table ... add/drop/modify" statements.

Parameters:: transMeta - TransInfo object containing the complete transformation; stepMeta - StepMeta object containing the complete step; prev - Row containing meta-data for the input fields (no data)
Returns:: The SQL Statements for this step. If nothing has to be done, the SQLStatement.getSQL() == null. @see SQLStatement
Throws:: KettleStepException

cancelQueries

void cancelQueries()
                   throws KettleDatabaseException

Call this to cancel trailing database queries (too long running, etc)

Throws:: KettleDatabaseException

getUsedArguments

Map<String,String> getUsedArguments()

Default a step doesn't use any arguments. Implement this to notify the GUI that a window has to be displayed BEFORE launching a transformation. You can also use this to specify certain Environment variable values.

Returns:: A Map of argument values. (name and optionally a default value) Put 10 values in the map for the possible 10 arguments.

getRequiredFields

RowMetaInterface getRequiredFields(VariableSpace space)
                                   throws KettleException

The natural way of data flow in a transformation is source-to-target. However, this makes mapping to target tables difficult to do. To help out here, we supply information to the transformation meta-data model about which fields are required for a step. This allows us to automate certain tasks like the mapping to pre-defined tables. The Table Output step in this case will output the fields in the target table using this method.

Parameters:: space - the variable space to reference
Returns:: the required fields for this steps metadata.
Throws:: KettleException - in case the required fields can't be determined.

getUsedDatabaseConnections

DatabaseMeta[] getUsedDatabaseConnections()

This method returns all the database connections that are used by the step.

Returns:: an array of database connections meta-data. Return an empty array if no connections are used.

getUsedLibraries

String[] getUsedLibraries()

Returns:: the libraries that this step or plugin uses.

supportsErrorHandling

boolean supportsErrorHandling()

Returns:: true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.

getResourceDependencies

List<ResourceReference> getResourceDependencies(TransMeta transMeta,
                                                StepMeta stepMeta)

Get a list of all the resource dependencies that the step is depending on.

Parameters:: transMeta -; stepMeta -
Returns:: a list of all the resource dependencies that the step is depending on

exportResources

String exportResources(VariableSpace space,
                       Map<String,ResourceDefinition> definitions,
                       ResourceNamingInterface resourceNamingInterface,
                       Repository repository)
                       throws KettleException

Parameters:: space - the variable space to use; definitions -; resourceNamingInterface -; repository - The repository to optionally load other resources from (to be converted to XML)
Returns:: the filename of the exported resource
Throws:: KettleException

getParentStepMeta

StepMeta getParentStepMeta()

Returns:: The StepMeta object to which this metadata class belongs. With this, we can see to which transformation metadata (etc) this metadata pertains to. (hierarchy)

setParentStepMeta

void setParentStepMeta(StepMeta parentStepMeta)

Provide original lineage for this metadata object

Parameters:: parentStepMeta - the parent step metadata container object

getStepIOMeta

StepIOMetaInterface getStepIOMeta()

Returns the Input/Output metadata for this step.

getOptionalStreams

List<StreamInterface> getOptionalStreams()

Returns:: The list of optional input streams. It allows the user to select from a list of possible actions like "New target step"

handleStreamSelection

void handleStreamSelection(StreamInterface stream)

When an optional stream is selected, this method is called to handled the ETL metadata implications of that.

Parameters:: stream - The optional stream to handle.

resetStepIoMeta

void resetStepIoMeta()

For steps that handle dynamic input (info) or output (target) streams, it is useful to be able to force the recreate the StepIoMeta definition. By default this definition is cached.

searchInfoAndTargetSteps

void searchInfoAndTargetSteps(List<StepMeta> steps)

Change step names into step objects to allow them to be name-changed etc.

Parameters:: steps - the steps to reference

getStepMetaInjectionInterface

StepMetaInjectionInterface getStepMetaInjectionInterface()

Returns:: Optional interface that allows an external program to inject step metadata in a standardized fasion. This method will return null if the interface is not available for this step.

getSupportedTransformationTypes

TransMeta.TransformationType[] getSupportedTransformationTypes()

Returns:: The supported transformation types that this step supports.

hasRepositoryReferences

boolean hasRepositoryReferences()

Returns:: True if the job entry defines one or more references to a repository object.

lookupRepositoryReferences

void lookupRepositoryReferences(Repository repository)
                                throws KettleException

Look up the references after import

Parameters:: repository - the repository to reference.
Throws:: KettleException

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.pentaho.di.trans.step Interface StepMetaInterface