|
||||||||||
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.mailinput.MailInputMeta
public class MailInputMeta
Field Summary | |
---|---|
int |
conditionReceivedDate
|
static String |
DATE_PATTERN
|
int |
retrievemails
|
int |
valueimaplist
|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
MailInputMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrfields)
|
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. |
int |
getConditionOnReceivedDate()
|
boolean |
getDelete()
|
void |
getFields(RowMetaInterface r,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String |
getFirstIMAPMails()
|
String |
getFirstMails()
|
String |
getFolderField()
|
String |
getIMAPFolder()
|
MailInputField[] |
getInputFields()
|
String |
getPassword()
|
String |
getPort()
|
String |
getProtocol()
|
String |
getProxyUsername()
|
String |
getReceivedDate1()
|
String |
getReceivedDate2()
|
String |
getRecipientSearch()
|
int |
getRetrievemails()
|
String |
getRowLimit()
|
String |
getSenderSearchTerm()
|
String |
getServerName()
|
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 |
getSubjectSearch()
|
String |
getUserName()
|
int |
getValueImapList()
|
String |
getXML()
Produces the XML string that describes this step's information. |
boolean |
isDynamicFolder()
|
boolean |
isIncludeSubFolders()
|
boolean |
isNotTermReceivedDateSearch()
|
boolean |
isNotTermRecipientSearch()
|
boolean |
isNotTermSenderSearch()
|
boolean |
isNotTermSubjectSearch()
|
boolean |
isUseProxy()
|
boolean |
isUseSSL()
|
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 |
setConditionOnReceivedDate(int conditionReceivedDate)
|
void |
setDefault()
Set default values |
void |
setDelete(boolean delete)
|
void |
setDynamicFolder(boolean usedynamicfolder)
|
void |
setFirstIMAPMails(String firstmails)
|
void |
setFirstMails(String firstmails)
|
void |
setFolderField(String folderfield)
|
void |
setIMAPFolder(String folder)
|
void |
setIncludeSubFolders(boolean includesubfolders)
|
void |
setInputFields(MailInputField[] inputFields)
|
void |
setNotTermReceivedDateSearch(boolean notTermReceivedDateSearch)
|
void |
setNotTermRecipientSearch(boolean notTermRecipientSearch)
|
void |
setNotTermSenderSearch(boolean notTermSenderSearch)
|
void |
setNotTermSubjectSearch(boolean notTermSubjectSearch)
|
void |
setPassword(String password)
|
void |
setPort(String sslport)
|
void |
setProtocol(String protocol)
|
void |
setProxyUsername(String username)
|
void |
setReceivedDate1(String inputDate)
|
void |
setReceivedDate2(String inputDate)
|
void |
setRecipientSearch(String recipientSearch)
|
void |
setRetrievemails(int nr)
|
void |
setRowLimit(String rowlimit)
|
void |
setSenderSearchTerm(String senderSearch)
|
void |
setServerName(String servername)
|
void |
setSubjectSearch(String subjectSearch)
|
void |
setUseProxy(boolean useprox)
|
void |
setUserName(String username)
|
void |
setUseSSL(boolean usessl)
|
void |
setValueImapList(int value)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DATE_PATTERN
public int conditionReceivedDate
public int valueimaplist
public int retrievemails
Constructor Detail |
---|
public MailInputMeta()
Method Detail |
---|
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 void allocate(int nrfields)
public Object clone()
StepMetaInterface
clone
in interface StepMetaInterface
clone
in class BaseStepMeta
public void setDefault()
StepMetaInterface
setDefault
in interface StepMetaInterface
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 getXML()
BaseStepMeta
getXML
in interface StepMetaInterface
getXML
in class BaseStepMeta
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 String getPort()
public void setPort(String sslport)
public void setFirstMails(String firstmails)
public String getFirstMails()
public boolean isIncludeSubFolders()
public void setIncludeSubFolders(boolean includesubfolders)
public boolean isUseProxy()
public void setUseProxy(boolean useprox)
public void setProxyUsername(String username)
public String getProxyUsername()
public boolean isDynamicFolder()
public void setDynamicFolder(boolean usedynamicfolder)
public void setRowLimit(String rowlimit)
public String getRowLimit()
public void setFolderField(String folderfield)
public String getFolderField()
public void setFirstIMAPMails(String firstmails)
public String getFirstIMAPMails()
public void setSenderSearchTerm(String senderSearch)
public String getSenderSearchTerm()
public void setNotTermSenderSearch(boolean notTermSenderSearch)
public boolean isNotTermSenderSearch()
public void setNotTermSubjectSearch(boolean notTermSubjectSearch)
public boolean isNotTermSubjectSearch()
public void setNotTermReceivedDateSearch(boolean notTermReceivedDateSearch)
public boolean isNotTermReceivedDateSearch()
public void setNotTermRecipientSearch(boolean notTermRecipientSearch)
public boolean isNotTermRecipientSearch()
public void setRecipientSearch(String recipientSearch)
public String getRecipientSearch()
public void setSubjectSearch(String subjectSearch)
public String getSubjectSearch()
public String getReceivedDate1()
public void setReceivedDate1(String inputDate)
public String getReceivedDate2()
public void setReceivedDate2(String inputDate)
public void setConditionOnReceivedDate(int conditionReceivedDate)
public int getConditionOnReceivedDate()
public void setServerName(String servername)
public String getServerName()
public void setUserName(String username)
public String getUserName()
public void setRetrievemails(int nr)
public int getRetrievemails()
public int getValueImapList()
public void setValueImapList(int value)
public MailInputField[] getInputFields()
public void setInputFields(MailInputField[] inputFields)
inputFields
- The input fields to set.public String getPassword()
public void setDelete(boolean delete)
delete
- The delete to set.public boolean getDelete()
public String getProtocol()
public void setProtocol(String protocol)
public String getIMAPFolder()
public void setIMAPFolder(String folder)
public void setUseSSL(boolean usessl)
usessl
- The usessl to set.public boolean isUseSSL()
public void setPassword(String password)
password
- The password to set.public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, 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 gettr
- The transformation infotrans
- The launching transformationpublic StepDataInterface getStepData()
StepMetaInterface
getStepData
in interface StepMetaInterface
public void getFields(RowMetaInterface r, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) throws KettleStepException
BaseStepMeta
getFields
in interface StepMetaInterface
getFields
in class BaseStepMeta
r
- the input row metaname
- the nameinfo
- the infonextStep
- the next stepspace
- the space
KettleStepException
- the kettle step exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |