org.pentaho.di.trans.steps.textfileinput

Class TextFileInputMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.textfileinput.TextFileInputMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface, InputFileMetaInterface

Deprecated.

replaced by implementation in the ...steps.fileinput.text package

@Deprecated
public class TextFileInputMeta
extends BaseStepMeta
implements StepMetaInterface, InputFileMetaInterface

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILE_FORMAT_DOS Deprecated.
static int	FILE_FORMAT_MIXED Deprecated.
static int	FILE_FORMAT_UNIX Deprecated.
static int	FILE_TYPE_CSV Deprecated.
static int	FILE_TYPE_FIXED Deprecated.
static String[]	RequiredFilesCode Deprecated.
static String[]	RequiredFilesDesc Deprecated.

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
TextFileInputMeta() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	allocate(int nrfiles, int nrfields, int nrfilters) Deprecated.
void	allocateFiles(int nrFiles) Deprecated.
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Deprecated. Checks the settings of this step and puts the findings in a remarks List.
Object	clone() Deprecated. Make an exact copy of this step, make sure to explicitly copy Collections etc.
String	exportResources(org.pentaho.di.core.variables.VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Deprecated. Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively.
String	getAcceptingField() Deprecated.
StepMeta	getAcceptingStep() Deprecated.
String	getAcceptingStepName() Deprecated.
Locale	getDateFormatLocale() Deprecated.
String	getEnclosure() Deprecated.
String	getEncoding() Deprecated.
String	getErrorCountField() Deprecated.
String	getErrorFieldsField() Deprecated.
String	getErrorFilesDestinationDirectory() Deprecated.
String	getErrorLineFilesExtension() Deprecated.
String	getErrorTextField() Deprecated.
String	getEscapeCharacter() Deprecated.
String[]	getExludeFileMask() Deprecated.
String	getExtensionField() Deprecated.
void	getFields(org.pentaho.di.core.row.RowMetaInterface inputRowMeta, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space) Deprecated.
void	getFields(org.pentaho.di.core.row.RowMetaInterface row, String name, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Deprecated. Gets the fields.
String	getFileCompression() Deprecated.
String	getFileErrorField() Deprecated.
String	getFileErrorMessageField() Deprecated.
String	getFileFormat() Deprecated.
int	getFileFormatTypeNr() Deprecated.
String[]	getFileMask() Deprecated.
String[]	getFileName() Deprecated.
String	getFilenameField() Deprecated.
String[]	getFilePaths(org.pentaho.di.core.variables.VariableSpace space) Deprecated.
String[]	getFileRequired() Deprecated.
String	getFileType() Deprecated.
int	getFileTypeNr() Deprecated.
TextFileFilter[]	getFilter() Deprecated.
String[]	getIncludeSubFolders() Deprecated.
String[]	getInfoSteps() Deprecated.
TextFileInputField[]	getInputFields() Deprecated.
String	getLastModificationDateField() Deprecated.
String	getLineNumberFilesDestinationDirectory() Deprecated.
String	getLineNumberFilesExtension() Deprecated.
String	getLookupStepname() Deprecated.
int	getNrFooterLines() Deprecated.
int	getNrHeaderLines() Deprecated.
int	getNrLinesDocHeader() Deprecated.
int	getNrLinesPerPage() Deprecated.
int	getNrWraps() Deprecated.
String	getPathField() Deprecated.
String	getRequiredFilesCode(String tt) Deprecated.
String	getRequiredFilesDesc(String tt) Deprecated.
List<ResourceReference>	getResourceDependencies(TransMeta transMeta, StepMeta stepInfo) Deprecated. Get a list of all the resource dependencies that the step is depending on.
String	getRootUriField() Deprecated.
long	getRowLimit() Deprecated.
String	getRowNumberField() Deprecated.
String	getSeparator() Deprecated.
String	getShortFileNameField() Deprecated.
String	getSizeField() Deprecated.
StepInterface	getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans) Deprecated. Get the executing step, needed by Trans to launch a step.
StepDataInterface	getStepData() Deprecated. Get a new instance of the appropriate data class.
StepMetaInjectionInterface	getStepMetaInjectionInterface() Deprecated.
org.pentaho.di.core.fileinput.FileInputList	getTextFileList(org.pentaho.di.core.variables.VariableSpace space) Deprecated.
String	getUriField() Deprecated.
String	getWarningFilesDestinationDirectory() Deprecated.
String	getWarningFilesExtension() Deprecated.
String	getXML() Deprecated. Produces the XML string that describes this step's information.
boolean	hasFooter() Deprecated.
boolean	hasHeader() Deprecated.
boolean	includeFilename() Deprecated.
boolean	includeRowNumber() Deprecated.
boolean	isAcceptingFilenames() Deprecated.
boolean	isAddResultFile() Deprecated.
boolean	isBreakInEnclosureAllowed() Deprecated.
boolean	isDateFormatLenient() Deprecated.
boolean	isErrorIgnored() Deprecated.
boolean	isErrorLineSkipped() Deprecated.
String	isHiddenField() Deprecated.
boolean	isLayoutPaged() Deprecated.
boolean	isLineWrapped() Deprecated.
boolean	isPassingThruFields() Deprecated.
boolean	isRowNumberByFile() Deprecated. true if row number reset for each file
boolean	isSkipBadFiles() Deprecated.
void	loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Deprecated. Load the values for this step from an XML Node
boolean	noEmptyLines() Deprecated.
void	readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) Deprecated. Read the steps information from a Kettle repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) Deprecated. Save the steps data into a Kettle repository
void	searchInfoAndTargetSteps(List<StepMeta> steps) Deprecated. Change step names into step objects to allow them to be name-changed etc.
void	setAcceptingField(String fileNameField) Deprecated.
void	setAcceptingFilenames(boolean getFileFromJob) Deprecated.
void	setAcceptingStep(StepMeta acceptingStep) Deprecated.
void	setAcceptingStepName(String acceptingStep) Deprecated.
void	setAddResultFile(boolean isaddresult) Deprecated.
void	setBreakInEnclosureAllowed(boolean breakInEnclosureAllowed) Deprecated.
void	setDateFormatLenient(boolean dateFormatLenient) Deprecated.
void	setDateFormatLocale(Locale dateFormatLocale) Deprecated.
void	setDefault() Deprecated. Set default values
void	setEnclosure(String enclosure) Deprecated.
void	setEncoding(String encoding) Deprecated.
void	setErrorCountField(String errorCountField) Deprecated.
void	setErrorFieldsField(String errorFieldsField) Deprecated.
void	setErrorFilesDestinationDirectory(String errorFilesDestinationDirectory) Deprecated.
void	setErrorIgnored(boolean errorIgnored) Deprecated.
void	setErrorLineFilesExtension(String errorLineFilesExtension) Deprecated.
void	setErrorLineSkipped(boolean errorLineSkipped) Deprecated.
void	setErrorTextField(String errorTextField) Deprecated.
void	setEscapeCharacter(String escapeCharacter) Deprecated.
void	setExcludeFileMask(String[] excludeFileMask) Deprecated.
void	setExtensionField(String field) Deprecated.
void	setFileCompression(String fileCompression) Deprecated.
void	setFileErrorField(String field) Deprecated.
void	setFileErrorMessageField(String field) Deprecated.
void	setFileFormat(String fileFormat) Deprecated.
void	setFileMask(String[] fileMask) Deprecated.
void	setFileName(String[] fileName) Deprecated.
void	setFilenameField(String filenameField) Deprecated.
void	setFileNameForTest(String[] fileName) Deprecated.
void	setFileRequired(String[] fileRequiredin) Deprecated.
void	setFileType(String fileType) Deprecated.
void	setFilter(TextFileFilter[] filter) Deprecated.
void	setFooter(boolean footer) Deprecated.
void	setHeader(boolean header) Deprecated.
void	setIncludeFilename(boolean includeFilename) Deprecated.
void	setIncludeRowNumber(boolean includeRowNumber) Deprecated.
void	setIncludeSubFolders(String[] includeSubFoldersin) Deprecated.
void	setInputFields(TextFileInputField[] inputFields) Deprecated.
void	setIsHiddenField(String field) Deprecated.
void	setLastModificationDateField(String field) Deprecated.
void	setLayoutPaged(boolean layoutPaged) Deprecated.
void	setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory) Deprecated.
void	setLineNumberFilesExtension(String lineNumberFilesExtension) Deprecated.
void	setLineWrapped(boolean lineWrapped) Deprecated.
void	setNoEmptyLines(boolean noEmptyLines) Deprecated.
void	setNrFooterLines(int nrFooterLines) Deprecated.
void	setNrHeaderLines(int nrHeaderLines) Deprecated.
void	setNrLinesDocHeader(int nrLinesDocHeader) Deprecated.
void	setNrLinesPerPage(int nrLinesPerPage) Deprecated.
void	setNrWraps(int nrWraps) Deprecated.
void	setPassingThruFields(boolean passingThruFields) Deprecated.
void	setPathField(String field) Deprecated.
void	setRootUriField(String field) Deprecated.
void	setRowLimit(long rowLimit) Deprecated.
void	setRowNumberByFile(boolean rowNumberByFile) Deprecated.
void	setRowNumberField(String rowNumberField) Deprecated.
void	setSeparator(String separator) Deprecated.
void	setShortFileNameField(String field) Deprecated.
void	setSizeField(String field) Deprecated.
void	setSkipBadFiles(boolean value) Deprecated.
void	setUriField(String field) Deprecated.
void	setWarningFilesDestinationDirectory(String warningFilesDestinationDirectory) Deprecated.
void	setWarningFilesExtension(String warningFilesExtension) Deprecated.
boolean	supportsErrorHandling() Deprecated.

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

