|
||||||||||
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.processfiles.ProcessFilesMeta
public class ProcessFilesMeta
Field Summary | |
---|---|
static int |
OPERATION_TYPE_COPY
|
static int |
OPERATION_TYPE_DELETE
|
static int |
OPERATION_TYPE_MOVE
|
static String[] |
operationTypeCode
The operations type codes |
static String[] |
operationTypeDesc
The operations description |
boolean |
simulate
|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
ProcessFilesMeta()
|
Method Summary | |
---|---|
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 |
getDynamicSourceFileNameField()
|
String |
getDynamicTargetFileNameField()
|
int |
getOperationType()
|
static int |
getOperationTypeByDesc(String tt)
|
static String |
getOperationTypeDesc(int i)
|
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 |
isaddTargetFileNametoResult()
|
boolean |
isCreateParentFolder()
|
boolean |
isOverwriteTargetFile()
|
boolean |
isSimulate()
|
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 |
setaddTargetFileNametoResult(boolean addresultfilenames)
|
void |
setCreateParentFolder(boolean createparentfolder)
|
void |
setDefault()
Set default values |
void |
setDynamicSourceFileNameField(String sourcefilenamefield)
|
void |
setDynamicTargetFileNameField(String targetfilenamefield)
|
void |
setOperationType(int operationType)
|
void |
setOverwriteTargetFile(boolean overwritetargetfile)
|
void |
setSimulate(boolean simulate)
|
boolean |
supportsErrorHandling()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public boolean simulate
public static final String[] operationTypeDesc
public static final String[] operationTypeCode
public static final int OPERATION_TYPE_COPY
public static final int OPERATION_TYPE_MOVE
public static final int OPERATION_TYPE_DELETE
Constructor Detail |
---|
public ProcessFilesMeta()
Method Detail |
---|
public int getOperationType()
public static int getOperationTypeByDesc(String tt)
public void setOperationType(int operationType)
public static String getOperationTypeDesc(int i)
public String getDynamicSourceFileNameField()
public void setDynamicSourceFileNameField(String sourcefilenamefield)
sourcefilenamefield
- The sourcefilenamefield to set.public String getDynamicTargetFileNameField()
public void setDynamicTargetFileNameField(String targetfilenamefield)
targetfilenamefield
- The targetfilenamefield to set.public boolean isaddTargetFileNametoResult()
public boolean isOverwriteTargetFile()
public boolean isCreateParentFolder()
public void setaddTargetFileNametoResult(boolean addresultfilenames)
public void setOverwriteTargetFile(boolean overwritetargetfile)
public void setCreateParentFolder(boolean createparentfolder)
public void setSimulate(boolean simulate)
public boolean isSimulate()
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 setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
public 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 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, 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.CheckResultstepMeta
- 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 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 boolean supportsErrorHandling()
supportsErrorHandling
in interface StepMetaInterface
supportsErrorHandling
in class BaseStepMeta
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |