|
||||||||||
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.databaselookup.DatabaseLookupMeta
public class DatabaseLookupMeta
Field Summary | |
---|---|
static int |
CONDITION_BETWEEN
|
static int |
CONDITION_EQ
|
static int |
CONDITION_GE
|
static int |
CONDITION_GT
|
static int |
CONDITION_IS_NOT_NULL
|
static int |
CONDITION_IS_NULL
|
static int |
CONDITION_LE
|
static int |
CONDITION_LIKE
|
static int |
CONDITION_LT
|
static int |
CONDITION_NE
|
static String[] |
conditionStrings
|
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta |
---|
loggingObject, STEP_ATTRIBUTES_FILE |
Constructor Summary | |
---|---|
DatabaseLookupMeta()
|
Method Summary | |
---|---|
void |
allocate(int nrkeys,
int nrvalues)
|
void |
analyseImpact(List<DatabaseImpact> impact,
TransMeta transMeta,
StepMeta stepinfo,
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 |
getCacheSize()
|
DatabaseMeta |
getDatabaseMeta()
|
void |
getFields(RowMetaInterface row,
String name,
RowMetaInterface[] info,
StepMeta nextStep,
VariableSpace space)
Gets the fields. |
String[] |
getKeyCondition()
|
String |
getOrderByClause()
|
String[] |
getReturnValueDefault()
|
int[] |
getReturnValueDefaultType()
|
String[] |
getReturnValueField()
|
String[] |
getReturnValueNewName()
|
String |
getSchemaName()
|
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[] |
getStreamKeyField1()
|
String[] |
getStreamKeyField2()
|
RowMetaInterface |
getTableFields()
Gets the table fields. |
String[] |
getTableKeyField()
|
String |
getTablename()
|
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 |
isCached()
|
boolean |
isEatingRowOnLookupFailure()
|
boolean |
isFailingOnMultipleResults()
|
boolean |
isLoadingAllDataInCache()
|
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 |
setCached(boolean cached)
|
void |
setCacheSize(int cacheSize)
|
void |
setDatabaseMeta(DatabaseMeta database)
|
void |
setDefault()
Set default values |
void |
setEatingRowOnLookupFailure(boolean eatingRowOnLookupFailure)
|
void |
setFailingOnMultipleResults(boolean failOnMultipleResults)
|
void |
setKeyCondition(String[] keyCondition)
|
void |
setLoadingAllDataInCache(boolean loadingAllDataInCache)
|
void |
setOrderByClause(String orderByClause)
|
void |
setReturnValueDefault(String[] returnValueDefault)
|
void |
setReturnValueDefaultType(int[] returnValueDefaultType)
|
void |
setReturnValueField(String[] returnValueField)
|
void |
setReturnValueNewName(String[] returnValueNewName)
|
void |
setSchemaName(String schemaName)
|
void |
setStreamKeyField1(String[] streamKeyField1)
|
void |
setStreamKeyField2(String[] streamKeyField2)
|
void |
setTableKeyField(String[] tableKeyField)
|
void |
setTablename(String tablename)
|
boolean |
supportsErrorHandling()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String[] conditionStrings
public static final int CONDITION_EQ
public static final int CONDITION_NE
public static final int CONDITION_LT
public static final int CONDITION_LE
public static final int CONDITION_GT
public static final int CONDITION_GE
public static final int CONDITION_LIKE
public static final int CONDITION_BETWEEN
public static final int CONDITION_IS_NULL
public static final int CONDITION_IS_NOT_NULL
Constructor Detail |
---|
public DatabaseLookupMeta()
Method Detail |
---|
public boolean isCached()
public void setCached(boolean cached)
cached
- The cached to set.public int getCacheSize()
public void setCacheSize(int cacheSize)
cacheSize
- The cacheSize 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 getOrderByClause()
public void setOrderByClause(String orderByClause)
orderByClause
- The orderByClause to set.public String[] getReturnValueDefault()
public void setReturnValueDefault(String[] returnValueDefault)
returnValueDefault
- The returnValueDefault to set.public int[] getReturnValueDefaultType()
public void setReturnValueDefaultType(int[] returnValueDefaultType)
returnValueDefaultType
- The returnValueDefaultType to set.public String[] getReturnValueField()
public void setReturnValueField(String[] returnValueField)
returnValueField
- The returnValueField to set.public String[] getReturnValueNewName()
public void setReturnValueNewName(String[] returnValueNewName)
returnValueNewName
- The returnValueNewName to set.public String[] getStreamKeyField1()
public void setStreamKeyField1(String[] streamKeyField1)
streamKeyField1
- The streamKeyField1 to set.public String[] getStreamKeyField2()
public void setStreamKeyField2(String[] streamKeyField2)
streamKeyField2
- The streamKeyField2 to set.public String[] getTableKeyField()
public void setTableKeyField(String[] tableKeyField)
tableKeyField
- The tableKeyField to set.public String getTablename()
public void setTablename(String tablename)
tablename
- The tablename to set.public boolean isFailingOnMultipleResults()
public void setFailingOnMultipleResults(boolean failOnMultipleResults)
failOnMultipleResults
- The failOnMultipleResults 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 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 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 RowMetaInterface getTableFields()
BaseStepMeta
getTableFields
in interface StepMetaInterface
getTableFields
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 void analyseImpact(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepinfo, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info)
BaseStepMeta
analyseImpact
in interface StepMetaInterface
analyseImpact
in class BaseStepMeta
impact
- The list of impacts @see org.pentaho.di.transMeta.DatabaseImpacttransMeta
- The transformation informationstepinfo
- The step informationprev
- The fields entering this stepinput
- The previous step namesoutput
- The output step namesinfo
- The fields used as information by this steppublic DatabaseMeta[] getUsedDatabaseConnections()
BaseStepMeta
getUsedDatabaseConnections
in interface StepMetaInterface
getUsedDatabaseConnections
in class BaseStepMeta
public boolean isEatingRowOnLookupFailure()
public void setEatingRowOnLookupFailure(boolean eatingRowOnLookupFailure)
eatingRowOnLookupFailure
- The eatingRowOnLookupFailure to set.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 isLoadingAllDataInCache()
public void setLoadingAllDataInCache(boolean loadingAllDataInCache)
loadingAllDataInCache
- the loadingAllDataInCache to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |