Package org.pentaho.di.trans.step

Interface StepHelperInterface

All Known Implementing Classes:

BaseStepHelper, CalculatorHelper, CsvInputHelper, DatabaseLookupHelper, DenormaliserStepHelper, FormulaHelper, GetFilesRowCountHelper, GroupByHelper, InsertUpdateHelper, JobExecutorHelper, MappingHelper, MergeJoinHelper, MergeRowsHelper, RandomValueStepHelper, SelectValuesHelper, SimpleMappingHelper, SingleThreaderHelper, StreamLookupStepHelper, SystemDataStepHelper, TableInputHelper, TableOutputHelper, TextFileInputHelper, TextFileOutputHelper, TransExecutorHelper, UpdateHelper

public interface StepHelperInterface

Defines helper methods for executing "step actions" and common methods used by a step user interface (UI).

Step actions are step-specific, non-runtime operations invoked from a step dialog (e.g. fetching metadata, testing connections) whose results are displayed in the dialog.

They are not part of transformation or step execution logic.

This interface declares common response field constants and a default implementation that returns a "method not found" status when no action is implemented.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_STATUS
static final String	FAILURE_METHOD_NOT_FOUND_RESPONSE
static final String	FAILURE_RESPONSE
static final String	STATUS
static final String	SUCCESS_RESPONSE

Method Summary

Modifier and Type	Method	Description
default org.json.simple.JSONObject	stepAction(String method, TransMeta transMeta, Map<String,String> queryParams)	Default implementation for performing a step action.

Field Details

STATUS

static final String STATUS

See Also:

• Constant Field Values

ACTION_STATUS

static final String ACTION_STATUS

See Also:

• Constant Field Values

SUCCESS_RESPONSE

static final String SUCCESS_RESPONSE

See Also:

• Constant Field Values

FAILURE_RESPONSE

static final String FAILURE_RESPONSE

See Also:

• Constant Field Values

FAILURE_METHOD_NOT_FOUND_RESPONSE

static final String FAILURE_METHOD_NOT_FOUND_RESPONSE

See Also:

• Constant Field Values

Method Details

stepAction

default org.json.simple.JSONObject stepAction(String method,
 TransMeta transMeta,
 Map<String,String> queryParams)

Default implementation for performing a step action.

Parameters:

method - The name of the method to execute.

transMeta - The transformation metadata associated with the step.

queryParams - A map of query parameters for the action.

Returns:

A JSON object containing the action status, defaulting to a failure response if the method is not found.