org.pentaho.di.trans.steps.file

Class BaseFileInputMeta<A extends BaseFileInputAdditionalField,I extends BaseFileInputFiles,F extends BaseFileField>

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

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

org.pentaho.di.trans.steps.file.BaseFileInputMeta<A,I,F>

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

Direct Known Subclasses:

TextFileInputMeta

public abstract class BaseFileInputMeta<A extends BaseFileInputAdditionalField,I extends BaseFileInputFiles,F extends BaseFileField>
extends BaseFileMeta

Base meta for file-based input steps.

Author:

Alexander Buloichik

Field Summary

Fields

Modifier and Type	Field and Description
A	additionalOutputFields
BaseFileErrorHandling	errorHandling
F[]	inputFields The fields to import...
I	inputFiles
static String	NO
static String[]	RequiredFilesCode
static String[]	RequiredFilesDesc
static String	YES

Fields inherited from class org.pentaho.di.trans.steps.file.BaseFileMeta

servletOutput

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

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

Constructor Summary

Constructors

Constructor and Description
BaseFileInputMeta()

Method Summary

Modifier and Type	Method and Description
Object	clone() Make an exact copy of this step, make sure to explicitly copy Collections etc.
String	getAcceptingField()
String	getAcceptingStepName()
abstract String	getEncoding()
FileInputList	getFileInputList(VariableSpace space)
String[]	getFilePaths(boolean showSamples)
F[]	getInputFields()
static String	getRequiredFilesCode(String tt)
List<ResourceReference>	getResourceDependencies(TransMeta transMeta, StepMeta stepInfo) Get a list of all the resource dependencies that the step is depending on.
void	inputFiles_fileRequired(String[] fileRequiredin)
String[]	inputFiles_includeSubFolders()
void	inputFiles_includeSubFolders(String[] includeSubFoldersin)
boolean	isAcceptingFilenames()

Methods inherited from class org.pentaho.di.trans.steps.file.BaseFileMeta

passDataToServletOutput, writesToFile

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

analyseImpact, analyseImpact, cancelQueries, check, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getFields, 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, getXML, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, readRep, resetStepIoMeta, saveRep, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, setStepIOMeta, supportsErrorHandling

Methods inherited from class java.lang.Object

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

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

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

Field Detail

RequiredFilesCode

public static final String[] RequiredFilesCode

NO

public static final String NO

See Also:

Constant Field Values

YES

public static final String YES

See Also:

Constant Field Values

RequiredFilesDesc

public static final String[] RequiredFilesDesc

inputFiles

public I extends BaseFileInputFiles inputFiles

inputFields

public F extends BaseFileField[] inputFields

The fields to import...

errorHandling

public BaseFileErrorHandling errorHandling

additionalOutputFields

public A extends BaseFileInputAdditionalField additionalOutputFields

Constructor Detail

BaseFileInputMeta

public BaseFileInputMeta()

Method Detail

getInputFields

public F[] getInputFields()

Returns:

the input fields.

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

inputFiles_fileRequired

public void inputFiles_fileRequired(String[] fileRequiredin)

Parameters:

fileRequiredin - The fileRequired to set.

inputFiles_includeSubFolders

public String[] inputFiles_includeSubFolders()

inputFiles_includeSubFolders

public void inputFiles_includeSubFolders(String[] includeSubFoldersin)

getRequiredFilesCode

public static String getRequiredFilesCode(String tt)

getFileInputList

public FileInputList getFileInputList(VariableSpace space)

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

getEncoding

public abstract String getEncoding()

isAcceptingFilenames

public boolean isAcceptingFilenames()

getAcceptingStepName

public String getAcceptingStepName()

getAcceptingField

public String getAcceptingField()

getFilePaths

public String[] getFilePaths(boolean showSamples)

Specified by:

getFilePaths in class BaseFileMeta

Parameters:

showSamples - determines whether the paths being returned are dummy samples or the "template" representation. The samples woulc include things like sample step number, partition number etc ( filename_0_1.txt) , while the non-sample path would include a token ( filename_<step>_<partition>.<extension>)

Returns:

An array of file paths