|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.di.trans.step.BaseStepMeta org.pentaho.di.trans.steps.getfilenames.GetFileNamesMeta
public class GetFileNamesMeta
Field Summary | |
---|---|
static String[] |
RequiredFilesCode
|
static String[] |
RequiredFilesDesc
|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
GetFileNamesMeta()
|
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. |
String |
getDynamicExcludeWildcardField()
|
FileInputList |
getDynamicFileList(VariableSpace space,
String[] filename,
String[] filemask,
String[] excludefilemask,
String[] filerequired,
boolean[] includesubfolders)
|
String |
getDynamicFilenameField()
|
String |
getDynamicWildcardField()
|
String[] |
getExludeFileMask()
|
void |
getFields(RowMetaInterface row,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
FileInputList |
getFileList(VariableSpace space)
|
String[] |
getFileMask()
|
String[] |
getFileName()
|
String |
getFilenameField()
|
String[] |
getFilePaths(VariableSpace space)
|
String[] |
getFileRequired()
|
FileInputList.FileTypeFilter |
getFileTypeFilter()
|
String[] |
getIncludeSubFolders()
|
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. |
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 |
isAddResultFile()
|
boolean |
isdoNotFailIfNoFile()
|
boolean |
isDynamicIncludeSubFolders()
|
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 |
setdoNotFailIfNoFile(boolean doNotFailIfNoFile)
|
void |
setDynamicExcludeWildcardField(String dynamicExcludeWildcardField)
|
void |
setDynamicFilenameField(String dynamicFilenameField)
|
void |
setDynamicIncludeSubFolders(boolean dynamicIncludeSubFolders)
|
void |
setDynamicWildcardField(String dynamicWildcardField)
|
void |
setExcludeFileMask(String[] excludeFileMask)
|
void |
setFileField(boolean filefield)
|
void |
setFileMask(String[] fileMask)
|
void |
setFileName(String[] fileName)
|
void |
setFileRequired(String[] fileRequiredin)
|
void |
setFilterFileType(int filtertypevalue)
|
void |
setIncludeRowNumber(boolean includeRowNumber)
|
void |
setIncludeSubFolders(String[] includeSubFoldersin)
|
void |
setRowLimit(long rowLimit)
|
void |
setRowNumberField(String rowNumberField)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String[] RequiredFilesDesc
public static final String[] RequiredFilesCode
Constructor Detail |
---|
public GetFileNamesMeta()
Method Detail |
---|
public boolean isdoNotFailIfNoFile()
public void setdoNotFailIfNoFile(boolean doNotFailIfNoFile)
doNotFailIfNoFile
- the doNotFailIfNoFile to setpublic String getFilenameField()
public String getRowNumberField()
public void setDynamicFilenameField(String dynamicFilenameField)
dynamicFilenameField
- The dynamic filename field to set.public void setDynamicWildcardField(String dynamicWildcardField)
dynamicWildcardField
- The dynamic wildcard field to set.public void setRowNumberField(String rowNumberField)
rowNumberField
- The rowNumberField to set.public String getDynamicFilenameField()
public String getDynamicWildcardField()
public String getDynamicExcludeWildcardField()
public void setDynamicExcludeWildcardField(String dynamicExcludeWildcardField)
excludeWildcard
- The dynamic excludeWildcard field to set.public boolean includeRowNumber()
public boolean isFileField()
public void setFileField(boolean filefield)
filefield
- The filefield to set.public boolean isDynamicIncludeSubFolders()
public void setDynamicIncludeSubFolders(boolean dynamicIncludeSubFolders)
public void setIncludeRowNumber(boolean includeRowNumber)
includeRowNumber
- The includeRowNumber to set.public void setAddResultFile(boolean isaddresult)
isaddresult
- The isaddresult to set.public boolean isAddResultFile()
public String[] getFileMask()
public String[] getFileRequired()
public void setFileMask(String[] fileMask)
fileMask
- The fileMask to set.public void setExcludeFileMask(String[] excludeFileMask)
excludeFileMask
- The excludeFileMask to set.public String[] getExludeFileMask()
public void setFileRequired(String[] fileRequiredin)
fileRequired
- The fileRequired to set.public String[] getFileName()
public void setFileName(String[] fileName)
fileName
- The fileName to set.public String getRequiredFilesDesc(String tt)
public void setIncludeSubFolders(String[] includeSubFoldersin)
public String getRequiredFilesCode(String tt)
public long getRowLimit()
public void setRowLimit(long rowLimit)
rowLimit
- The rowLimit to set.public void setFilterFileType(int filtertypevalue)
public FileInputList.FileTypeFilter getFileTypeFilter()
public void loadXML(Node stepnode, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleXMLException
StepMetaInterface
loadXML
in interface StepMetaInterface
stepnode
- the Node to get the info fromdatabases
- The available list of databases to reference tocounters
- Counters to reference.
KettleXMLException
- When an unexpected XML error occurred. (malformed etc.)public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public void allocate(int nrfiles)
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public void getFields(RowMetaInterface row, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) throws KettleStepException
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
row
- the input row metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the space
KettleStepException
- the kettle step exceptionpublic String getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
public void readRep(Repository rep, ObjectId id_step, List<DatabaseMeta> databases, Map<String,Counter> counters) throws KettleException
StepMetaInterface
readRep
in interface StepMetaInterface
rep
- The repository to read fromid_step
- The step IDdatabases
- The databases to referencecounters
- The counters to reference
KettleException
- When an unexpected error occurred (database, network, etc)public void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step) throws KettleException
StepMetaInterface
saveRep
in interface StepMetaInterface
rep
- The Kettle repository to save toid_transformation
- The transformation IDid_step
- The step ID
KettleException
- When an unexpected error occurred (database, network, etc)public String[] getIncludeSubFolders()
public String[] getFilePaths(VariableSpace space)
public FileInputList getFileList(VariableSpace space)
public FileInputList getDynamicFileList(VariableSpace space, String[] filename, String[] filemask, String[] excludefilemask, String[] filerequired, boolean[] includesubfolders)
public void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
StepMetaInterface
check
in interface StepMetaInterface
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 steppublic List<ResourceReference> getResourceDependencies(TransMeta transMeta, StepMeta stepInfo)
BaseStepMeta
getResourceDependencies
in interface StepMetaInterface
getResourceDependencies
in class BaseStepMeta
public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta transMeta, Trans trans)
StepMetaInterface
getStep
in interface StepMetaInterface
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 transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public String exportResources(VariableSpace space, Map<String,ResourceDefinition> definitions, ResourceNamingInterface resourceNamingInterface, Repository repository) throws KettleException
exportResources
in interface StepMetaInterface
exportResources
in class BaseStepMeta
space
- the spacedefinitions
- the definitionsresourceNamingInterface
- the resource naming interfacerepository
- the repository
KettleException
- the kettle exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |