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
public class TextFileInputMeta
- extends BaseStepMeta
- implements StepMetaInterface, InputFileMetaInterface
Method Summary |
void |
allocate(int nrfiles,
int nrfields,
int nrfilters)
|
void |
check(List<CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepinfo,
RowMetaInterface prev,
String[] input,
String[] output,
RowMetaInterface info)
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)
Since the exported transformation that runs this will reside in a ZIP file, we can't reference files relatively. |
String |
getAcceptingField()
|
StepMeta |
getAcceptingStep()
|
String |
getAcceptingStepName()
|
Locale |
getDateFormatLocale()
|
String |
getEnclosure()
|
String |
getEncoding()
|
String |
getErrorCountField()
|
String |
getErrorFieldsField()
|
String |
getErrorFilesDestinationDirectory()
|
String |
getErrorLineFilesExtension()
|
String |
getErrorTextField()
|
String |
getEscapeCharacter()
|
String[] |
getExludeFileMask()
|
String |
getExtensionField()
|
void |
getFields(RowMetaInterface row,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String |
getFileCompression()
|
String |
getFileErrorField()
|
String |
getFileErrorMessageField()
|
String |
getFileFormat()
|
int |
getFileFormatTypeNr()
|
String[] |
getFileMask()
|
String[] |
getFileName()
|
String |
getFilenameField()
|
String[] |
getFilePaths(VariableSpace space)
|
String[] |
getFileRequired()
|
String |
getFileType()
|
int |
getFileTypeNr()
|
TextFileFilter[] |
getFilter()
|
String[] |
getIncludeSubFolders()
|
String[] |
getInfoSteps()
|
TextFileInputField[] |
getInputFields()
|
String |
getLastModificationDateField()
|
String |
getLineNumberFilesDestinationDirectory()
|
String |
getLineNumberFilesExtension()
|
String |
getLookupStepname()
|
int |
getNrFooterLines()
|
int |
getNrHeaderLines()
|
int |
getNrLinesDocHeader()
|
int |
getNrLinesPerPage()
|
int |
getNrWraps()
|
String |
getPathField()
|
String |
getRequiredFilesCode(String tt)
|
String |
getRequiredFilesDesc(String tt)
|
List<ResourceReference> |
getResourceDependencies(TransMeta transMeta,
StepMeta stepInfo)
Get a list of all the resource dependencies that the step is depending on. |
String |
getRootUriField()
|
long |
getRowLimit()
|
String |
getRowNumberField()
|
String |
getSeparator()
|
String |
getShortFileNameField()
|
String |
getSizeField()
|
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. |
FileInputList |
getTextFileList(VariableSpace space)
|
String |
getUriField()
|
String |
getWarningFilesDestinationDirectory()
|
String |
getWarningFilesExtension()
|
String |
getXML()
Produces the XML string that describes this step's information. |
boolean |
hasFooter()
|
boolean |
hasHeader()
|
boolean |
includeFilename()
|
boolean |
includeRowNumber()
|
boolean |
isAcceptingFilenames()
|
boolean |
isAddResultFile()
|
boolean |
isBreakInEnclosureAllowed()
|
boolean |
isDateFormatLenient()
|
boolean |
isErrorIgnored()
|
boolean |
isErrorLineSkipped()
|
String |
isHiddenField()
|
boolean |
isLayoutPaged()
|
boolean |
isLineWrapped()
|
boolean |
isPassingThruFields()
|
boolean |
isRowNumberByFile()
true if row number reset for each file |
boolean |
isSkipBadFiles()
|
void |
loadXML(Node stepnode,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Load the values for this step from an XML Node |
boolean |
noEmptyLines()
|
void |
readRep(Repository rep,
ObjectId id_step,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
Read the steps information from a Kettle repository |
void |
saveRep(Repository rep,
ObjectId id_transformation,
ObjectId id_step)
Save the steps data into a Kettle repository |
void |
searchInfoAndTargetSteps(List<StepMeta> steps)
Change step names into step objects to allow them to be name-changed etc. |
void |
setAcceptingField(String fileNameField)
|
void |
setAcceptingFilenames(boolean getFileFromJob)
|
void |
setAcceptingStep(StepMeta acceptingStep)
|
void |
setAcceptingStepName(String acceptingStep)
|
void |
setAddResultFile(boolean isaddresult)
|
void |
setBreakInEnclosureAllowed(boolean breakInEnclosureAllowed)
|
void |
setDateFormatLenient(boolean dateFormatLenient)
|
void |
setDateFormatLocale(Locale dateFormatLocale)
|
void |
setDefault()
Set default values |
void |
setEnclosure(String enclosure)
|
void |
setEncoding(String encoding)
|
void |
setErrorCountField(String errorCountField)
|
void |
setErrorFieldsField(String errorFieldsField)
|
void |
setErrorFilesDestinationDirectory(String errorFilesDestinationDirectory)
|
void |
setErrorIgnored(boolean errorIgnored)
|
void |
setErrorLineFilesExtension(String errorLineFilesExtension)
|
void |
setErrorLineSkipped(boolean errorLineSkipped)
|
void |
setErrorTextField(String errorTextField)
|
void |
setEscapeCharacter(String escapeCharacter)
|
void |
setExcludeFileMask(String[] excludeFileMask)
|
void |
setExtensionField(String field)
|
void |
setFileCompression(String fileCompression)
|
void |
setFileErrorField(String field)
|
void |
setFileErrorMessageField(String field)
|
void |
setFileFormat(String fileFormat)
|
void |
setFileMask(String[] fileMask)
|
void |
setFileName(String[] fileName)
|
void |
setFilenameField(String filenameField)
|
void |
setFileRequired(String[] fileRequiredin)
|
void |
setFileType(String fileType)
|
void |
setFilter(TextFileFilter[] filter)
|
void |
setFooter(boolean footer)
|
void |
setHeader(boolean header)
|
void |
setIncludeFilename(boolean includeFilename)
|
void |
setIncludeRowNumber(boolean includeRowNumber)
|
void |
setIncludeSubFolders(String[] includeSubFoldersin)
|
void |
setInputFields(TextFileInputField[] inputFields)
|
void |
setIsHiddenField(String field)
|
void |
setLastModificationDateField(String field)
|
void |
setLayoutPaged(boolean layoutPaged)
|
void |
setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory)
|
void |
setLineNumberFilesExtension(String lineNumberFilesExtension)
|
void |
setLineWrapped(boolean lineWrapped)
|
void |
setNoEmptyLines(boolean noEmptyLines)
|
void |
setNrFooterLines(int nrFooterLines)
|
void |
setNrHeaderLines(int nrHeaderLines)
|
void |
setNrLinesDocHeader(int nrLinesDocHeader)
|
void |
setNrLinesPerPage(int nrLinesPerPage)
|
void |
setNrWraps(int nrWraps)
|
void |
setPassingThruFields(boolean passingThruFields)
|
void |
setPathField(String field)
|
void |
setRootUriField(String field)
|
void |
setRowLimit(long rowLimit)
|
void |
setRowNumberByFile(boolean rowNumberByFile)
|
void |
setRowNumberField(String rowNumberField)
|
void |
setSeparator(String separator)
|
void |
setShortFileNameField(String field)
|
void |
setSizeField(String field)
|
void |
setSkipBadFiles(boolean value)
|
void |
setUriField(String field)
|
void |
setWarningFilesDestinationDirectory(String warningFilesDestinationDirectory)
|
void |
setWarningFilesExtension(String warningFilesExtension)
|
boolean |
supportsErrorHandling()
|
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta |
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, setChanged, setChanged, setParentStepMeta |
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface |
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, setParentStepMeta |
RequiredFilesDesc
public static final String[] RequiredFilesDesc
RequiredFilesCode
public static final String[] RequiredFilesCode
FILE_FORMAT_DOS
public static final int FILE_FORMAT_DOS
- See Also:
- Constant Field Values
FILE_FORMAT_UNIX
public static final int FILE_FORMAT_UNIX
- See Also:
- Constant Field Values
FILE_FORMAT_MIXED
public static final int FILE_FORMAT_MIXED
- See Also:
- Constant Field Values
FILE_TYPE_CSV
public static final int FILE_TYPE_CSV
- See Also:
- Constant Field Values
FILE_TYPE_FIXED
public static final int FILE_TYPE_FIXED
- See Also:
- Constant Field Values
TextFileInputMeta
public TextFileInputMeta()
getShortFileNameField
public String getShortFileNameField()
- Returns:
- Returns the shortFileFieldName.
setShortFileNameField
public void setShortFileNameField(String field)
- Parameters:
field
- The shortFileFieldName to set.
getPathField
public String getPathField()
- Returns:
- Returns the pathFieldName.
setPathField
public void setPathField(String field)
- Parameters:
field
- The pathFieldName to set.
isHiddenField
public String isHiddenField()
- Returns:
- Returns the hiddenFieldName.
setIsHiddenField
public void setIsHiddenField(String field)
- Parameters:
field
- The hiddenFieldName to set.
getLastModificationDateField
public String getLastModificationDateField()
- Returns:
- Returns the lastModificationTimeFieldName.
setLastModificationDateField
public void setLastModificationDateField(String field)
- Parameters:
field
- The lastModificationTimeFieldName to set.
getUriField
public String getUriField()
- Returns:
- Returns the uriNameFieldName.
setUriField
public void setUriField(String field)
- Parameters:
field
- The uriNameFieldName to set.
getRootUriField
public String getRootUriField()
- Returns:
- Returns the uriNameFieldName.
setRootUriField
public void setRootUriField(String field)
- Parameters:
field
- The rootUriNameFieldName to set.
getExtensionField
public String getExtensionField()
- Returns:
- Returns the extensionFieldName.
setExtensionField
public void setExtensionField(String field)
- Parameters:
field
- The extensionFieldName to set.
getSizeField
public String getSizeField()
- Returns:
- Returns the sizeFieldName.
setSizeField
public void setSizeField(String field)
- Parameters:
field
- The sizeFieldName to set.
isSkipBadFiles
public boolean isSkipBadFiles()
- Returns:
- If should continue processing after failing to open a file
setSkipBadFiles
public void setSkipBadFiles(boolean value)
- Parameters:
value
- If should continue processing after failing to open a file
getFileErrorField
public String getFileErrorField()
setFileErrorField
public void setFileErrorField(String field)
getFileErrorMessageField
public String getFileErrorMessageField()
setFileErrorMessageField
public void setFileErrorMessageField(String field)
getEncoding
public String getEncoding()
- Returns:
- Returns the encoding.
setEncoding
public void setEncoding(String encoding)
- Parameters:
encoding
- The encoding to set.
getInputFields
public TextFileInputField[] getInputFields()
- Specified by:
getInputFields
in interface InputFileMetaInterface
- Returns:
- Returns the input fields.
setInputFields
public void setInputFields(TextFileInputField[] inputFields)
- Parameters:
inputFields
- The input fields to set.
getEnclosure
public String getEnclosure()
- Specified by:
getEnclosure
in interface InputFileMetaInterface
- Returns:
- Returns the enclosure.
setEnclosure
public void setEnclosure(String enclosure)
- Parameters:
enclosure
- The enclosure to set.
isBreakInEnclosureAllowed
public boolean isBreakInEnclosureAllowed()
- Returns:
- Returns the breakInEnclosureAllowed.
setBreakInEnclosureAllowed
public void setBreakInEnclosureAllowed(boolean breakInEnclosureAllowed)
- Parameters:
breakInEnclosureAllowed
- The breakInEnclosureAllowed to set.
getExludeFileMask
public String[] getExludeFileMask()
- Returns:
- Returns the excludeFileMask.
setExcludeFileMask
public void setExcludeFileMask(String[] excludeFileMask)
- Parameters:
excludeFileMask
- The excludeFileMask to set.
getFileFormat
public String getFileFormat()
- Returns:
- Returns the fileFormat.
setFileFormat
public void setFileFormat(String fileFormat)
- Parameters:
fileFormat
- The fileFormat to set.
getFileMask
public String[] getFileMask()
- Returns:
- Returns the fileMask.
getFileRequired
public String[] getFileRequired()
- Returns:
- Returns the fileRequired.
setFileMask
public void setFileMask(String[] fileMask)
- Parameters:
fileMask
- The fileMask to set.
setFileRequired
public void setFileRequired(String[] fileRequiredin)
- Parameters:
fileRequired
- The fileRequired to set.
getIncludeSubFolders
public String[] getIncludeSubFolders()
setIncludeSubFolders
public void setIncludeSubFolders(String[] includeSubFoldersin)
getRequiredFilesCode
public String getRequiredFilesCode(String tt)
getFileName
public String[] getFileName()
- Returns:
- Returns the fileName.
setFileName
public void setFileName(String[] fileName)
- Parameters:
fileName
- The fileName to set.
getFilenameField
public String getFilenameField()
- Returns:
- Returns the filenameField.
setFilenameField
public void setFilenameField(String filenameField)
- Parameters:
filenameField
- The filenameField to set.
getFileType
public String getFileType()
- Specified by:
getFileType
in interface InputFileMetaInterface
- Returns:
- Returns the fileType.
setFileType
public void setFileType(String fileType)
- Parameters:
fileType
- The fileType to set.
getFilter
public TextFileFilter[] getFilter()
- Returns:
- The array of filters for the metadata of this text file input step.
setFilter
public void setFilter(TextFileFilter[] filter)
- Parameters:
filter
- The array of filters to use
hasFooter
public boolean hasFooter()
- Returns:
- Returns the footer.
setFooter
public void setFooter(boolean footer)
- Parameters:
footer
- The footer to set.
hasHeader
public boolean hasHeader()
- Specified by:
hasHeader
in interface InputFileMetaInterface
- Returns:
- Returns the header.
setHeader
public void setHeader(boolean header)
- Parameters:
header
- The header to set.
includeFilename
public boolean includeFilename()
- Specified by:
includeFilename
in interface InputFileMetaInterface
- Returns:
- Returns the includeFilename.
setIncludeFilename
public void setIncludeFilename(boolean includeFilename)
- Parameters:
includeFilename
- The includeFilename to set.
includeRowNumber
public boolean includeRowNumber()
- Specified by:
includeRowNumber
in interface InputFileMetaInterface
- Returns:
- Returns the includeRowNumber.
setIncludeRowNumber
public void setIncludeRowNumber(boolean includeRowNumber)
- Parameters:
includeRowNumber
- The includeRowNumber to set.
isRowNumberByFile
public boolean isRowNumberByFile()
- true if row number reset for each file
- Returns:
- rowNumberByFile
setRowNumberByFile
public void setRowNumberByFile(boolean rowNumberByFile)
- Parameters:
rowNumberByFile
- True if row number field is reset for each file
noEmptyLines
public boolean noEmptyLines()
- Returns:
- Returns the noEmptyLines.
setNoEmptyLines
public void setNoEmptyLines(boolean noEmptyLines)
- Parameters:
noEmptyLines
- The noEmptyLines to set.
getRowLimit
public long getRowLimit()
- Returns:
- Returns the rowLimit.
setRowLimit
public void setRowLimit(long rowLimit)
- Parameters:
rowLimit
- The rowLimit to set.
getRowNumberField
public String getRowNumberField()
- Returns:
- Returns the rowNumberField.
setRowNumberField
public void setRowNumberField(String rowNumberField)
- Parameters:
rowNumberField
- The rowNumberField to set.
getSeparator
public String getSeparator()
- Specified by:
getSeparator
in interface InputFileMetaInterface
- Returns:
- Returns the separator.
setSeparator
public void setSeparator(String separator)
- Parameters:
separator
- The separator to set.
getFileCompression
public String getFileCompression()
- Returns:
- Returns the type of compression used
setFileCompression
public void setFileCompression(String fileCompression)
- Parameters:
fileCompression
- Sets the compression type
loadXML
public void loadXML(Node stepnode,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
throws KettleXMLException
- Description copied from interface:
StepMetaInterface
- Load the values for this step from an XML Node
- Specified by:
loadXML
in interface StepMetaInterface
- Parameters:
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
- Throws:
KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)
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
allocate
public void allocate(int nrfiles,
int nrfields,
int nrfilters)
setDefault
public void setDefault()
- Description copied from interface:
StepMetaInterface
- Set default values
- Specified by:
setDefault
in interface StepMetaInterface
getFields
public void getFields(RowMetaInterface row,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
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 metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the space
- 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.
getLookupStepname
public String getLookupStepname()
searchInfoAndTargetSteps
public void searchInfoAndTargetSteps(List<StepMeta> steps)
- 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()
readRep
public void readRep(Repository rep,
ObjectId id_step,
List<DatabaseMeta> databases,
Map<String,Counter> counters)
throws KettleException
- Description copied from interface:
StepMetaInterface
- Read the steps information from a Kettle repository
- Specified by:
readRep
in interface StepMetaInterface
- Parameters:
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
- Throws:
KettleException
- When an unexpected error occurred (database, network, etc)
saveRep
public void saveRep(Repository rep,
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
- Parameters:
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
- Throws:
KettleException
- When an unexpected error occurred (database, network, etc)
getFilePaths
public String[] getFilePaths(VariableSpace space)
- Specified by:
getFilePaths
in interface InputFileMetaInterface
getTextFileList
public FileInputList getTextFileList(VariableSpace space)
check
public void check(List<CheckResultInterface> remarks,
TransMeta transMeta,
StepMeta stepinfo,
RowMetaInterface prev,
String[] input,
String[] output,
RowMetaInterface info)
- 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
- Parameters:
remarks
- The list to put the remarks in @see org.pentaho.di.core.CheckResultstepinfo
- The stepMeta to help checkingprev
- The fields coming from the previous stepinput
- The input step namesoutput
- The output step namesinfo
- The fields that are used as information by the step
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 infostepDataInterface
- the step data interface linked to this step. Here the step can store temporary data, database connections, etc.cnr
- The copy nr to gettransMeta
- The transformation infotrans
- 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.
getEscapeCharacter
public String getEscapeCharacter()
- Specified by:
getEscapeCharacter
in interface InputFileMetaInterface
- Returns:
- Returns the escapeCharacter.
setEscapeCharacter
public void setEscapeCharacter(String escapeCharacter)
- Parameters:
escapeCharacter
- The escapeCharacter to set.
getErrorCountField
public String getErrorCountField()
- Specified by:
getErrorCountField
in interface InputFileMetaInterface
setErrorCountField
public void setErrorCountField(String errorCountField)
getErrorFieldsField
public String getErrorFieldsField()
- Specified by:
getErrorFieldsField
in interface InputFileMetaInterface
setErrorFieldsField
public void setErrorFieldsField(String errorFieldsField)
isErrorIgnored
public boolean isErrorIgnored()
- Specified by:
isErrorIgnored
in interface InputFileMetaInterface
setErrorIgnored
public void setErrorIgnored(boolean errorIgnored)
getErrorTextField
public String getErrorTextField()
- Specified by:
getErrorTextField
in interface InputFileMetaInterface
setErrorTextField
public void setErrorTextField(String errorTextField)
isLineWrapped
public boolean isLineWrapped()
- Returns:
- Returns the lineWrapped.
setLineWrapped
public void setLineWrapped(boolean lineWrapped)
- Parameters:
lineWrapped
- The lineWrapped to set.
getNrFooterLines
public int getNrFooterLines()
- Returns:
- Returns the nrFooterLines.
setNrFooterLines
public void setNrFooterLines(int nrFooterLines)
- Parameters:
nrFooterLines
- The nrFooterLines to set.
getRequiredFilesDesc
public String getRequiredFilesDesc(String tt)
getNrHeaderLines
public int getNrHeaderLines()
- Specified by:
getNrHeaderLines
in interface InputFileMetaInterface
- Returns:
- Returns the nrHeaderLines.
setNrHeaderLines
public void setNrHeaderLines(int nrHeaderLines)
- Parameters:
nrHeaderLines
- The nrHeaderLines to set.
getNrWraps
public int getNrWraps()
- Returns:
- Returns the nrWraps.
setNrWraps
public void setNrWraps(int nrWraps)
- Parameters:
nrWraps
- The nrWraps to set.
isLayoutPaged
public boolean isLayoutPaged()
- Returns:
- Returns the layoutPaged.
setLayoutPaged
public void setLayoutPaged(boolean layoutPaged)
- Parameters:
layoutPaged
- The layoutPaged to set.
getNrLinesPerPage
public int getNrLinesPerPage()
- Returns:
- Returns the nrLinesPerPage.
setNrLinesPerPage
public void setNrLinesPerPage(int nrLinesPerPage)
- Parameters:
nrLinesPerPage
- The nrLinesPerPage to set.
getNrLinesDocHeader
public int getNrLinesDocHeader()
- Returns:
- Returns the nrLinesDocHeader.
setNrLinesDocHeader
public void setNrLinesDocHeader(int nrLinesDocHeader)
- Parameters:
nrLinesDocHeader
- The nrLinesDocHeader to set.
getWarningFilesDestinationDirectory
public String getWarningFilesDestinationDirectory()
setWarningFilesDestinationDirectory
public void setWarningFilesDestinationDirectory(String warningFilesDestinationDirectory)
getWarningFilesExtension
public String getWarningFilesExtension()
setWarningFilesExtension
public void setWarningFilesExtension(String warningFilesExtension)
getLineNumberFilesDestinationDirectory
public String getLineNumberFilesDestinationDirectory()
setLineNumberFilesDestinationDirectory
public void setLineNumberFilesDestinationDirectory(String lineNumberFilesDestinationDirectory)
getLineNumberFilesExtension
public String getLineNumberFilesExtension()
setLineNumberFilesExtension
public void setLineNumberFilesExtension(String lineNumberFilesExtension)
getErrorFilesDestinationDirectory
public String getErrorFilesDestinationDirectory()
setErrorFilesDestinationDirectory
public void setErrorFilesDestinationDirectory(String errorFilesDestinationDirectory)
getErrorLineFilesExtension
public String getErrorLineFilesExtension()
setErrorLineFilesExtension
public void setErrorLineFilesExtension(String errorLineFilesExtension)
isDateFormatLenient
public boolean isDateFormatLenient()
setDateFormatLenient
public void setDateFormatLenient(boolean dateFormatLenient)
setAddResultFile
public void setAddResultFile(boolean isaddresult)
- Parameters:
isaddresult
- The isaddresult to set.
isAddResultFile
public boolean isAddResultFile()
- Returns:
- Returns isaddresult.
isErrorLineSkipped
public boolean isErrorLineSkipped()
- Specified by:
isErrorLineSkipped
in interface InputFileMetaInterface
setErrorLineSkipped
public void setErrorLineSkipped(boolean errorLineSkipped)
getDateFormatLocale
public Locale getDateFormatLocale()
- Returns:
- Returns the dateFormatLocale.
setDateFormatLocale
public void setDateFormatLocale(Locale dateFormatLocale)
- Parameters:
dateFormatLocale
- The dateFormatLocale to set.
isAcceptingFilenames
public boolean isAcceptingFilenames()
setAcceptingFilenames
public void setAcceptingFilenames(boolean getFileFromJob)
isPassingThruFields
public boolean isPassingThruFields()
setPassingThruFields
public void setPassingThruFields(boolean passingThruFields)
getAcceptingField
public String getAcceptingField()
- Returns:
- Returns the fileNameField.
setAcceptingField
public void setAcceptingField(String fileNameField)
- Parameters:
fileNameField
- The fileNameField to set.
getAcceptingStepName
public String getAcceptingStepName()
- Returns:
- Returns the acceptingStep.
setAcceptingStepName
public void setAcceptingStepName(String acceptingStep)
- Parameters:
acceptingStep
- The acceptingStep to set.
getAcceptingStep
public StepMeta getAcceptingStep()
- Returns:
- Returns the acceptingStep.
setAcceptingStep
public void setAcceptingStep(StepMeta acceptingStep)
- Parameters:
acceptingStep
- The acceptingStep to set.
getFileFormatTypeNr
public int getFileFormatTypeNr()
- Specified by:
getFileFormatTypeNr
in interface InputFileMetaInterface
getFileTypeNr
public int getFileTypeNr()
getResourceDependencies
public List<ResourceReference> getResourceDependencies(TransMeta transMeta,
StepMeta stepInfo)
- 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(VariableSpace space,
Map<String,ResourceDefinition> definitions,
ResourceNamingInterface resourceNamingInterface,
Repository repository)
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 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.
TODO: create options to configure this behavior
- Specified by:
exportResources
in interface StepMetaInterface
- Overrides:
exportResources
in class BaseStepMeta
- Parameters:
space
- the spacedefinitions
- the definitionsresourceNamingInterface
- the resource naming interfacerepository
- the repository
- Returns:
- the string
- Throws:
KettleException
- the kettle exception
supportsErrorHandling
public boolean supportsErrorHandling()
- 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.