org.pentaho.di.trans.steps.file

Class BaseFileMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

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

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

Direct Known Subclasses:

BaseFileInputMeta, BaseFileOutputMeta

public abstract class BaseFileMeta
extends BaseStepMeta
implements StepMetaInterface

A base parent class for all file based metas.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	servletOutput Whether to push the output into the output of a servlet with the executeTrans Carte/DI-Server servlet

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

Method Summary

Modifier and Type	Method and Description
abstract String[]	getFilePaths(boolean showSamples)
boolean	passDataToServletOutput() True if the step passes it's result data straight to the servlet output.
boolean	writesToFile() Returns true if the given step writes to a file, and false otherwise.

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

analyseImpact, analyseImpact, cancelQueries, check, check, check, clone, 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, getResourceDependencies, 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, clone, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, fetchTransMeta, getActiveReferencedObjectDescription, getDialogClassName, getFields, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, 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

servletOutput

protected boolean servletOutput

Whether to push the output into the output of a servlet with the executeTrans Carte/DI-Server servlet

Constructor Detail

BaseFileMeta

public BaseFileMeta()

Method Detail

getFilePaths

public abstract String[] getFilePaths(boolean showSamples)

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

passDataToServletOutput

public boolean passDataToServletOutput()

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

Specified by:

passDataToServletOutput in interface StepMetaInterface

Returns:

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

writesToFile

public boolean writesToFile()

Returns true if the given step writes to a file, and false otherwise.

Returns:

true if the given step writes to a file, and false otherwise