org.pentaho.di.trans.steps.fileinput.text

类 TextFileInputMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.file.BaseFileMeta

org.pentaho.di.trans.steps.file.BaseFileInputMeta<BaseFileInputAdditionalField,BaseFileInputFiles,BaseFileField>

org.pentaho.di.trans.steps.fileinput.text.TextFileInputMeta

所有已实现的接口:

Cloneable, StepAttributesInterface, StepMetaInterface, CsvInputAwareMeta, ResolvableResource

public class TextFileInputMeta
extends BaseFileInputMeta<BaseFileInputAdditionalField,BaseFileInputFiles,BaseFileField>
implements StepMetaInterface, ResolvableResource, CsvInputAwareMeta

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	TextFileInputMeta.Content

字段概要

字段

限定符和类型	字段和说明
TextFileInputMeta.Content	content
String	errorCountField The name of the field that will contain the number of errors in the row
String	errorFieldsField The name of the field that will contain the names of the fields that generated errors, separated by ,
boolean	errorLineSkipped If error line are skipped, you can replay without introducing doubles.
String	errorTextField The name of the field that will contain the error texts, separated by CR
static int	FILE_FORMAT_DOS
static int	FILE_FORMAT_MIXED
static int	FILE_FORMAT_UNIX
static int	FILE_TYPE_CSV
static int	FILE_TYPE_FIXED

从类继承的字段 org.pentaho.di.trans.steps.file.BaseFileInputMeta

additionalOutputFields, errorHandling, inputFields, inputFiles, NO, RequiredFilesCode, RequiredFilesDesc, YES

从类继承的字段 org.pentaho.di.trans.steps.file.BaseFileMeta

servletOutput

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

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

构造器概要

构造器

构造器和说明
TextFileInputMeta()

方法概要

限定符和类型	方法和说明
void	allocate(int nrfiles, int nrfields, int nrfilters)
void	allocateFiles(int nrFiles)
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) 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(org.pentaho.di.core.variables.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.
String	getAcceptingField() Required for the Data Lineage.
StepMeta	getAcceptingStep() Required for the Data Lineage.
String	getAcceptingStepName() Required for the Data Lineage.
String	getDelimiter()
String	getEnclosure()
String	getEncoding()
String	getErrorCountField()
String	getErrorFieldsField()
String	getErrorTextField()
String	getEscapeCharacter()
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) 已过时。
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) Gets the fields.
int	getFileFormatTypeNr()
String[]	getFileName()
String[]	getFilePaths(org.pentaho.di.core.variables.VariableSpace space)
int	getFileTypeNr()
TextFileFilter[]	getFilter()
org.apache.commons.vfs2.FileObject	getHeaderFileObject(TransMeta transMeta) Returns a FileObject that corresponds to the first encountered input file.
String[]	getInfoSteps()
String	getLength()
String	getLookupStepname()
String	getRequiredFilesDesc(String tt)
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.
org.pentaho.di.core.fileinput.FileInputList	getTextFileList(org.pentaho.di.core.variables.VariableSpace space)
String	getXML() Produces the XML string that describes this step's information.
boolean	hasHeader()
boolean	isAcceptingFilenames() Required for the Data Lineage.
boolean	isErrorLineSkipped()
protected String	loadSource(Node filenode, Node filenamenode, int i, org.pentaho.metastore.api.IMetaStore metaStore)
protected String	loadSourceRep(Repository rep, org.pentaho.di.repository.ObjectId id_step, int i, org.pentaho.metastore.api.IMetaStore metaStore)
void	loadXML(Node stepnode, List<org.pentaho.di.core.database.DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Node
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) Read the steps information from a Kettle repository
void	resolve() Resolves resource data elements variables and temporary references.
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) Save the steps data into a Kettle repository
protected void	saveSource(StringBuilder retVal, String source)
protected void	saveSourceRep(Repository rep, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step, int i, String fileName)
void	searchInfoAndTargetSteps(List<StepMeta> steps) Change step names into step objects to allow them to be name-changed etc.
void	setAcceptingStep(StepMeta acceptingStep)
void	setDefault() Set default values
void	setErrorCountField(String errorCountField)
void	setErrorFieldsField(String errorFieldsField)
void	setErrorLineSkipped(boolean errorLineSkipped)
void	setErrorTextField(String errorTextField)
void	setFileName(String[] fileName)
void	setFileNameForTest(String[] fileName)
void	setFilter(TextFileFilter[] filter)
void	setLength(String length)
boolean	supportsErrorHandling()

从类继承的方法 org.pentaho.di.trans.steps.file.BaseFileInputMeta

getFileInputList, getFilePaths, getInputFields, getRequiredFilesCode, getResourceDependencies, inputFiles_fileRequired, inputFiles_includeSubFolders, inputFiles_includeSubFolders

从类继承的方法 org.pentaho.di.trans.steps.file.BaseFileMeta

passDataToServletOutput, writesToFile

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

analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, 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, setChanged, setChanged, setParentStepMeta, setStepIOMeta

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

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

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

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

字段详细资料

FILE_FORMAT_DOS

public static final int FILE_FORMAT_DOS

另请参阅:

常量字段值

FILE_FORMAT_UNIX

public static final int FILE_FORMAT_UNIX

另请参阅:

常量字段值

FILE_FORMAT_MIXED

public static final int FILE_FORMAT_MIXED

另请参阅:

常量字段值

FILE_TYPE_CSV

public static final int FILE_TYPE_CSV

另请参阅:

常量字段值

FILE_TYPE_FIXED

public static final int FILE_TYPE_FIXED

另请参阅:

常量字段值

content

public TextFileInputMeta.Content content

errorCountField

public String errorCountField

The name of the field that will contain the number of errors in the row

errorFieldsField

public String errorFieldsField

The name of the field that will contain the names of the fields that generated errors, separated by ,

errorTextField

public String errorTextField

The name of the field that will contain the error texts, separated by CR

errorLineSkipped

public boolean errorLineSkipped

If error line are skipped, you can replay without introducing doubles.

构造器详细资料

TextFileInputMeta

public TextFileInputMeta()

方法详细资料

getFileName

public String[] getFileName()

返回:

Returns the fileName.

setFileName

public void setFileName(String[] fileName)

参数:

fileName - The fileName to set.

getFilter

public TextFileFilter[] getFilter()

返回:

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

setFilter

public void setFilter(TextFileFilter[] filter)

参数:

filter - The array of filters to use

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

从接口复制的说明: StepMetaInterface

Load the values for this step from an XML Node

指定者:

loadXML 在接口中 StepMetaInterface

覆盖:

loadXML 在类中 BaseStepMeta

参数:

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

抛出:

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

clone

public Object clone()

从接口复制的说明: StepMetaInterface

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

指定者:

clone 在接口中 StepMetaInterface

覆盖:

clone 在类中 BaseFileInputMeta<BaseFileInputAdditionalField,BaseFileInputFiles,BaseFileField>

返回:

an exact copy of this step

allocate

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

allocateFiles

public void allocateFiles(int nrFiles)

setDefault

public void setDefault()

从接口复制的说明: StepMetaInterface

Set default values

指定者:

setDefault 在接口中 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

从类复制的说明: BaseStepMeta

Gets the fields.

指定者:

getFields 在接口中 StepMetaInterface

覆盖:

getFields 在类中 BaseStepMeta

参数:

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

抛出:

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

已过时。

从类复制的说明: BaseStepMeta

Gets the fields.

指定者:

getFields 在接口中 StepMetaInterface

覆盖:

getFields 在类中 BaseStepMeta

参数:

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

抛出:

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

getXML

public String getXML()

从类复制的说明: BaseStepMeta

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

指定者:

getXML 在接口中 StepMetaInterface

覆盖:

getXML 在类中 BaseStepMeta

返回:

String containing the XML describing this step.

getLookupStepname

public String getLookupStepname()

searchInfoAndTargetSteps

public void searchInfoAndTargetSteps(List<StepMeta> steps)

从类复制的说明: BaseStepMeta

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

指定者:

searchInfoAndTargetSteps 在接口中 StepMetaInterface

覆盖:

searchInfoAndTargetSteps 在类中 BaseStepMeta

参数:

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

getInfoSteps

public String[] getInfoSteps()

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

从接口复制的说明: StepMetaInterface

Read the steps information from a Kettle repository

指定者:

readRep 在接口中 StepMetaInterface

覆盖:

readRep 在类中 BaseStepMeta

参数:

rep - The repository to read from

metaStore - The MetaStore to read external information from

id_step - The step ID

databases - The databases to reference

抛出:

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

从接口复制的说明: StepMetaInterface

Save the steps data into a Kettle repository

指定者:

saveRep 在接口中 StepMetaInterface

覆盖:

saveRep 在类中 BaseStepMeta

参数:

rep - The Kettle repository to save to

metaStore - the metaStore to optionally write to

id_transformation - The transformation ID

id_step - The step ID

抛出:

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

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)

从接口复制的说明: StepMetaInterface

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

指定者:

check 在接口中 StepMetaInterface

覆盖:

check 在类中 BaseStepMeta

参数:

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)

从接口复制的说明: StepMetaInterface

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

指定者:

getStep 在接口中 StepMetaInterface

参数:

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

从接口复制的说明: 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.

指定者:

getStepData 在接口中 StepMetaInterface

返回:

The appropriate StepDataInterface class.

getErrorCountField

public String getErrorCountField()

setErrorCountField

public void setErrorCountField(String errorCountField)

getErrorFieldsField

public String getErrorFieldsField()

setErrorFieldsField

public void setErrorFieldsField(String errorFieldsField)

getErrorTextField

public String getErrorTextField()

setErrorTextField

public void setErrorTextField(String errorTextField)

getRequiredFilesDesc

public String getRequiredFilesDesc(String tt)

isErrorLineSkipped

public boolean isErrorLineSkipped()

setErrorLineSkipped

public void setErrorLineSkipped(boolean errorLineSkipped)

setAcceptingStep

public void setAcceptingStep(StepMeta acceptingStep)

参数:

acceptingStep - The acceptingStep to set.

getFileFormatTypeNr

public int getFileFormatTypeNr()

指定者:

getFileFormatTypeNr 在接口中 CsvInputAwareMeta

getFileTypeNr

public int getFileTypeNr()

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

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.

指定者:

exportResources 在接口中 StepMetaInterface

覆盖:

exportResources 在类中 BaseStepMeta

参数:

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.

返回:

the filename of the exported resource

抛出:

org.pentaho.di.core.exception.KettleException

supportsErrorHandling

public boolean supportsErrorHandling()

指定者:

supportsErrorHandling 在接口中 StepMetaInterface

覆盖:

supportsErrorHandling 在类中 BaseStepMeta

返回:

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

setFileNameForTest

public void setFileNameForTest(String[] fileName)

loadSource

protected String loadSource(Node filenode,
                            Node filenamenode,
                            int i,
                            org.pentaho.metastore.api.IMetaStore metaStore)

saveSource

protected void saveSource(StringBuilder retVal,
                          String source)

loadSourceRep

protected String loadSourceRep(Repository rep,
                               org.pentaho.di.repository.ObjectId id_step,
                               int i,
                               org.pentaho.metastore.api.IMetaStore metaStore)
                        throws org.pentaho.di.core.exception.KettleException

抛出:

org.pentaho.di.core.exception.KettleException

saveSourceRep

protected void saveSourceRep(Repository rep,
                             org.pentaho.di.repository.ObjectId id_transformation,
                             org.pentaho.di.repository.ObjectId id_step,
                             int i,
                             String fileName)
                      throws org.pentaho.di.core.exception.KettleException

抛出:

org.pentaho.di.core.exception.KettleException

getEncoding

public String getEncoding()

指定者:

getEncoding 在接口中 CsvInputAwareMeta

指定者:

getEncoding 在类中 BaseFileInputMeta<BaseFileInputAdditionalField,BaseFileInputFiles,BaseFileField>

getLength

public String getLength()

返回:

the length

setLength

public void setLength(String length)

参数:

length - the length to set

isAcceptingFilenames

public boolean isAcceptingFilenames()

Required for the Data Lineage.

覆盖:

isAcceptingFilenames 在类中 BaseFileInputMeta<BaseFileInputAdditionalField,BaseFileInputFiles,BaseFileField>

getAcceptingStepName

public String getAcceptingStepName()

Required for the Data Lineage.

覆盖:

getAcceptingStepName 在类中 BaseFileInputMeta<BaseFileInputAdditionalField,BaseFileInputFiles,BaseFileField>

getAcceptingStep

public StepMeta getAcceptingStep()

Required for the Data Lineage.

getAcceptingField

public String getAcceptingField()

Required for the Data Lineage.

覆盖:

getAcceptingField 在类中 BaseFileInputMeta<BaseFileInputAdditionalField,BaseFileInputFiles,BaseFileField>

getFilePaths

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

getTextFileList

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

resolve

public void resolve()

从接口复制的说明: ResolvableResource

Resolves resource data elements variables and temporary references.

指定者:

resolve 在接口中 ResolvableResource

hasHeader

public boolean hasHeader()

指定者:

hasHeader 在接口中 CsvInputAwareMeta

getEscapeCharacter

public String getEscapeCharacter()

指定者:

getEscapeCharacter 在接口中 CsvInputAwareMeta

getDelimiter

public String getDelimiter()

指定者:

getDelimiter 在接口中 CsvInputAwareMeta

getEnclosure

public String getEnclosure()

指定者:

getEnclosure 在接口中 CsvInputAwareMeta

getHeaderFileObject

public org.apache.commons.vfs2.FileObject getHeaderFileObject(TransMeta transMeta)

从接口复制的说明: CsvInputAwareMeta

Returns a FileObject that corresponds to the first encountered input file. This object is used to read the file headers for the purpose of field parsing.

指定者:

getHeaderFileObject 在接口中 CsvInputAwareMeta

参数:

transMeta - the TransMeta

返回:

null if the FileObject cannot be created.