org.pentaho.di.trans.steps.textfileoutput

Class TextFileOutputMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.textfileoutput.TextFileOutputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface, ResolvableResource

Direct Known Subclasses:

TextFileOutputLegacyMeta

public class TextFileOutputMeta
extends BaseStepMeta
implements StepMetaInterface, ResolvableResource

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FILE_COMPRESSION_TYPE_NONE
protected static int	FILE_COMPRESSION_TYPE_ZIP
protected static String[]	fileCompressionTypeCodes
static String[]	formatMapperLineTerminator

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

attributes, databases, ioMeta, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
TextFileOutputMeta()

Method Summary

Modifier and Type	Method and Description
void	allocate(int nrfields)
String	buildFilename(String filename, String extension, VariableSpace space, int stepnr, String partnr, int splitnr, boolean ziparchive, TextFileOutputMeta meta)
String	buildFilename(VariableSpace space, int stepnr, String partnr, int splitnr, boolean ziparchive)
void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Checks the settings of this step and puts the findings in a remarks List.
Object	clone() Make an exact copy of this step, make sure to explicitly copy Collections etc.
String	exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively.
List<StepInjectionMetaEntry>	extractStepMetadataEntries()
String	getDateTimeFormat()
String	getEnclosure()
String	getEncoding()
String	getEndedLine()
String	getExtension()
void	getFields(RowMetaInterface inputRowMeta, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Deprecated.
void	getFields(RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
String	getFileCompression()
String	getFileFormat()
String	getFileName()
String	getFileNameField()
String[]	getFiles(VariableSpace space)
int	getFooterShift()
String	getNewline()
String	getNewLine(String fformat)
TextFileField[]	getOutputFields()
String	getSeparator()
int	getSplitEvery()
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans) Get the executing step, needed by Trans to launch a step.
StepDataInterface	getStepData() Get a new instance of the appropriate data class.
String	getXML() Produces the XML string that describes this step's information.
boolean	isAddToResultFiles()
boolean	isCreateParentFolder()
boolean	isDateInFilename()
boolean	isDoNotOpenNewFileInit()
boolean	isEnclosureFixDisabled()
boolean	isEnclosureForced()
boolean	isFastDump()
boolean	isFileAppended()
boolean	isFileNameInField()
boolean	isFooterEnabled()
boolean	isHeaderEnabled()
boolean	isPadded()
boolean	isPartNrInFilename()
boolean	isServletOutput()
boolean	isSpecifyingFormat()
boolean	isStepNrInFilename()
boolean	isTimeInFilename()
protected String	loadSource(Node stepnode, org.pentaho.metastore.api.IMetaStore metastore)
protected String	loadSourceRep(Repository rep, ObjectId id_step, org.pentaho.metastore.api.IMetaStore metaStore)
void	loadXML(Node stepnode, List<DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Node
boolean	passDataToServletOutput() True if the step passes it's result data straight to the servlet output.
void	readData(Node stepnode)
protected void	readData(Node stepnode, org.pentaho.metastore.api.IMetaStore metastore)
void	readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_step, List<DatabaseMeta> databases) Read the steps information from a Kettle repository
void	resolve() Resolves resource data elements variables and temporary references.
protected void	saveFileOptions(StringBuilder retval)
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
protected void	saveSource(StringBuilder retVal, String value)
protected void	saveSourceRep(Repository rep, ObjectId id_transformation, ObjectId id_step, String value)
void	setAddToResultFiles(boolean addtoresultfilenamesin)
void	setCreateParentFolder(boolean createparentfolder)
void	setDateInFilename(boolean dateInFilename)
void	setDateTimeFormat(String dateTimeFormat)
void	setDefault() Set default values
void	setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)
void	setEnclosure(String enclosure)
void	setEnclosureFixDisabled(boolean disableEnclosureFix)
void	setEnclosureForced(boolean enclosureForced)
void	setEncoding(String encoding)
void	setEndedLine(String endedLine)
void	setExtension(String extension)
void	setFastDump(boolean fastDump)
void	setFileAppended(boolean fileAppended)
void	setFileCompression(String fileCompression)
void	setFileFormat(String fileFormat)
void	setFilename(String fileName)
void	setFileName(String fileName)
void	setFileNameField(String fileNameField)
void	setFileNameInField(boolean fileNameInField)
void	setFooterEnabled(boolean footer)
void	setHeaderEnabled(boolean header)
void	setNewline(String newline)
void	setOutputFields(TextFileField[] outputFields)
void	setPadded(boolean padded)
void	setPartNrInFilename(boolean partNrInFilename)
void	setSeparator(String separator)
void	setServletOutput(boolean servletOutput)
void	setSpecifyingFormat(boolean specifyingFormat)
void	setSplitEvery(int splitEvery)
void	setStepNrInFilename(boolean stepNrInFilename)
void	setTimeInFilename(boolean timeInFilename)

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

analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, supportsErrorHandling

Methods inherited from class java.lang.Object

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

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

analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getActiveReferencedObjectDescription, getDialogClassName, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta, supportsErrorHandling

Field Detail

FILE_COMPRESSION_TYPE_NONE

protected static final int FILE_COMPRESSION_TYPE_NONE

See Also:

Constant Field Values

FILE_COMPRESSION_TYPE_ZIP

protected static final int FILE_COMPRESSION_TYPE_ZIP

See Also:

Constant Field Values

fileCompressionTypeCodes

protected static final String[] fileCompressionTypeCodes

formatMapperLineTerminator

public static final String[] formatMapperLineTerminator

Constructor Detail

TextFileOutputMeta

public TextFileOutputMeta()

Method Detail

isServletOutput

public boolean isServletOutput()

setServletOutput

public void setServletOutput(boolean servletOutput)

setCreateParentFolder

public void setCreateParentFolder(boolean createparentfolder)

Parameters:

createparentfolder - The createparentfolder to set.

isCreateParentFolder

public boolean isCreateParentFolder()

Returns:

Returns the createparentfolder.

isDateInFilename

public boolean isDateInFilename()

Returns:

Returns the dateInFilename.

setDateInFilename

public void setDateInFilename(boolean dateInFilename)

Parameters:

dateInFilename - The dateInFilename to set.

getEnclosure

public String getEnclosure()

Returns:

Returns the enclosure.

setEnclosure

public void setEnclosure(String enclosure)

Parameters:

enclosure - The enclosure to set.

isEnclosureForced

public boolean isEnclosureForced()

Returns:

Returns the enclosureForced.

setEnclosureForced

public void setEnclosureForced(boolean enclosureForced)

Parameters:

enclosureForced - The enclosureForced to set.

isEnclosureFixDisabled

public boolean isEnclosureFixDisabled()

Returns:

Returns the enclosureFixDisabled.

setEnclosureFixDisabled

public void setEnclosureFixDisabled(boolean disableEnclosureFix)

Parameters:

enclosureFixDisabled - The enclosureFixDisabled to set.

getExtension

public String getExtension()

Returns:

Returns the extension.

setExtension

public void setExtension(String extension)

Parameters:

extension - The extension to set.

isAddToResultFiles

public boolean isAddToResultFiles()

Returns:

Returns the add to result filesname.

setAddToResultFiles

public void setAddToResultFiles(boolean addtoresultfilenamesin)

Parameters:

addtoresultfilenamesin - The addtoresultfilenames to set.

isFileAppended

public boolean isFileAppended()

Returns:

Returns the fileAppended.

setFileAppended

public void setFileAppended(boolean fileAppended)

Parameters:

fileAppended - The fileAppended to set.

getFileFormat

public String getFileFormat()

Returns:

Returns the fileFormat.

setFileFormat

public void setFileFormat(String fileFormat)

Parameters:

fileFormat - The fileFormat to set.

getFileCompression

public String getFileCompression()

Returns:

Returns the fileCompression.

setFileCompression

public void setFileCompression(String fileCompression)

Parameters:

fileCompression - The fileCompression to set.

getFileName

public String getFileName()

Returns:

Returns the fileName.

setFileName

public void setFileName(String fileName)

Parameters:

fileName - The fileName to set.

isFooterEnabled

public boolean isFooterEnabled()

Returns:

Returns the footer.

setFooterEnabled

public void setFooterEnabled(boolean footer)

Parameters:

footer - The footer to set.

isHeaderEnabled

public boolean isHeaderEnabled()

Returns:

Returns the header.

setHeaderEnabled

public void setHeaderEnabled(boolean header)

Parameters:

header - The header to set.

getNewline

public String getNewline()

Returns:

Returns the newline.

setNewline

public void setNewline(String newline)

Parameters:

newline - The newline to set.

isPadded

public boolean isPadded()

Returns:

Returns the padded.

setPadded

public void setPadded(boolean padded)

Parameters:

padded - The padded to set.

isFastDump

public boolean isFastDump()

Returns:

Returns the fastDump.

setFastDump

public void setFastDump(boolean fastDump)

Parameters:

fastDump - The fastDump to set.

getSeparator

public String getSeparator()

Returns:

Returns the separator.

setSeparator

public void setSeparator(String separator)

Parameters:

separator - The separator to set.

isDoNotOpenNewFileInit

public boolean isDoNotOpenNewFileInit()

Returns:

Returns the "do not open new file at init" flag.

setDoNotOpenNewFileInit

public void setDoNotOpenNewFileInit(boolean doNotOpenNewFileInit)

Parameters:

doNotOpenNewFileInit - The "do not open new file at init" flag to set.

getSplitEvery

public int getSplitEvery()

Returns:

Returns the splitEvery.

getFooterShift

public int getFooterShift()

Returns:

1 if isFooterEnabled() and 0 otherwise

setSplitEvery

public void setSplitEvery(int splitEvery)

Parameters:

splitEvery - The splitEvery to set.

isStepNrInFilename

public boolean isStepNrInFilename()

Returns:

Returns the stepNrInFilename.

setStepNrInFilename

public void setStepNrInFilename(boolean stepNrInFilename)

Parameters:

stepNrInFilename - The stepNrInFilename to set.

isPartNrInFilename

public boolean isPartNrInFilename()

Returns:

Returns the partNrInFilename.

setPartNrInFilename

public void setPartNrInFilename(boolean partNrInFilename)

Parameters:

partNrInFilename - The partNrInFilename to set.

isTimeInFilename

public boolean isTimeInFilename()

Returns:

Returns the timeInFilename.

setTimeInFilename

public void setTimeInFilename(boolean timeInFilename)

Parameters:

timeInFilename - The timeInFilename to set.

isSpecifyingFormat

public boolean isSpecifyingFormat()

setSpecifyingFormat

public void setSpecifyingFormat(boolean specifyingFormat)

getDateTimeFormat

public String getDateTimeFormat()

setDateTimeFormat

public void setDateTimeFormat(String dateTimeFormat)

getOutputFields

public TextFileField[] getOutputFields()

Returns:

Returns the outputFields.

setOutputFields

public void setOutputFields(TextFileField[] outputFields)

Parameters:

outputFields - The outputFields to set.

getEncoding

public String getEncoding()

Returns:

The desired encoding of output file, null or empty if the default system encoding needs to be used.

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - The desired encoding of output file, null or empty if the default system encoding needs to be used.

getEndedLine

public String getEndedLine()

Returns:

The desired last line in the output file, null or empty if nothing has to be added.

setEndedLine

public void setEndedLine(String endedLine)

Parameters:

endedLine - The desired last line in the output file, null or empty if nothing has to be added.

isFileNameInField

public boolean isFileNameInField()

Returns:

Is the file name coded in a field?

setFileNameInField

public void setFileNameInField(boolean fileNameInField)

Parameters:

fileNameInField - Is the file name coded in a field?

getFileNameField

public String getFileNameField()

Returns:

The field name that contains the output file name.

setFileNameField

public void setFileNameField(String fileNameField)

Parameters:

fileNameField - Name of the field that contains the file name

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Overrides:

loadXML in class BaseStepMeta

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

metaStore - the metastore to optionally load external reference metadata from

Throws:

KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocate

public void allocate(int nrfields)

clone

public Object clone()

Description copied from interface: StepMetaInterface

Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:

clone in interface StepMetaInterface

Overrides:

clone in class BaseStepMeta

Returns:

an exact copy of this step

readData

protected void readData(Node stepnode,
                        org.pentaho.metastore.api.IMetaStore metastore)
                 throws KettleXMLException

Throws:

KettleXMLException

readData

public void readData(Node stepnode)
              throws KettleXMLException

Throws:

KettleXMLException

getNewLine

public String getNewLine(String fformat)

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getFiles

public String[] getFiles(VariableSpace space)

buildFilename

public String buildFilename(VariableSpace space,
                            int stepnr,
                            String partnr,
                            int splitnr,
                            boolean ziparchive)

buildFilename

public String buildFilename(String filename,
                            String extension,
                            VariableSpace space,
                            int stepnr,
                            String partnr,
                            int splitnr,
                            boolean ziparchive,
                            TextFileOutputMeta meta)

getFields