RequiredFilesDesc

public static final String[] RequiredFilesDesc

Deprecated.

RequiredFilesCode

public static final String[] RequiredFilesCode

Deprecated.

FILE_FORMAT_DOS

public static final int FILE_FORMAT_DOS

Deprecated.

See Also:

Constant Field Values

FILE_FORMAT_UNIX

public static final int FILE_FORMAT_UNIX

Deprecated.

See Also:

Constant Field Values

FILE_FORMAT_MIXED

public static final int FILE_FORMAT_MIXED

Deprecated.

See Also:

Constant Field Values

FILE_TYPE_CSV

public static final int FILE_TYPE_CSV

Deprecated.

See Also:

Constant Field Values

FILE_TYPE_FIXED

public static final int FILE_TYPE_FIXED

Deprecated.

See Also:

Constant Field Values

Constructor Detail

TextFileInputMeta

public TextFileInputMeta()

Deprecated.

Method Detail

getShortFileNameField

public String getShortFileNameField()

Deprecated.

Returns:

Returns the shortFileFieldName.

setShortFileNameField

public void setShortFileNameField(String field)

Deprecated.

Parameters:

field - The shortFileFieldName to set.

getPathField

public String getPathField()

Deprecated.

Returns:

Returns the pathFieldName.

setPathField

public void setPathField(String field)

Deprecated.

Parameters:

field - The pathFieldName to set.

isHiddenField

public String isHiddenField()

Deprecated.

Returns:

Returns the hiddenFieldName.

setIsHiddenField

public void setIsHiddenField(String field)

Deprecated.

Parameters:

field - The hiddenFieldName to set.

getLastModificationDateField

public String getLastModificationDateField()

Deprecated.

Returns:

Returns the lastModificationTimeFieldName.

setLastModificationDateField

public void setLastModificationDateField(String field)

Deprecated.

Parameters:

field - The lastModificationTimeFieldName to set.

getUriField

public String getUriField()

Deprecated.

Returns:

Returns the uriNameFieldName.

setUriField

public void setUriField(String field)

Deprecated.

Parameters:

field - The uriNameFieldName to set.

getRootUriField

public String getRootUriField()

Deprecated.

Returns:

Returns the uriNameFieldName.

setRootUriField

public void setRootUriField(String field)

Deprecated.

Parameters:

field - The rootUriNameFieldName to set.

getExtensionField

public String getExtensionField()

Deprecated.

Returns:

Returns the extensionFieldName.

setExtensionField

public void setExtensionField(String field)

Deprecated.

Parameters:

field - The extensionFieldName to set.

getSizeField

public String getSizeField()

Deprecated.

Returns:

Returns the sizeFieldName.

setSizeField

public void setSizeField(String field)

Deprecated.

Parameters:

field - The sizeFieldName to set.

isSkipBadFiles

public boolean isSkipBadFiles()

Deprecated.

Returns:

If should continue processing after failing to open a file

setSkipBadFiles

