org.pentaho.di.trans.steps.textfileinput

Class TextFileInput

java.lang.Object

org.pentaho.di.trans.step.BaseStep

org.pentaho.di.trans.steps.textfileinput.TextFileInput

All Implemented Interfaces:

org.pentaho.di.core.ExtensionDataInterface, HasLogChannelInterface, org.pentaho.di.core.logging.LoggingObjectInterface, org.pentaho.di.core.variables.VariableSpace, StepInterface

public class TextFileInput
extends BaseStep
implements StepInterface

Read all sorts of text files, convert them to rows and writes these to one or more output streams.

Since:

4-apr-2003

Author:

Matt

Field Summary

Fields inherited from class org.pentaho.di.trans.step.BaseStep

first, linesInput, linesOutput, linesRead, linesRejected, linesSkipped, linesUpdated, linesWritten, terminator, terminator_rows

Constructor Summary

Constructors

Constructor and Description
TextFileInput(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)

Method Summary

Methods

Modifier and Type	Method and Description
static Object[]	convertLineToRow(org.pentaho.di.core.logging.LogChannelInterface log, TextFileLine textFileLine, InputFileMetaInterface info, Object[] passThruFields, int nrPassThruFields, org.pentaho.di.core.row.RowMetaInterface outputRowMeta, org.pentaho.di.core.row.RowMetaInterface convertRowMeta, String fname, long rowNr, String delimiter, String enclosure, String escapeCharacter, FileErrorHandler errorHandler, boolean addShortFilename, boolean addExtension, boolean addPath, boolean addSize, boolean addIsHidden, boolean addLastModificationDate, boolean addUri, boolean addRootUri, String shortFilename, String path, boolean hidden, Date modificationDateTime, String uri, String rooturi, String extension, long size)
static Object[]	convertLineToRow(org.pentaho.di.core.logging.LogChannelInterface log, TextFileLine textFileLine, InputFileMetaInterface info, org.pentaho.di.core.row.RowMetaInterface outputRowMeta, org.pentaho.di.core.row.RowMetaInterface convertRowMeta, String fname, long rowNr, String delimiter, FileErrorHandler errorHandler, boolean addShortFilename, boolean addExtension, boolean addPath, boolean addSize, boolean addIsHidden, boolean addLastModificationDate, boolean addUri, boolean addRootUri, String shortFilename, String path, boolean hidden, Date modificationDateTime, String uri, String rooturi, String extension, long size) Deprecated. Use #convertLineToRow(TextFileLine,InputFileMetaInterface,Object[],int,RowMetaInterface,RowMetaInterface,String,long, FileErrorHandler) instead
static String[]	convertLineToStrings(org.pentaho.di.core.logging.LogChannelInterface log, String line, InputFileMetaInterface inf, String delimiter, String enclosure, String escapeCharacters)
void	dispose(StepMetaInterface smi, StepDataInterface sdi) Dispose of this step: close files, empty logs, etc.
static String	getLine(org.pentaho.di.core.logging.LogChannelInterface log, InputStreamReader reader, EncodingType encodingType, int formatNr, StringBuilder line)
static String	getLine(org.pentaho.di.core.logging.LogChannelInterface log, InputStreamReader reader, int formatNr, StringBuilder line)
static String[]	guessStringsFromLine(org.pentaho.di.core.logging.LogChannelInterface log, String line, TextFileInputMeta inf, String delimiter) Deprecated.
static String[]	guessStringsFromLine(org.pentaho.di.core.variables.VariableSpace space, org.pentaho.di.core.logging.LogChannelInterface log, String line, TextFileInputMeta inf, String delimiter, String enclosure, String escapeCharacter)
boolean	init(StepMetaInterface smi, StepDataInterface sdi) Initialize and do work where other steps need to wait for...
boolean	isWaitingForData()
boolean	processRow(StepMetaInterface smi, StepDataInterface sdi) Perform the equivalent of processing one row.

Methods inherited from class org.pentaho.di.trans.step.BaseStep

