org.pentaho.di.trans.steps.getsubfolders
Class GetSubFoldersMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.getsubfolders.GetSubFoldersMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class GetSubFoldersMeta
extends BaseStepMeta
implements StepMetaInterface

Since:

18-July-2008

Author:

Samatar

Field Summary

static String	NO
static String[]	RequiredFoldersCode
static String[]	RequiredFoldersDesc

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

GetSubFoldersMeta()

Method Summary

void	allocate(int nrfiles)
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.
FileInputList	getDynamicFolderList(VariableSpace space, String[] folderName, String[] folderRequired)
String	getDynamicFoldernameField()
void	getFields(RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Get the fields that are emitted by this step
FileInputList	getFolderList(VariableSpace space)
String[]	getFolderName()
String[]	getFolderRequired()
String	getRequiredFilesDesc(String tt)
String	getRequiredFoldersCode(String tt)
long	getRowLimit()
String	getRowNumberField()
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.
String	getXML() Produces the XML string that describes this step's information.
boolean	includeRowNumber()
boolean	isFoldernameDynamic()
void	loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) Load the values for this step from an XML Node
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	setDefault() Set default values
void	setDynamicFoldernameField(String dynamicFoldernameField)
void	setFolderField(boolean isFoldernameDynamic)
void	setFolderName(String[] folderName)
void	setFolderRequired(String[] folderRequiredin)
void	setIncludeRowNumber(boolean includeRowNumber)
void	setRowLimit(long rowLimit)
void	setRowNumberField(String rowNumberField)

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, getResourceDependencies, 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, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta, supportsErrorHandling

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, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling

Field Detail

RequiredFoldersDesc

public static final String[] RequiredFoldersDesc

RequiredFoldersCode

public static final String[] RequiredFoldersCode

NO

public static final String NO

See Also:

Constant Field Values

Constructor Detail

GetSubFoldersMeta

public GetSubFoldersMeta()

Method Detail

getRequiredFilesDesc

public String getRequiredFilesDesc(String tt)

getRowNumberField

public String getRowNumberField()

Returns:

Returns the rowNumberField.

setDynamicFoldernameField

public void setDynamicFoldernameField(String dynamicFoldernameField)

Parameters:

dynamicFoldernameField - The dynamic foldername field to set.

setRowNumberField

public void setRowNumberField(String rowNumberField)

Parameters:

rowNumberField - The rowNumberField to set.

getDynamicFoldernameField

public String getDynamicFoldernameField()

Returns:

Returns the dynamic folder field (from previous steps)

includeRowNumber

public boolean includeRowNumber()

Returns:

Returns the includeRowNumber.

isFoldernameDynamic

public boolean isFoldernameDynamic()

Returns:

Returns the dynamic foldername flag.

setFolderField

public void setFolderField(boolean isFoldernameDynamic)

Parameters:

isFoldernameDynamic - The isFoldernameDynamic to set.

setIncludeRowNumber

public void setIncludeRowNumber(boolean includeRowNumber)

Parameters:

includeRowNumber - The includeRowNumber to set.

getFolderRequired

public String[] getFolderRequired()

Returns:

Returns the folderRequired.

getRequiredFoldersCode

public String getRequiredFoldersCode(String tt)

setFolderRequired

public void setFolderRequired(String[] folderRequiredin)

Parameters:

folderRequired - The folderRequired to set.

getFolderName

public String[] getFolderName()

Returns:

Returns the folderName.

setFolderName

public void setFolderName(String[] folderName)

Parameters:

folderName - The folderName to set.

getRowLimit

public long getRowLimit()

Returns:

Returns the rowLimit.

setRowLimit

public void setRowLimit(long rowLimit)

Parameters:

rowLimit - The rowLimit to set.

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 from

databases - The available list of databases to reference to

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

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 interface: StepMetaInterface

Get the fields that are emitted by this step

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

row - The fields that are entering the step. These are changed to reflect the output metadata.

name - The name of the step to be used as origin

info - The input rows metadata that enters the step through the specified channels in the same order as in method getInfoSteps(). The step metadata can then choose what to do with it: ignore it or not. Interesting is also that in case of database lookups, the layout of the target database table is put in info[0]

nextStep - if this is a non-null value, it's the next step in the transformation. The one who's asking, the step where the data is targetted towards.

space - TODO

Throws:

KettleStepException - when an error occurred searching for the fields.

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.

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 from

id_step - The step ID

databases - The databases to reference

counters - 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 to

id_transformation - The transformation ID

id_step - The step ID

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

getFolderList

public FileInputList getFolderList(VariableSpace space)

getDynamicFolderList

public FileInputList getDynamicFolderList(VariableSpace space,
                                          String[] folderName,
                                          String[] folderRequired)

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.CheckResult

stepinfo - 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

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

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.

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 variable space to use

repository - The repository to optionally load other resources from (to be converted to XML)

Returns:

the filename of the exported resource

Throws:

KettleException