public void setSkipBadFiles(boolean value)

Deprecated.

Parameters:

value - If should continue processing after failing to open a file

getFileErrorField

public String getFileErrorField()

Deprecated.

setFileErrorField

public void setFileErrorField(String field)

Deprecated.

getFileErrorMessageField

public String getFileErrorMessageField()

Deprecated.

setFileErrorMessageField

public void setFileErrorMessageField(String field)

Deprecated.

getEncoding

public String getEncoding()

Deprecated.

Returns:

Returns the encoding.

setEncoding

public void setEncoding(String encoding)

Deprecated.

Parameters:

encoding - The encoding to set.

getInputFields

public TextFileInputField[] getInputFields()

Deprecated.

Specified by:

getInputFields in interface InputFileMetaInterface

Returns:

Returns the input fields.

setInputFields

public void setInputFields(TextFileInputField[] inputFields)

Deprecated.

Parameters:

inputFields - The input fields to set.

getEnclosure

public String getEnclosure()

Deprecated.

Specified by:

getEnclosure in interface InputFileMetaInterface

Returns:

Returns the enclosure.

setEnclosure

public void setEnclosure(String enclosure)

Deprecated.

Parameters:

enclosure - The enclosure to set.

isBreakInEnclosureAllowed

public boolean isBreakInEnclosureAllowed()

Deprecated.

Returns:

Returns the breakInEnclosureAllowed.

setBreakInEnclosureAllowed

public void setBreakInEnclosureAllowed(boolean breakInEnclosureAllowed)

Deprecated.

Parameters:

breakInEnclosureAllowed - The breakInEnclosureAllowed to set.

getExludeFileMask

public String[] getExludeFileMask()

Deprecated.

Returns:

Returns the excludeFileMask.

setExcludeFileMask

public void setExcludeFileMask(String[] excludeFileMask)

Deprecated.

Parameters:

excludeFileMask - The excludeFileMask to set.

getFileFormat

public String getFileFormat()

Deprecated.

Returns:

Returns the fileFormat.

setFileFormat

public void setFileFormat(String fileFormat)

Deprecated.

Parameters:

fileFormat - The fileFormat to set.

getFileMask

public String[] getFileMask()

Deprecated.

Returns:

Returns the fileMask.

getFileRequired

public String[] getFileRequired()

Deprecated.

Returns:

Returns the fileRequired.

setFileMask

public void setFileMask(String[] fileMask)

Deprecated.

Parameters:

fileMask - The fileMask to set.

setFileRequired

public void setFileRequired(String[] fileRequiredin)

Deprecated.

Parameters:

fileRequired - The fileRequired to set.

getIncludeSubFolders

public String[] getIncludeSubFolders()

Deprecated.

setIncludeSubFolders

public void setIncludeSubFolders(String[] includeSubFoldersin)

Deprecated.

getRequiredFilesCode

public String getRequiredFilesCode(String tt)

Deprecated.

getFileName

public String[] getFileName()

Deprecated.

Returns:

Returns the fileName.

setFileName

public void setFileName(String[] fileName)

Deprecated.

Parameters:

fileName - The fileName to set.

getFilenameField

public String getFilenameField()

Deprecated.

Returns:

Returns the filenameField.

setFilenameField

public void setFilenameField(String filenameField)

Deprecated.

Parameters:

filenameField - The filenameField to set.

getFileType

public String getFileType()

Deprecated.

Specified by:

getFileType in interface InputFileMetaInterface

Returns:

Returns the fileType.

setFileType

public void setFileType(String fileType)

Deprecated.

Parameters:

fileType - The fileType to set.

getFilter

public TextFileFilter[] getFilter()

Deprecated.

Returns:

The array of filters for the metadata of this text file input step.

setFilter

public void setFilter(TextFileFilter[] filter)

Deprecated.

Parameters:

filter - The array of filters to use

hasFooter

public boolean hasFooter()

Deprecated.

Returns:

Returns the footer.

setFooter

public void setFooter(boolean footer)

Deprecated.

Parameters:

footer - The footer to set.

hasHeader

public boolean hasHeader()

Deprecated.

Specified by:

hasHeader in interface InputFileMetaInterface

Returns:

Returns the header.

setHeader

public void setHeader(boolean header)

Deprecated.

