org.pentaho.di.trans.step

Interface StepMetaInjectionInterface

All Known Implementing Classes:

AccessInputMetaInjection, ConcatFieldsMetaInjection, CsvInputMeta, DataGridMetaInjection, DenormaliserMetaInjection, ExcelInputMetaInjection, ExcelOutputMetaInjection, ExcelWriterMetaInjection, FieldSplitterMetaInjection, FixedInputMetaInjection, GetXMLDataMetaInjection, GroupByMetaInjection, JaninoMetaInjection, JsonOutputMetaInjection, MonetDBAgileMartMeta, MonetDBBulkLoaderMeta, NormaliserMetaInjection, ParGzipCsvInputMetaInjection, PentahoReportingOutputMetaInjection, PGBulkLoaderMeta, SelectValuesMeta, SortRowsMetaInjection, TableInputMetaInjection, TableOutputMetaInjection, TextFileInputMetaInjection, TextFileOutputMetaInjection

public interface StepMetaInjectionInterface

This interface allows an external program to inject metadata using a standard flat set of metadata attributes.

Author:

matt

Method Summary

Methods

Modifier and Type	Method and Description
List<StepInjectionMetaEntry>	extractStepMetadataEntries() Extracts the step metadata in a standard fashion.
List<StepInjectionMetaEntry>	getStepInjectionMetadataEntries()
void	injectStepMetadataEntries(List<StepInjectionMetaEntry> metadata) Inject the metadata specified into the step metadata

Method Detail

getStepInjectionMetadataEntries

List<StepInjectionMetaEntry> getStepInjectionMetadataEntries()
                                                             throws org.pentaho.di.core.exception.KettleException

Returns:

A list of step injection metadata entries. In case the data type of the entry is NONE (0) you will get at least one entry in the details section. You can use this list to see a description of all the metadata.

Throws:

org.pentaho.di.core.exception.KettleException

injectStepMetadataEntries

void injectStepMetadataEntries(List<StepInjectionMetaEntry> metadata)
                               throws org.pentaho.di.core.exception.KettleException

Inject the metadata specified into the step metadata

Parameters:

metadata - the metadata to inject.

Throws:

org.pentaho.di.core.exception.KettleException

extractStepMetadataEntries

List<StepInjectionMetaEntry> extractStepMetadataEntries()
                                                        throws org.pentaho.di.core.exception.KettleException

Extracts the step metadata in a standard fashion. Enables unit testing more easily by extracting the step metadata and then doing the re-injection into an empty step.

Returns:

A list of step injection metadata entries in a standard fashion. Includes both the entry and the value for the entry.

Throws:

org.pentaho.di.core.exception.KettleException