Package org.pentaho.di.ui.trans.step.common

Interface GetFieldsCapableStepDialog<StepMetaType extends org.pentaho.di.trans.step.BaseStepMeta>

All Known Implementing Classes:

CsvInputDialog, TextFileInputDialog

public interface GetFieldsCapableStepDialog<StepMetaType extends org.pentaho.di.trans.step.BaseStepMeta>

An interface providing functionality for any step dialog that has the "get fields" capability.

Field Summary

Fields

Modifier and Type	Field	Description
static org.pentaho.di.core.logging.LogChannel	logger
static Class<?>	PKG

Method Summary

Modifier and Type	Method	Description
default org.eclipse.swt.widgets.TableItem	findTableItem(String fieldName)
void	getData(StepMetaType inputMeta, boolean copyStepName, boolean reloadAllFields, Set<String> newFieldNames)
String[]	getFieldNames(StepMetaType meta)	Returns an array of incoming field names, or an empty array, if fields cannot be fetched, for some reason.
default void	getFields()	This can be called by the "Get fields" button handler to inherit the common "get fields" behavior.
default void	getFields(StepMetaType meta)
TableView	getFieldsTable()
default Map<String,List<String>>	getFieldValues()
default List<String>	getNewFieldNames(String[] incomingFieldNames)
StepMetaType	getNewMetaInstance()
org.eclipse.swt.widgets.Shell	getParent()	Returns the Shell of the parent control.
default StepMetaType	getPopulatedMeta()
org.eclipse.swt.widgets.Shell	getShell()	Returns the Shell of this dialog.
default org.eclipse.swt.widgets.TableItem	getTableItem(String fieldName)
default org.eclipse.swt.widgets.TableItem	getTableItem(String fieldName, boolean reloadAllFields)
org.pentaho.di.trans.TransMeta	getTransMeta()
default String	loadFields(StepMetaType meta, int samples, boolean reloadAllFields)
String	loadFieldsImpl(StepMetaType meta, int samples)
default void	loadRemainingFields(Map<String,List<String>> previousFieldValues)
default void	openGetFieldsSampleDataDialog(boolean reloadAllFields)
void	populateMeta(StepMetaType meta)
default Set<String>	repopulateFields(StepMetaType meta, Map<String,List<String>> previousFieldValues, boolean reloadAllFields)

Field Detail

PKG

static final Class<?> PKG

logger

static final org.pentaho.di.core.logging.LogChannel logger

Method Detail

getParent

org.eclipse.swt.widgets.Shell getParent()

Returns the Shell of the parent control.

Returns:

the Shell of the parent control

getShell

org.eclipse.swt.widgets.Shell getShell()

Returns the Shell of this dialog.

Returns:

the Shell of this dialog

getFieldNames

String[] getFieldNames(StepMetaType meta)

Returns an array of incoming field names, or an empty array, if fields cannot be fetched, for some reason.

Parameters:

meta - the GetFieldsCapableStepDialog

Returns:

an array of incoming field names, or an empty array, if fields cannot be fetched, for some reason.

getFieldsTable

TableView getFieldsTable()

Returns:

the TableView containing step fields

findTableItem

default org.eclipse.swt.widgets.TableItem findTableItem(String fieldName)

getNewFieldNames

default List<String> getNewFieldNames(String[] incomingFieldNames)

getFields

default void getFields()

This can be called by the "Get fields" button handler to inherit the common "get fields" behavior.

getFields

default void getFields(StepMetaType meta)

openGetFieldsSampleDataDialog

default void openGetFieldsSampleDataDialog(boolean reloadAllFields)

loadFieldsImpl

String loadFieldsImpl(StepMetaType meta,
                      int samples)

getFieldValues

default Map<String,List<String>> getFieldValues()

repopulateFields

default Set<String> repopulateFields(StepMetaType meta,
                                     Map<String,List<String>> previousFieldValues,
                                     boolean reloadAllFields)

loadRemainingFields

default void loadRemainingFields(Map<String,List<String>> previousFieldValues)

loadFields

default String loadFields(StepMetaType meta,
                          int samples,
                          boolean reloadAllFields)

getTableItem

default org.eclipse.swt.widgets.TableItem getTableItem(String fieldName)

getTableItem

default org.eclipse.swt.widgets.TableItem getTableItem(String fieldName,
                                                       boolean reloadAllFields)

getData

void getData(StepMetaType inputMeta,
             boolean copyStepName,
             boolean reloadAllFields,
             Set<String> newFieldNames)

getPopulatedMeta

default StepMetaType getPopulatedMeta()

populateMeta

void populateMeta(StepMetaType meta)

getNewMetaInstance

StepMetaType getNewMetaInstance()

getTransMeta

org.pentaho.di.trans.TransMeta getTransMeta()