public void getFields(RowMetaInterface row,
                      String name,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws KettleStepException

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

row - the input row meta that is modified in this method to reflect the output row metadata of the step

name - Name of the step to use as input for the origin field in the values

info - Fields used as extra lookup information

nextStep - the next step that is targeted

space - the space The variable space to use to replace variables

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

Throws:

KettleStepException - the kettle step exception

getFields

@Deprecated
public void getFields(RowMetaInterface inputRowMeta,
                                  String name,
                                  RowMetaInterface[] info,
                                  StepMeta nextStep,
                                  VariableSpace space)
                           throws KettleStepException

Deprecated.

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

inputRowMeta - the input row meta that is modified in this method to reflect the output row metadata of the step

name - Name of the step to use as input for the origin field in the values

info - Fields used as extra lookup information

nextStep - the next step that is targeted

space - the space The variable space to use to replace variables

Throws:

KettleStepException - the kettle step exception

getXML

public String getXML()

Description copied from class: BaseStepMeta

Produces the XML string that describes this step's information.

Specified by:

getXML in interface StepMetaInterface

Overrides:

getXML in class BaseStepMeta

Returns:

String containing the XML describing this step.

saveFileOptions

protected void saveFileOptions(StringBuilder retval)

readRep

public void readRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_step,
                    List<DatabaseMeta> databases)
             throws KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Overrides:

readRep in class BaseStepMeta

Parameters:

rep - The repository to read from

metaStore - The MetaStore to read external information from

id_step - The step ID

databases - The databases to reference

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException

Description copied from interface: StepMetaInterface

Save the steps data into a Kettle repository

Specified by:

saveRep in interface StepMetaInterface

Overrides:

saveRep in class BaseStepMeta

Parameters:

rep - The Kettle repository to save to

metaStore - the metaStore to optionally write to

id_transformation - The transformation ID

id_step - The step ID

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info,
                  VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

Description copied from interface: StepMetaInterface

Checks the settings of this step and puts the findings in a remarks List.

Specified by:

check in interface StepMetaInterface

Overrides:

check in class BaseStepMeta

Parameters:

remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult

stepMeta - The stepMeta to help checking

prev - The fields coming from the previous step

input - The input step names

output - The output step names

info - The fields that are used as information by the step

space - the variable space to resolve variable expressions with

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta transMeta,
                             Trans trans)

Description copied from interface: StepMetaInterface

Get the executing step, needed by Trans to launch a step.

Specified by:

getStep in interface StepMetaInterface

Parameters:

stepMeta - The step info

stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.

cnr - The copy nr to get

transMeta - The transformation info

trans - The launching transformation

getStepData

public StepDataInterface getStepData()

Description copied from interface: StepMetaInterface

Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:

getStepData in interface StepMetaInterface

Returns:

The appropriate StepDataInterface class.

exportResources

public String exportResources(VariableSpace space,
                              Map<String,ResourceDefinition> definitions,
                              ResourceNamingInterface resourceNamingInterface,
                              Repository repository,
                              org.pentaho.metastore.api.IMetaStore metaStore)
                       throws KettleException

Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively. So what this does is turn the name of the base path into an absolute path.

Specified by:

exportResources in interface StepMetaInterface

Overrides:

exportResources in class BaseStepMeta

Parameters:

space - the variable space to use

definitions -

resourceNamingInterface -

repository - The repository to optionally load other resources from (to be converted to XML)

metaStore - the metaStore in which non-kettle metadata could reside.

Returns:

the filename of the exported resource

Throws:

KettleException

setFilename

public void setFilename(String fileName)

extractStepMetadataEntries

public List<StepInjectionMetaEntry> extractStepMetadataEntries()
                                                        throws KettleException

Specified by:

extractStepMetadataEntries in interface StepMetaInterface

Overrides:

extractStepMetadataEntries in class BaseStepMeta

Returns:

The step metadata itself, not the metadata description. For lists it will have 0 entries in case there are no entries.

Throws:

KettleException

loadSource

protected String loadSource(Node stepnode,
                            org.pentaho.metastore.api.IMetaStore metastore)

saveSource

protected void saveSource(StringBuilder retVal,
                          String value)

loadSourceRep

protected String loadSourceRep(Repository rep,
                               ObjectId id_step,
                               org.pentaho.metastore.api.IMetaStore metaStore)
                        throws KettleException

Throws:

KettleException

saveSourceRep

protected void saveSourceRep(Repository rep,
                             ObjectId id_transformation,
                             ObjectId id_step,
                             String value)
                      throws KettleException

Throws:

KettleException

passDataToServletOutput

public boolean passDataToServletOutput()

True if the step passes it's result data straight to the servlet output. See exposing Kettle data over a web service http://wiki.pentaho.com/display/EAI/PDI+data+over+web+services

Specified by:

passDataToServletOutput in interface StepMetaInterface

Returns:

True if the step passes it's result data straight to the servlet output, false otherwise

resolve

public void resolve()

Description copied from interface: ResolvableResource

Resolves resource data elements variables and temporary references.

Specified by:

resolve in interface ResolvableResource