|
||||||||||
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.update.UpdateMeta
public class UpdateMeta
Field Summary |
---|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
UpdateMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrkeys,
int nrvalues)
|
void |
analyseImpact(List<DatabaseImpact> impact,
TransMeta transMeta,
StepMeta stepMeta,
RowMetaInterface prev,
String[] input,
String[] output,
RowMetaInterface info)
Each step must be able to report on the impact it has on a database, table field, etc. |
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. |
int |
getCommitSize()
|
DatabaseMeta |
getDatabaseMeta()
|
void |
getFields(RowMetaInterface row,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String |
getIgnoreFlagField()
|
String[] |
getKeyCondition()
|
String[] |
getKeyLookup()
|
String[] |
getKeyStream()
|
String[] |
getKeyStream2()
|
String |
getSchemaName()
|
SQLStatement |
getSQLStatements(TransMeta transMeta,
StepMeta stepMeta,
RowMetaInterface prev)
Standard method to return one or more SQLStatement objects that the step needs in order to work correctly. |
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 |
getTableName()
|
String[] |
getUpdateLookup()
|
String[] |
getUpdateStream()
|
DatabaseMeta[] |
getUsedDatabaseConnections()
This method returns all the database connections that are used by the step. |
String |
getXML()
Produces the XML string that describes this step's information. |
boolean |
isErrorIgnored()
|
boolean |
isSkipLookup()
|
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 |
setCommitSize(int commitSize)
|
void |
setDatabaseMeta(DatabaseMeta database)
|
void |
setDefault()
Set default values |
void |
setErrorIgnored(boolean ignoreError)
|
void |
setIgnoreFlagField(String ignoreFlagField)
|
void |
setKeyCondition(String[] keyCondition)
|
void |
setKeyLookup(String[] keyLookup)
|
void |
setKeyStream(String[] keyStream)
|
void |
setKeyStream2(String[] keyStream2)
|
void |
setSchemaName(String schemaName)
|
void |
setSkipLookup(boolean skipLookup)
|
void |
setTableName(String tableName)
|
void |
setUpdateLookup(String[] updateLookup)
|
void |
setUpdateStream(String[] updateStream)
|
void |
setUseBatchUpdate(boolean useBatchUpdate)
|
boolean |
supportsErrorHandling()
|
boolean |
useBatchUpdate()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UpdateMeta()
Method Detail |
---|
public int getCommitSize()
public void setCommitSize(int commitSize)
commitSize
- The commitSize to set.public boolean isSkipLookup()
public void setSkipLookup(boolean skipLookup)
skipLookup
- The skipLookup to set.public DatabaseMeta getDatabaseMeta()
public void setDatabaseMeta(DatabaseMeta database)
database
- The database to set.public String[] getKeyCondition()
public void setKeyCondition(String[] keyCondition)
keyCondition
- The keyCondition to set.public String[] getKeyLookup()
public void setKeyLookup(String[] keyLookup)
keyLookup
- The keyLookup to set.public String[] getKeyStream()
public void setKeyStream(String[] keyStream)
keyStream
- The keyStream to set.public String[] getKeyStream2()
public void setKeyStream2(String[] keyStream2)
keyStream2
- The keyStream2 to set.public String getTableName()
public void setTableName(String tableName)
tableName
- The tableName to set.public String[] getUpdateLookup()
public void setUpdateLookup(String[] updateLookup)
updateLookup
- The updateLookup to set.public String[] getUpdateStream()
public void setUpdateStream(String[] updateStream)
updateStream
- The updateStream to set.public boolean isErrorIgnored()
public void setErrorIgnored(boolean ignoreError)
ignoreError
- The ignoreError to set.public String getIgnoreFlagField()
public void setIgnoreFlagField(String ignoreFlagField)
ignoreFlagField
- The ignoreFlagField to set.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 nrkeys, int nrvalues)
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 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 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 SQLStatement getSQLStatements(TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev)
BaseStepMeta
getSQLStatements
in interface StepMetaInterface
getSQLStatements
in class BaseStepMeta
transMeta
- TransInfo object containing the complete transformationstepMeta
- StepMeta object containing the complete stepprev
- Row containing meta-data for the input fields (no data)
public void analyseImpact(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info) throws KettleStepException
BaseStepMeta
analyseImpact
in interface StepMetaInterface
analyseImpact
in class BaseStepMeta
impact
- The list of impacts @see org.pentaho.di.transMeta.DatabaseImpacttransMeta
- The transformation informationstepMeta
- The step informationprev
- The fields entering this stepinput
- The previous step namesoutput
- The output step namesinfo
- The fields used as information by this step
KettleStepException
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 DatabaseMeta[] getUsedDatabaseConnections()
BaseStepMeta
getUsedDatabaseConnections
in interface StepMetaInterface
getUsedDatabaseConnections
in class BaseStepMeta
public String getSchemaName()
public void setSchemaName(String schemaName)
schemaName
- the schemaName to setpublic boolean supportsErrorHandling()
supportsErrorHandling
in interface StepMetaInterface
supportsErrorHandling
in class BaseStepMeta
public boolean useBatchUpdate()
public void setUseBatchUpdate(boolean useBatchUpdate)
useBatchUpdate
- the useBatchUpdate to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |