Package org.pentaho.di.trans.steps.fileinput.text

Class CsvFileImportProcessor

java.lang.Object

org.pentaho.di.trans.steps.fileinput.text.BaseFileImportProcessor

org.pentaho.di.trans.steps.fileinput.text.CsvFileImportProcessor

public class CsvFileImportProcessor
extends BaseFileImportProcessor

This class is used to process CSV files in CsvInput step

Field Summary

Fields inherited from class org.pentaho.di.trans.steps.fileinput.text.BaseFileImportProcessor

debug, encodingType, inputFields, log, message, reader, replaceMeta, rowNumber, samples, showSummary, transMeta

Constructor Summary

Constructors

Constructor	Description
CsvFileImportProcessor(CsvInputMeta meta, TransMeta transMeta, BufferedInputStreamReader reader, int samples, boolean showSummary)

Method Summary

Modifier and Type	Method	Description
protected Object	cloneMeta()	Clones the metadata object.
protected TextFileInputFieldDTO	convertFieldToDto(Object field)	Converts a field to a Data Transfer Object (DTO).
protected Object[]	convertLineToRow(TextFileLine textFileLine, Object strinfo, org.pentaho.di.core.row.RowMetaInterface outputRowMeta, org.pentaho.di.core.row.RowMetaInterface convertRowMeta, boolean failOnParseError)	Converts a line from the file into a row of data.
protected String	getEnclosure()	Retrieves the enclosure character used in the file.
protected String	getEscapeCharacter()	Retrieves the escape character used in the file.
protected Object	getField(Object metaObj, int index)	Retrieves a field from the metadata at the specified index.
protected int	getFieldCount()	Returns the number of fields in the file.
protected String	getFieldFormat(Object field)	Retrieves the format of a field.
protected int	getFieldLength(Object field)	Retrieves the length of a field.
protected String	getFieldName(Object field)	Retrieves the name of a field.
protected int	getFieldPrecision(Object field)	Retrieves the precision of a field.
protected void	getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta)	Populates the row metadata with field information.
protected int	getFieldType(Object field)	Retrieves the type of a field.
protected String	getFieldTypeDesc(Object field)	Retrieves the type description of a field.
protected int	getFileFormatTypeNr()	Retrieves the file format type number.
protected int	getHeaderLines()	Retrieves the number of header lines in the file.
protected boolean	hasHeader()	Checks if the file has a header.
protected void	initializeField(Object field, DecimalFormatSymbols dfs)	Initializes a field with the given decimal format symbols.
protected void	setAllFieldsToStringType(Object metaObj)	Sets all fields in the metadata to string type.
protected void	setFieldTypeInfo(Object field, org.pentaho.di.core.util.StringEvaluator evaluator, List<org.pentaho.di.core.util.StringEvaluationResult> evaluationResults, org.pentaho.di.core.util.StringEvaluationResult strEvaluationResult)	Sets type information for a field based on evaluation results.

Methods inherited from class org.pentaho.di.trans.steps.fileinput.text.BaseFileImportProcessor

analyzeFile, getInputFields, getInputFieldsDto, getMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CsvFileImportProcessor

public CsvFileImportProcessor(CsvInputMeta meta,
 TransMeta transMeta,
 BufferedInputStreamReader reader,
 int samples,
 boolean showSummary)

Method Details

getFieldCount

protected int getFieldCount()

Description copied from class: BaseFileImportProcessor

Returns the number of fields in the file.

Specified by:

getFieldCount in class BaseFileImportProcessor

Returns:

the field count

getFieldName

protected String getFieldName(Object field)

Description copied from class: BaseFileImportProcessor

Retrieves the name of a field.

Specified by:

getFieldName in class BaseFileImportProcessor

Parameters:

field - the field to retrieve the name for

Returns:

the field name

getFieldTypeDesc

protected String getFieldTypeDesc(Object field)

Description copied from class: BaseFileImportProcessor

Retrieves the type description of a field.

Specified by:

getFieldTypeDesc in class BaseFileImportProcessor

Parameters:

field - the field to retrieve the type description for

Returns:

the field type description

getFieldType

protected int getFieldType(Object field)

Description copied from class: BaseFileImportProcessor

Retrieves the type of a field.

Specified by:

getFieldType in class BaseFileImportProcessor

Parameters:

field - the field to retrieve the type for

Returns:

the field type

getFieldLength

protected int getFieldLength(Object field)

Description copied from class: BaseFileImportProcessor

Retrieves the length of a field.

Specified by:

getFieldLength in class BaseFileImportProcessor

Parameters:

field - the field to retrieve the length for

Returns:

the field length

getFieldPrecision

protected int getFieldPrecision(Object field)

Description copied from class: BaseFileImportProcessor

Retrieves the precision of a field.

Specified by:

getFieldPrecision in class BaseFileImportProcessor

Parameters:

field - the field to retrieve the precision for

Returns:

the field precision

getFieldFormat

protected String getFieldFormat(Object field)

Description copied from class: BaseFileImportProcessor

Retrieves the format of a field.

Specified by:

getFieldFormat in class BaseFileImportProcessor

Parameters:

field - the field to retrieve the format for

Returns:

the field format

hasHeader

protected boolean hasHeader()

Description copied from class: BaseFileImportProcessor

Checks if the file has a header.

Specified by:

hasHeader in class BaseFileImportProcessor

Returns:

true if the file has a header, false otherwise

getHeaderLines

protected int getHeaderLines()

Description copied from class: BaseFileImportProcessor

Retrieves the number of header lines in the file.

Specified by:

getHeaderLines in class BaseFileImportProcessor

Returns:

the number of header lines

getEnclosure

protected String getEnclosure()

Description copied from class: BaseFileImportProcessor

Retrieves the enclosure character used in the file.

Specified by:

getEnclosure in class BaseFileImportProcessor

Returns:

the enclosure character

getEscapeCharacter

protected String getEscapeCharacter()

Description copied from class: BaseFileImportProcessor

Retrieves the escape character used in the file.

Specified by:

getEscapeCharacter in class BaseFileImportProcessor

Returns:

the escape character

getFileFormatTypeNr

protected int getFileFormatTypeNr()

Description copied from class: BaseFileImportProcessor

Retrieves the file format type number.

Specified by:

getFileFormatTypeNr in class BaseFileImportProcessor

Returns:

the file format type number

getField

protected Object getField(Object metaObj,
 int index)

Description copied from class: BaseFileImportProcessor

Retrieves a field from the metadata at the specified index.

Specified by:

getField in class BaseFileImportProcessor

Parameters:

metaObj - the metadata object

index - the index of the field

Returns:

the field object

getFields

protected void getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta)
                  throws org.pentaho.di.core.exception.KettleStepException

Description copied from class: BaseFileImportProcessor

Populates the row metadata with field information.

Specified by:

getFields in class BaseFileImportProcessor

Parameters:

rowMeta - the row metadata to populate

Throws:

org.pentaho.di.core.exception.KettleStepException - if an error occurs while populating the metadata

cloneMeta

protected Object cloneMeta()

Description copied from class: BaseFileImportProcessor

Clones the metadata object.

Specified by:

cloneMeta in class BaseFileImportProcessor

Returns:

the cloned metadata object

initializeField

protected void initializeField(Object field,
 DecimalFormatSymbols dfs)

Description copied from class: BaseFileImportProcessor

Initializes a field with the given decimal format symbols.

Specified by:

initializeField in class BaseFileImportProcessor

Parameters:

field - the field to initialize

dfs - the decimal format symbols

setFieldTypeInfo

protected void setFieldTypeInfo(Object field,
 org.pentaho.di.core.util.StringEvaluator evaluator,
 List<org.pentaho.di.core.util.StringEvaluationResult> evaluationResults,
 org.pentaho.di.core.util.StringEvaluationResult strEvaluationResult)

Description copied from class: BaseFileImportProcessor

Sets type information for a field based on evaluation results.

Specified by:

setFieldTypeInfo in class BaseFileImportProcessor

Parameters:

field - the field to set type information for

evaluator - the string evaluator

evaluationResults - the list of evaluation results

strEvaluationResult - the advised evaluation result

convertLineToRow

protected Object[] convertLineToRow(TextFileLine textFileLine,
 Object strinfo,
 org.pentaho.di.core.row.RowMetaInterface outputRowMeta,
 org.pentaho.di.core.row.RowMetaInterface convertRowMeta,
 boolean failOnParseError)
                             throws org.pentaho.di.core.exception.KettleException

Description copied from class: BaseFileImportProcessor

Converts a line from the file into a row of data.

Specified by:

convertLineToRow in class BaseFileImportProcessor

Parameters:

textFileLine - the line of text to convert

strinfo - metadata information

outputRowMeta - the output row metadata

convertRowMeta - the converted row metadata

failOnParseError - whether to fail on parse errors

Returns:

the converted row as an object array

Throws:

org.pentaho.di.core.exception.KettleException - if an error occurs during conversion

setAllFieldsToStringType

protected void setAllFieldsToStringType(Object metaObj)

Description copied from class: BaseFileImportProcessor

Sets all fields in the metadata to string type.

Specified by:

setAllFieldsToStringType in class BaseFileImportProcessor

Parameters:

metaObj - the metadata object

convertFieldToDto

protected TextFileInputFieldDTO convertFieldToDto(Object field)

Description copied from class: BaseFileImportProcessor

Converts a field to a Data Transfer Object (DTO).

Specified by:

convertFieldToDto in class BaseFileImportProcessor

Parameters:

field - the field to convert

Returns:

the field DTO