Parameters:

header - The header to set.

includeFilename

public boolean includeFilename()

Deprecated.

Specified by:

includeFilename in interface InputFileMetaInterface

Returns:

Returns the includeFilename.

setIncludeFilename

public void setIncludeFilename(boolean includeFilename)

Deprecated.

Parameters:

includeFilename - The includeFilename to set.

includeRowNumber

public boolean includeRowNumber()

Deprecated.

Specified by:

includeRowNumber in interface InputFileMetaInterface

Returns:

Returns the includeRowNumber.

setIncludeRowNumber

public void setIncludeRowNumber(boolean includeRowNumber)

Deprecated.

Parameters:

includeRowNumber - The includeRowNumber to set.

isRowNumberByFile

public boolean isRowNumberByFile()

Deprecated.

true if row number reset for each file

Returns:

rowNumberByFile

setRowNumberByFile

public void setRowNumberByFile(boolean rowNumberByFile)

Deprecated.

Parameters:

rowNumberByFile - True if row number field is reset for each file

noEmptyLines

public boolean noEmptyLines()

Deprecated.

Returns:

Returns the noEmptyLines.

setNoEmptyLines

public void setNoEmptyLines(boolean noEmptyLines)

Deprecated.

Parameters:

noEmptyLines - The noEmptyLines to set.

getRowLimit

public long getRowLimit()

Deprecated.

Returns:

Returns the rowLimit.

setRowLimit

public void setRowLimit(long rowLimit)

Deprecated.

Parameters:

rowLimit - The rowLimit to set.

getRowNumberField

public String getRowNumberField()

Deprecated.

Returns:

Returns the rowNumberField.

setRowNumberField

public void setRowNumberField(String rowNumberField)

Deprecated.

Parameters:

rowNumberField - The rowNumberField to set.

getSeparator

public String getSeparator()

Deprecated.

Specified by:

getSeparator in interface InputFileMetaInterface

Returns:

Returns the separator.

setSeparator

public void setSeparator(String separator)

Deprecated.

Parameters:

separator - The separator to set.

getFileCompression

public String getFileCompression()

Deprecated.

Returns:

Returns the type of compression used

setFileCompression

public void setFileCompression(String fileCompression)

Deprecated.

Parameters:

fileCompression - Sets the compression type

loadXML

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

Deprecated.

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:

org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

clone

public Object clone()

Deprecated.

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

allocate

public void allocate(int nrfiles,
                     int nrfields,
                     int nrfilters)

Deprecated.

allocateFiles

public void allocateFiles(int nrFiles)

Deprecated.

setDefault

public void setDefault()

Deprecated.

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

getFields

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

Deprecated.

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:

org.pentaho.di.core.exception.KettleStepException - the kettle step exception

getFields

@Deprecated
public void getFields(org.pentaho.di.core.row.RowMetaInterface inputRowMeta,
                                  String name,
                                  org.pentaho.di.core.row.RowMetaInterface[] info,
                                  StepMeta nextStep,
                                  org.pentaho.di.core.variables.VariableSpace space)
                           throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleStepException - the kettle step exception

getXML

public String getXML()

Deprecated.

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.

getLookupStepname

public String getLookupStepname()

Deprecated.

searchInfoAndTargetSteps

public void searchInfoAndTargetSteps(List<StepMeta> steps)

Deprecated.

Description copied from class: BaseStepMeta

Change step names into step objects to allow them to be name-changed etc.

Specified by:

searchInfoAndTargetSteps in interface StepMetaInterface

Overrides:

searchInfoAndTargetSteps in class BaseStepMeta

Parameters:

steps - optionally search the info step in a list of steps

getInfoSteps

public String[] getInfoSteps()

Deprecated.

readRep

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

Deprecated.

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:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

saveRep

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

Deprecated.

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:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

getFilePaths

public String[] getFilePaths(org.pentaho.di.core.variables.VariableSpace space)

Deprecated.

Specified by:

getFilePaths in interface InputFileMetaInterface

getTextFileList

public org.pentaho.di.core.fileinput.FileInputList getTextFileList(org.pentaho.di.core.variables.VariableSpace space)

Deprecated.

check

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

Deprecated.

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)

Deprecated.

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()

Deprecated.

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.

getEscapeCharacter

