org.pentaho.di.trans.steps.getfilesrowscount
Class GetFilesRowsCountMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.getfilesrowscount.GetFilesRowsCountMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface

public class GetFilesRowsCountMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
static String DEFAULT_ROWSCOUNT_FIELDNAME
           
static String[] RequiredFilesCode
           
static String[] RequiredFilesDesc
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
GetFilesRowsCountMeta()
           
 
Method Summary
 void allocate(int nrfiles)
           
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, 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[] getExludeFileMask()
           
 void getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String[] getFileMask()
           
 String[] getFileName()
           
 String[] getFileRequired()
           
 FileInputList getFiles(VariableSpace space)
           
 String getFilesCountFieldName()
           
 String[] getIncludeSubFolders()
           
 String getRequiredFilesCode(String tt)
           
 String getRequiredFilesDesc(String tt)
           
 String getRowsCountFieldName()
           
 String getRowSeparator()
           
 String getRowSeparatorFormat()
           
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, 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 includeCountFiles()
           
 boolean isAddResultFile()
           
 boolean isFileField()
           
 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 setAddResultFile(boolean isaddresult)
           
 void setDefault()
          Set default values
 void setExcludeFileMask(String[] excludeFileMask)
           
 void setFileField(boolean filefield)
           
 void setFileMask(String[] fileMask)
           
 void setFileName(String[] fileName)
           
 void setFileRequired(String[] fileRequiredin)
           
 void setFilesCountFieldName(String filesCountFieldName)
           
 void setIncludeCountFiles(boolean includeFilesCount)
           
 void setIncludeSubFolders(String[] includeSubFoldersin)
           
 String setOutputFilenameField()
           
 void setOutputFilenameField(String outputFilenameField)
           
 void setRowsCountFieldName(String rowsCountFieldName)
           
 void setRowSeparator(String RowSeparatorin)
           
 void setRowSeparatorFormat(String RowSeparator_formatin)
           
 
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

RequiredFilesDesc

public static final String[] RequiredFilesDesc

RequiredFilesCode

public static final String[] RequiredFilesCode

DEFAULT_ROWSCOUNT_FIELDNAME

public static final String DEFAULT_ROWSCOUNT_FIELDNAME
See Also:
Constant Field Values
Constructor Detail

GetFilesRowsCountMeta

public GetFilesRowsCountMeta()
Method Detail

getRowSeparator

public String getRowSeparator()
Returns:
Returns the row separator.

setRowSeparator

public void setRowSeparator(String RowSeparatorin)
Parameters:
RowSeparatorin - The RowSeparator to set.

getRowSeparatorFormat

public String getRowSeparatorFormat()
Returns:
Returns the row separator format.

setAddResultFile

public void setAddResultFile(boolean isaddresult)
Parameters:
isaddresult - The isaddresult to set.

getExludeFileMask

public String[] getExludeFileMask()
Returns:
Returns the excludeFileMask.

setExcludeFileMask

public void setExcludeFileMask(String[] excludeFileMask)
Parameters:
excludeFileMask - The excludeFileMask to set.

isAddResultFile

public boolean isAddResultFile()
Returns:
Returns isaddresult.

setOutputFilenameField

public String setOutputFilenameField()
Returns:
Returns the output filename_Field.

setOutputFilenameField

public void setOutputFilenameField(String outputFilenameField)
Parameters:
outputFilenameField - The output filename_field to set.

isFileField

public boolean isFileField()
Returns:
Returns the File field.

setFileField

public void setFileField(boolean filefield)
Parameters:
filefield - The file field to set.

setRowSeparatorFormat

public void setRowSeparatorFormat(String RowSeparator_formatin)
Parameters:
RowSeparator_formatin - The RowSeparator_format to set.

getFileMask

public String[] getFileMask()
Returns:
Returns the fileMask.

setFileRequired

public void setFileRequired(String[] fileRequiredin)

getIncludeSubFolders

public String[] getIncludeSubFolders()

setIncludeSubFolders

public void setIncludeSubFolders(String[] includeSubFoldersin)

getRequiredFilesCode

public String getRequiredFilesCode(String tt)

getRequiredFilesDesc

public String getRequiredFilesDesc(String tt)

setFileMask

public void setFileMask(String[] fileMask)
Parameters:
fileMask - The fileMask to set.

getFileName

public String[] getFileName()
Returns:
Returns the fileName.

setFileName

public void setFileName(String[] fileName)
Parameters:
fileName - The fileName to set.

includeCountFiles

public boolean includeCountFiles()
Returns:
Returns the includeCountFiles.

setIncludeCountFiles

public void setIncludeCountFiles(boolean includeFilesCount)
Parameters:
includeFilesCount - The "includes files count" flag to set.

getFileRequired

public String[] getFileRequired()

getFilesCountFieldName

public String getFilesCountFieldName()
Returns:
Returns the FilesCountFieldName.

getRowsCountFieldName

public String getRowsCountFieldName()
Returns:
Returns the RowsCountFieldName.

setFilesCountFieldName

public void setFilesCountFieldName(String filesCountFieldName)
Parameters:
filesCountFieldName - The filesCountFieldName to set.

setRowsCountFieldName

public void setRowsCountFieldName(String rowsCountFieldName)
Parameters:
rowsCountFieldName - The rowsCountFieldName 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

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.

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 r,
                      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:
r - the input row meta
name - the name
info - the info
nextStep - the next step
space - the space
Throws:
KettleStepException - the kettle step exception

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)

getFiles

public FileInputList getFiles(VariableSpace space)

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  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
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

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta tr,
                             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
tr - 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 space
definitions - the definitions
resourceNamingInterface - the resource naming interface
repository - the repository
Returns:
the string
Throws:
KettleException - the kettle exception