org.pentaho.di.trans.steps.file

类 BaseFileInputStep<M extends BaseFileInputMeta<?,?,?>,D extends BaseFileInputStepData>

java.lang.Object

org.pentaho.di.trans.step.BaseStep

org.pentaho.di.trans.steps.file.BaseFileInputStep<M,D>

所有已实现的接口:

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

直接已知子类:

TextFileInput

public abstract class BaseFileInputStep<M extends BaseFileInputMeta<?,?,?>,D extends BaseFileInputStepData>
extends BaseStep
implements IBaseFileInputStepControl

This class contains base functionality for file-based input steps.

作者:

Alexander Buloichik

字段概要

字段

限定符和类型	字段和说明
protected D	data
protected M	meta

从类继承的字段 org.pentaho.di.trans.step.BaseStep

deadLockCounter, extensionDataMap, first, linesInput, linesOutput, linesRead, linesRejected, linesSkipped, linesUpdated, linesWritten, log, metaStore, repository, rowListeners, safeStopped, terminator, terminator_rows, variables

构造器概要

构造器

构造器和说明
BaseFileInputStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans)

方法概要

限定符和类型	方法和说明
boolean	checkFeedback(long lines) Check feedback.
protected void	closeLastFile() Close last opened file/
protected abstract IBaseFileInputReader	createReader(M meta, D data, org.apache.commons.vfs2.FileObject file) Create reader for specific file.
void	dispose(StepMetaInterface smi, StepDataInterface sdi) Dispose step.
boolean	failAfterBadFile(String errorMsg)
protected void	fillFileAdditionalFields(D data, org.apache.commons.vfs2.FileObject file) Prepare file-dependent data for fill additional fields.
protected boolean	handleOpenFileException(Exception e)
protected abstract boolean	init() Content-dependent initialization.
boolean	init(StepMetaInterface smi, StepDataInterface sdi) Initialize step before execute.
protected boolean	openNextFile() Open next VFS file for processing.
protected void	prepareToRowProcessing() Prepare to process.
boolean	processRow(StepMetaInterface smi, StepDataInterface sdi) Process next row.

从类继承的方法 org.pentaho.di.trans.step.BaseStep

addResultFile, addRowListener, addRowSetToInputRowSets, addRowSetToOutputRowSets, addStepListener, batchComplete, buildLog, canProcessOneRow, cleanup, clearInputRowSets, clearOutputRowSets, closeQuietly, copyVariablesFrom, decrementLinesRead, decrementLinesWritten, dispatch, environmentSubstitute, environmentSubstitute, fieldSubstitute, findInputRowSet, findInputRowSet, findOutputRowSet, findOutputRowSet, getBooleanValueOfVariable, getClusterSize, getContainerObjectId, getCopy, getCurrentInputRowSetNr, getCurrentOutputRowSetNr, getDispatcher, getErrorRowMeta, getErrors, getExtensionDataMap, getFilename, getFirstInputRowSet, 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, getRowHandler, getRowListeners, getRuntime, getServerSockets, getSlaveNr, getSocketRepository, getStatus, getStatusDescription, getStepDataInterface, getStepID, getStepListeners, getStepMeta, getStepMetaInterface, getStepname, getTrans, getTransMeta, getTypeId, getUniqueStepCountAcrossSlaves, getUniqueStepNrAcrossSlaves, getVariable, getVariable, handleGetRowFrom, handlePutRowTo, identifyErrorOutput, incrementLinesInput, incrementLinesOutput, incrementLinesRead, incrementLinesRejected, incrementLinesSkipped, incrementLinesUpdated, incrementLinesWritten, initBeforeStart, initializeVariablesFrom, injectVariables, isBasic, isDebug, isDetailed, isDistributed, isForcingSeparateLogging, isGatheringMetrics, isInitialising, isMapping, isPartitioned, isPaused, isRowLevel, isRunning, isSafeStopped, isStopped, isUsingThreadPriorityManagment, listVariables, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, logSummary, markStart, markStop, openRemoteInputStepSocketsOnce, openRemoteOutputStepSocketsOnce, outputIsDone, pauseRunning, putError, putRow, putRowTo, removeRowListener, resumeRunning, rowsetInputSize, rowsetOutputSize, safeModeChecking, 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, setRowHandler, setRunning, setSafeStopped, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopAll, stopRunning, stopRunning, swapFirstInputRowSetIfExists, toString, verifyInputDeadLock, waitUntilTransformationIsStarted

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.pentaho.di.trans.steps.file.IBaseFileInputStepControl

getErrors, getLinesInput, getLinesWritten, incrementLinesInput, incrementLinesUpdated, putRow, setErrors, stopAll

从接口继承的方法 org.pentaho.di.trans.step.StepInterface

subStatuses

字段详细资料

meta

protected M extends BaseFileInputMeta<?,?,?> meta

data

protected D extends BaseFileInputStepData data

构造器详细资料

BaseFileInputStep

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

方法详细资料

init

protected abstract boolean init()

Content-dependent initialization.

createReader

protected abstract IBaseFileInputReader createReader(M meta,
                                                     D data,
                                                     org.apache.commons.vfs2.FileObject file)
                                              throws Exception

Create reader for specific file.

抛出:

Exception

init

public boolean init(StepMetaInterface smi,
                    StepDataInterface sdi)

Initialize step before execute.

指定者:

init 在接口中 StepInterface

覆盖:

init 在类中 BaseStep

参数:

smi - The metadata to work with

sdi - The data to initialize

openNextFile

protected boolean openNextFile()

Open next VFS file for processing. This method will support different parallelization methods later.

handleOpenFileException

protected boolean handleOpenFileException(Exception e)

processRow

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

Process next row. This methods opens next file automatically.

指定者:

processRow 在接口中 StepInterface

覆盖:

processRow 在类中 BaseStep

参数:

smi - The steps metadata to work with

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

返回:

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

抛出:

org.pentaho.di.core.exception.KettleException

prepareToRowProcessing

protected void prepareToRowProcessing()
                               throws org.pentaho.di.core.exception.KettleException

Prepare to process. Executed only first time row processing. It can't be possible to prepare to process in the init() phrase, because files can be in fields from previous step.

抛出:

org.pentaho.di.core.exception.KettleException

checkFeedback

public boolean checkFeedback(long lines)

从类复制的说明: BaseStep

Check feedback.

指定者:

checkFeedback 在接口中 IBaseFileInputStepControl

覆盖:

checkFeedback 在类中 BaseStep

参数:

lines - the lines

返回:

true, if successful

closeLastFile

protected void closeLastFile()

Close last opened file/

dispose

public void dispose(StepMetaInterface smi,
                    StepDataInterface sdi)

Dispose step.

指定者:

dispose 在接口中 StepInterface

覆盖:

dispose 在类中 BaseStep

参数:

smi - The metadata to work with

sdi - The data to dispose of

failAfterBadFile

public boolean failAfterBadFile(String errorMsg)

指定者:

failAfterBadFile 在接口中 IBaseFileInputStepControl

参数:

errorMsg - Message to send to rejected row if enabled

返回:

If should stop processing after having problems with a file

fillFileAdditionalFields

protected void fillFileAdditionalFields(D data,
                                        org.apache.commons.vfs2.FileObject file)
                                 throws org.apache.commons.vfs2.FileSystemException

Prepare file-dependent data for fill additional fields.

抛出:

org.apache.commons.vfs2.FileSystemException