addResultFile, addRowListener, addStepListener, batchComplete, buildLog, canProcessOneRow, cleanup, closeQuietly, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, environmentSubstitute, environmentSubstitute, fieldSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getContainerObjectId, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getDispatcher, getErrorRowMeta, getErrors, getExtensionDataMap, getFilename, getInputRowMeta, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesSkipped, getLinesUpdated, getLinesWritten, getLogChannel, getLogChannelId, getLogFields, getLogLevel, getMetaStore, getNextClassNr, getObjectCopy, getObjectId, getObjectName, getObjectRevision, getObjectType, getOutputRowSets, getParent, getParentVariableSpace, getPartitionID, getPartitionTargets, getPreviewRowMeta, getProcessed, getRegistrationDate, getRemoteInputSteps, getRemoteOutputSteps, getRepartitioning, getRepository, getRepositoryDirectory, getResultFiles, getRow, getRowFrom, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isForcingSeparateLogging, isGatheringMetrics, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, safeModeChecking, setCarteObjectId, setCopy, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setDistributed, setErrorRowMeta, setErrors, setForcingSeparateLogging, setGatheringMetrics, setInputRowMeta, setInputRowSets, setInternalVariables, setLinesInput, setLinesOutput, setLinesRead, setLinesRejected, setLinesSkipped, setLinesUpdated, setLinesWritten, setLogLevel, setMetaStore, setOutputDone, setOutputRowSets, setParentVariableSpace, setPartitioned, setPartitionID, setPartitionTargets, setPaused, setPaused, setPreviewRowMeta, setRepartitioning, setRepository, setRunning, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopAll, stopRunning, stopRunning, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.di.trans.step.StepInterface

addRowListener, addStepListener, batchComplete, canProcessOneRow, cleanup, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getErrors, getInputRowSets, getLinesInput, getLinesOutput, getLinesRead, getLinesRejected, getLinesUpdated, getLinesWritten, getLogChannel, getMetaStore, getOutputRowSets, getPartitionID, getProcessed, getRepository, getResultFiles, getRow, getRowListeners, getRuntime, getStatus, getStepID, getStepMeta, getStepname, getTrans, identifyErrorOutput, initBeforeStart, isMapping, isPartitioned, isPaused, isRunning, isStopped, isUsingThreadPriorityManagment, markStart, markStop, pauseRunning, putRow, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, setCurrentInputRowSetNr, setCurrentOutputRowSetNr, setErrors, setLinesRejected, setMetaStore, setOutputDone, setPartitioned, setPartitionID, setRepartitioning, setRepository, setRunning, setStopped, setUsingThreadPriorityManagment, stopAll, stopRunning

Methods inherited from interface org.pentaho.di.core.variables.VariableSpace

copyVariablesFrom, environmentSubstitute, environmentSubstitute, fieldSubstitute, getBooleanValueOfVariable, getParentVariableSpace, getVariable, getVariable, initializeVariablesFrom, injectVariables, listVariables, setParentVariableSpace, setVariable, shareVariablesWith

Constructor Detail

TextFileInput

public TextFileInput(StepMeta stepMeta,
             StepDataInterface stepDataInterface,
             int copyNr,
             TransMeta transMeta,
             Trans trans)

Method Detail

getLine

public static final String getLine(org.pentaho.di.core.logging.LogChannelInterface log,
             InputStreamReader reader,
             int formatNr,
             StringBuilder line)
                            throws org.pentaho.di.core.exception.KettleFileException

Throws:

org.pentaho.di.core.exception.KettleFileException

getLine

public static final String getLine(org.pentaho.di.core.logging.LogChannelInterface log,
             InputStreamReader reader,
             EncodingType encodingType,
             int formatNr,
             StringBuilder line)
                            throws org.pentaho.di.core.exception.KettleFileException

Throws:

org.pentaho.di.core.exception.KettleFileException

guessStringsFromLine

@Deprecated
public static final String[] guessStringsFromLine(org.pentaho.di.core.logging.LogChannelInterface log,
                                       String line,
                                       TextFileInputMeta inf,
                                       String delimiter)
                                           throws org.pentaho.di.core.exception.KettleException

Deprecated.

Throws:

org.pentaho.di.core.exception.KettleException

guessStringsFromLine

