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

Interface CsvInputAwareStepDialog

All Known Implementing Classes:

CsvInputDialog, TextFileInputDialog

public interface CsvInputAwareStepDialog

A common interface for all step dialogs aware of the csv input format, such as CsvInputDialog and TextFileInputDialog

Method Summary

Modifier and Type	Method	Description
default org.pentaho.di.trans.steps.fileinput.text.BufferedInputStreamReader	getBufferedReader(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta, InputStream inputStream)
CsvInputAwareImportProgressDialog	getCsvImportProgressDialog(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta, int samples, InputStreamReader reader)
default String[]	getFieldNames(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta)
default String[]	getFieldNamesImpl(org.pentaho.di.trans.steps.fileinput.text.BufferedInputStreamReader reader, org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta)
InputStream	getInputStream(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta)	Returns the InputStream corresponding to the csv file, or null if the file cannot be read.
org.pentaho.di.core.logging.LogChannel	getLogChannel()
default InputStreamReader	getReader(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta, InputStream inputStream)	Returns the InputStreamReader corresponding to the csv file, or null if the file cannot be read.
org.pentaho.di.trans.TransMeta	getTransMeta()
default String	loadFieldsImpl(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta, int samples)
default void	logError(String message)
default void	logError(String message, Exception exception)
default String	massageFieldName(String fieldName)	Custom handling of each field can be implemented here.

Method Detail

getFieldNames

default String[] getFieldNames(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta)

getFieldNamesImpl

default String[] getFieldNamesImpl(org.pentaho.di.trans.steps.fileinput.text.BufferedInputStreamReader reader,
                                   org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta)
                            throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

massageFieldName

default String massageFieldName(String fieldName)

Custom handling of each field can be implemented here.

getInputStream

InputStream getInputStream(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta)

Returns the InputStream corresponding to the csv file, or null if the file cannot be read.

Returns:

the InputStream corresponding to the csv file, or null if the file cannot be read

getReader

default InputStreamReader getReader(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta,
                                    InputStream inputStream)

Returns the InputStreamReader corresponding to the csv file, or null if the file cannot be read.

Returns:

the InputStreamReader corresponding to the csv file, or null if the file cannot be read

getBufferedReader

default org.pentaho.di.trans.steps.fileinput.text.BufferedInputStreamReader getBufferedReader(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta,
                                                                                              InputStream inputStream)

loadFieldsImpl

default String loadFieldsImpl(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta,
                              int samples)

getCsvImportProgressDialog

CsvInputAwareImportProgressDialog getCsvImportProgressDialog(org.pentaho.di.trans.steps.common.CsvInputAwareMeta meta,
                                                             int samples,
                                                             InputStreamReader reader)

logError

default void logError(String message,
                      Exception exception)

logError

default void logError(String message)

getLogChannel

org.pentaho.di.core.logging.LogChannel getLogChannel()

getTransMeta

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