public String getEscapeCharacter()

Deprecated.

Specified by:

getEscapeCharacter in interface InputFileMetaInterface

Returns:

Returns the escapeCharacter.

setEscapeCharacter

public void setEscapeCharacter(String escapeCharacter)

Deprecated.

Parameters:

escapeCharacter - The escapeCharacter to set.

getErrorCountField

public String getErrorCountField()

Deprecated.

Specified by:

getErrorCountField in interface InputFileMetaInterface

setErrorCountField

public void setErrorCountField(String errorCountField)

Deprecated.

getErrorFieldsField

public String getErrorFieldsField()

Deprecated.

Specified by:

getErrorFieldsField in interface InputFileMetaInterface

setErrorFieldsField

public void setErrorFieldsField(String errorFieldsField)

Deprecated.

isErrorIgnored

public boolean isErrorIgnored()

Deprecated.

Specified by:

isErrorIgnored in interface InputFileMetaInterface

setErrorIgnored

public void setErrorIgnored(boolean errorIgnored)

Deprecated.

getErrorTextField

public String getErrorTextField()

Deprecated.

Specified by:

getErrorTextField in interface InputFileMetaInterface

setErrorTextField

public void setErrorTextField(String errorTextField)

Deprecated.

isLineWrapped

public boolean isLineWrapped()

Deprecated.

Returns:

Returns the lineWrapped.

setLineWrapped

public void setLineWrapped(boolean lineWrapped)

Deprecated.

Parameters:

lineWrapped - The lineWrapped to set.

getNrFooterLines

public int getNrFooterLines()

Deprecated.

Returns:

Returns the nrFooterLines.

setNrFooterLines

public void setNrFooterLines(int nrFooterLines)

Deprecated.

Parameters:

nrFooterLines - The nrFooterLines to set.

getRequiredFilesDesc

public String getRequiredFilesDesc(String tt)

Deprecated.

getNrHeaderLines

public int getNrHeaderLines()

Deprecated.

Specified by:

getNrHeaderLines in interface InputFileMetaInterface

Returns:

Returns the nrHeaderLines.

setNrHeaderLines

public void setNrHeaderLines(int nrHeaderLines)

Deprecated.

Parameters:

nrHeaderLines - The nrHeaderLines to set.

getNrWraps

public int getNrWraps()

Deprecated.

Returns:

Returns the nrWraps.

setNrWraps

public void setNrWraps(int nrWraps)

Deprecated.

Parameters:

nrWraps - The nrWraps to set.

isLayoutPaged

public boolean isLayoutPaged()

Deprecated.

Returns:

Returns the layoutPaged.

setLayoutPaged

public void setLayoutPaged(boolean layoutPaged)

Deprecated.

Parameters:

layoutPaged - The layoutPaged to set.

getNrLinesPerPage

public int getNrLinesPerPage()

Deprecated.

Returns:

Returns the nrLinesPerPage.

setNrLinesPerPage

public void setNrLinesPerPage(int nrLinesPerPage)

Deprecated.

Parameters:

nrLinesPerPage - The nrLinesPerPage to set.

getNrLinesDocHeader

public int getNrLinesDocHeader()

Deprecated.

Returns:

Returns the nrLinesDocHeader.

setNrLinesDocHeader

public void setNrLinesDocHeader(int nrLinesDocHeader)

Deprecated.

Parameters:

nrLinesDocHeader - The nrLinesDocHeader to set.

getWarningFilesDestinationDirectory

public String getWarningFilesDestinationDirectory()

Deprecated.

setWarningFilesDestinationDirectory

public void setWarningFilesDestinationDirectory(String warningFilesDestinationDirectory)

Deprecated.

getWarningFilesExtension

public String getWarningFilesExtension()

Deprecated.

setWarningFilesExtension

public void setWarningFilesExtension(String warningFilesExtension)

Deprecated.

getLineNumberFilesDestinationDirectory

public String getLineNumberFilesDestinationDirectory()

Deprecated.

setLineNumberFilesDestinationDirectory

public void setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory)

Deprecated.

getLineNumberFilesExtension

public String getLineNumberFilesExtension()

Deprecated.

setLineNumberFilesExtension

public void setLineNumberFilesExtension(String lineNumberFilesExtension)

Deprecated.

getErrorFilesDestinationDirectory

public String getErrorFilesDestinationDirectory()

Deprecated.

setErrorFilesDestinationDirectory

public void setErrorFilesDestinationDirectory(String errorFilesDestinationDirectory)

Deprecated.

getErrorLineFilesExtension

public String getErrorLineFilesExtension()

Deprecated.

setErrorLineFilesExtension

public void setErrorLineFilesExtension(String errorLineFilesExtension)

Deprecated.

isDateFormatLenient

public boolean isDateFormatLenient()

Deprecated.

setDateFormatLenient

public void setDateFormatLenient(boolean dateFormatLenient)

Deprecated.

setAddResultFile

public void setAddResultFile(boolean isaddresult)

Deprecated.

Parameters:

isaddresult - The isaddresult to set.

isAddResultFile

public boolean isAddResultFile()

Deprecated.

Returns:

Returns isaddresult.

isErrorLineSkipped

public boolean isErrorLineSkipped()

Deprecated.

Specified by:

isErrorLineSkipped in interface InputFileMetaInterface

setErrorLineSkipped

public void setErrorLineSkipped(boolean errorLineSkipped)

Deprecated.

getDateFormatLocale

public Locale getDateFormatLocale()

Deprecated.

Returns:

Returns the dateFormatLocale.

setDateFormatLocale

public void setDateFormatLocale(Locale dateFormatLocale)

Deprecated.

Parameters:

dateFormatLocale - The dateFormatLocale to set.

isAcceptingFilenames

public boolean isAcceptingFilenames()

Deprecated.

setAcceptingFilenames

public void setAcceptingFilenames(boolean getFileFromJob)

Deprecated.

isPassingThruFields

public boolean isPassingThruFields()

Deprecated.

setPassingThruFields

public void setPassingThruFields(boolean passingThruFields)

Deprecated.

getAcceptingField

public String getAcceptingField()

Deprecated.

Returns:

Returns the fileNameField.

setAcceptingField

public void setAcceptingField(String fileNameField)

Deprecated.

Parameters:

fileNameField - The fileNameField to set.

getAcceptingStepName

public String getAcceptingStepName()

Deprecated.

Returns:

Returns the acceptingStep.

setAcceptingStepName

public void setAcceptingStepName(String acceptingStep)

Deprecated.

Parameters:

acceptingStep - The acceptingStep to set.

getAcceptingStep

public StepMeta getAcceptingStep()

Deprecated.

Returns:

Returns the acceptingStep.

setAcceptingStep

public void setAcceptingStep(StepMeta acceptingStep)

Deprecated.

Parameters:

acceptingStep - The acceptingStep to set.

getFileFormatTypeNr

public int getFileFormatTypeNr()

Deprecated.

Specified by:

getFileFormatTypeNr in interface InputFileMetaInterface

getFileTypeNr

public int getFileTypeNr()

Deprecated.

getResourceDependencies

public List<ResourceReference> getResourceDependencies(TransMeta transMeta,
                                                       StepMeta stepInfo)

Deprecated.

Description copied from class: BaseStepMeta

Get a list of all the resource dependencies that the step is depending on.

Specified by:

getResourceDependencies in interface StepMetaInterface

Overrides:

getResourceDependencies in class BaseStepMeta

Returns:

a list of all the resource dependencies that the step is depending on

exportResources

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

Deprecated.

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 files into absolute paths OR it simply includes the resource in the ZIP file. For now, we'll simply turn it into an absolute path and pray that the file is on a shared drive or something like that.

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:

org.pentaho.di.core.exception.KettleException

supportsErrorHandling

public boolean supportsErrorHandling()

Deprecated.

Specified by:

supportsErrorHandling in interface StepMetaInterface

Overrides:

supportsErrorHandling in class BaseStepMeta

Returns:

true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.

getStepMetaInjectionInterface

public StepMetaInjectionInterface getStepMetaInjectionInterface()

Deprecated.

Specified by:

getStepMetaInjectionInterface in interface StepMetaInterface

Overrides:

getStepMetaInjectionInterface in class BaseStepMeta

Returns:

Optional interface that allows an external program to inject step metadata in a standardized fasion. This method will return null if the interface is not available for this step.

setFileNameForTest

public void setFileNameForTest(String[] fileName)

Deprecated.