org.pentaho.di.trans.steps.textfileoutput

Class TextFileOutput

java.lang.Object

org.pentaho.di.trans.step.BaseStep

org.pentaho.di.trans.steps.textfileoutput.TextFileOutput

All Implemented Interfaces:

ExtensionDataInterface, HasLogChannelInterface, LoggingObjectInterface, VariableSpace, StepInterface

Direct Known Subclasses:

ConcatFields

public class TextFileOutput
extends BaseStep
implements StepInterface

Converts input rows to text and then writes this text to one or more files.

Since:

4-apr-2003

Author:

Matt

Field Summary

Fields

Modifier and Type	Field and Description
TextFileOutputData	data
TextFileOutputMeta	meta

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	buildFilename(String filename, boolean ziparchive)
boolean	checkPreviouslyOpened(String filename)
protected boolean	closeFile()
boolean	containsSeparatorOrEnclosure(byte[] source, byte[] separator, byte[] enclosure)
void	dispose(StepMetaInterface smi, StepDataInterface sdi) Dispose of this step: close files, empty logs, etc.
protected org.apache.commons.vfs2.FileObject	getFileObject(String vfsFilename)
protected org.apache.commons.vfs2.FileObject	getFileObject(String vfsFilename, VariableSpace space)
protected OutputStream	getOutputStream(String vfsFilename, VariableSpace space, boolean append)
boolean	init(StepMetaInterface smi, StepDataInterface sdi) Initialize and do work where other steps need to wait for...
void	openNewFile(String baseFilename)
boolean	processRow(StepMetaInterface smi, StepDataInterface sdi) Perform the equivalent of processing one row.
protected boolean	writeEndedLine()
protected boolean	writeHeader()
void	writeRowToFile(RowMetaInterface rowMeta, Object[] r)

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

addResultFile, addRowListener, addStepListener, batchComplete, buildLog, canProcessOneRow, checkFeedback, 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, 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, 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, setServerSockets, setSocketRepository, setStepDataInterface, setStepListeners, setStepMeta, setStepMetaInterface, setStepname, setStopped, setTransMeta, setUsingThreadPriorityManagment, setVariable, shareVariablesWith, stopAll, stopRunning, stopRunning, toString, verifyInputDeadLock, waitUntilTransformationIsStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

Field Detail

meta

public TextFileOutputMeta meta

data

public TextFileOutputData data

Constructor Detail

TextFileOutput

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

Method Detail

processRow

public boolean processRow(StepMetaInterface smi,
                          StepDataInterface sdi)
                   throws 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:

KettleException

writeRowToFile

public void writeRowToFile(RowMetaInterface rowMeta,
                           Object[] r)
                    throws KettleStepException

Throws:

KettleStepException

writeEndedLine

protected boolean writeEndedLine()

writeHeader

protected boolean writeHeader()

buildFilename

public String buildFilename(String filename,
                            boolean ziparchive)

openNewFile

public void openNewFile(String baseFilename)
                 throws KettleException

Throws:

KettleException

closeFile

protected boolean closeFile()

checkPreviouslyOpened

public boolean checkPreviouslyOpened(String filename)

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

containsSeparatorOrEnclosure

public boolean containsSeparatorOrEnclosure(byte[] source,
                                            byte[] separator,
                                            byte[] enclosure)

getFileObject

protected org.apache.commons.vfs2.FileObject getFileObject(String vfsFilename)
                                                    throws KettleFileException

Throws:

KettleFileException

getFileObject

protected org.apache.commons.vfs2.FileObject getFileObject(String vfsFilename,
                                                           VariableSpace space)
                                                    throws KettleFileException

Throws:

KettleFileException

getOutputStream

protected OutputStream getOutputStream(String vfsFilename,
                                       VariableSpace space,
                                       boolean append)
                                throws KettleFileException

Throws:

KettleFileException