public static final String[] guessStringsFromLine(org.pentaho.di.core.variables.VariableSpace space,
                            org.pentaho.di.core.logging.LogChannelInterface log,
                            String line,
                            TextFileInputMeta inf,
                            String delimiter,
                            String enclosure,
                            String escapeCharacter)
                                           throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

convertLineToStrings

public static final String[] convertLineToStrings(org.pentaho.di.core.logging.LogChannelInterface log,
                            String line,
                            InputFileMetaInterface inf,
                            String delimiter,
                            String enclosure,
                            String escapeCharacters)
                                           throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

convertLineToRow

@Deprecated
public static final Object[] convertLineToRow(org.pentaho.di.core.logging.LogChannelInterface log,
                                   TextFileLine textFileLine,
                                   InputFileMetaInterface info,
                                   org.pentaho.di.core.row.RowMetaInterface outputRowMeta,
                                   org.pentaho.di.core.row.RowMetaInterface convertRowMeta,
                                   String fname,
                                   long rowNr,
                                   String delimiter,
                                   FileErrorHandler errorHandler,
                                   boolean addShortFilename,
                                   boolean addExtension,
                                   boolean addPath,
                                   boolean addSize,
                                   boolean addIsHidden,
                                   boolean addLastModificationDate,
                                   boolean addUri,
                                   boolean addRootUri,
                                   String shortFilename,
                                   String path,
                                   boolean hidden,
                                   Date modificationDateTime,
                                   String uri,
                                   String rooturi,
                                   String extension,
                                   long size)
                                       throws org.pentaho.di.core.exception.KettleException

Deprecated. Use #convertLineToRow(TextFileLine,InputFileMetaInterface,Object[],int,RowMetaInterface,RowMetaInterface,String,long, FileErrorHandler) instead

Throws:

org.pentaho.di.core.exception.KettleException

convertLineToRow

public static final Object[] convertLineToRow(org.pentaho.di.core.logging.LogChannelInterface log,
                        TextFileLine textFileLine,
                        InputFileMetaInterface info,
                        Object[] passThruFields,
                        int nrPassThruFields,
                        org.pentaho.di.core.row.RowMetaInterface outputRowMeta,
                        org.pentaho.di.core.row.RowMetaInterface convertRowMeta,
                        String fname,
                        long rowNr,
                        String delimiter,
                        String enclosure,
                        String escapeCharacter,
                        FileErrorHandler errorHandler,
                        boolean addShortFilename,
                        boolean addExtension,
                        boolean addPath,
                        boolean addSize,
                        boolean addIsHidden,
                        boolean addLastModificationDate,
                        boolean addUri,
                        boolean addRootUri,
                        String shortFilename,
                        String path,
                        boolean hidden,
                        Date modificationDateTime,
                        String uri,
                        String rooturi,
                        String extension,
                        long size)
                                       throws org.pentaho.di.core.exception.KettleException

Throws:

org.pentaho.di.core.exception.KettleException

processRow

public boolean processRow(StepMetaInterface smi,
                 StepDataInterface sdi)
                   throws org.pentaho.di.core.exception.KettleException

Description copied from interface: StepInterface

Perform the equivalent of processing one row. Typically this means reading a row from input (getRow()) and passing a row to output (putRow)).

Specified by:

processRow in interface StepInterface

Overrides:

processRow in class BaseStep

Parameters:

smi - The steps metadata to work with

sdi - The steps temporary working data to work with (database connections, result sets, caches, temporary variables, etc.)

Returns:

false if no more rows can be processed or an error occurred.

Throws:

org.pentaho.di.core.exception.KettleException

init

public boolean init(StepMetaInterface smi,
           StepDataInterface sdi)

Description copied from interface: StepInterface

Initialize and do work where other steps need to wait for...

Specified by:

init in interface StepInterface

Overrides:

init in class BaseStep

Parameters:

smi - The metadata to work with

sdi - The data to initialize

dispose

public void dispose(StepMetaInterface smi,
           StepDataInterface sdi)

Description copied from interface: StepInterface

Dispose of this step: close files, empty logs, etc.

Specified by:

dispose in interface StepInterface

Overrides:

dispose in class BaseStep

Parameters:

smi - The metadata to work with

sdi - The data to dispose of

isWaitingForData

public boolean isWaitingForData()