org.pentaho.di.trans.steps.combinationlookup
Class CombinationLookupMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.combinationlookup.CombinationLookupMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface

public class CombinationLookupMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
static String CREATION_METHOD_AUTOINC
           
static String CREATION_METHOD_SEQUENCE
           
static String CREATION_METHOD_TABLEMAX
           
static int DEFAULT_CACHE_SIZE
          Default cache size: 0 will cache everything
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
CombinationLookupMeta()
           
 
Method Summary
 void allocate(int nrkeys)
           
 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 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.
 boolean equals(Object other)
           
 int getCacheSize()
           
 int getCommitSize()
           
 DatabaseMeta getDatabaseMeta()
           
 void getFields(RowMetaInterface row, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String getHashField()
           
 String[] getKeyField()
           
 String[] getKeyLookup()
           
 String getLastUpdateField()
           
 String getSchemaName()
           
 String getSequenceFrom()
           
 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 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 getTablename()
           
 String getTechKeyCreation()
          Get the way how the technical key field should be created.
 String getTechnicalKeyField()
           
 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 isUseAutoinc()
           
 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
 boolean replaceFields()
           
 void saveRep(Repository rep, ObjectId id_transformation, ObjectId id_step)
          Save the steps data into a Kettle repository
 void setCacheSize(int cacheSize)
           
 void setCommitSize(int commitSize)
           
 void setDatabaseMeta(DatabaseMeta database)
           
 void setDefault()
          Set default values
 void setHashField(String hashField)
           
 void setKeyField(String[] keyField)
           
 void setKeyLookup(String[] keyLookup)
           
 void setLastUpdateField(String lastUpdateField)
           
 void setReplaceFields(boolean replaceFields)
           
 void setSchemaName(String schemaName)
           
 void setSequenceFrom(String sequenceFrom)
           
 void setTablename(String tablename)
           
 void setTechKeyCreation(String techKeyCreation)
          Set the way how the technical key field should be created.
 void setTechnicalKeyField(String technicalKeyField)
           
 void setUseAutoinc(boolean useAutoinc)
           
 void setUseHash(boolean useHash)
           
 boolean supportsErrorHandling()
           
 boolean useHash()
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isRowLevel, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface
cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta
 

Field Detail

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE
Default cache size: 0 will cache everything

See Also:
Constant Field Values

CREATION_METHOD_AUTOINC

public static String CREATION_METHOD_AUTOINC

CREATION_METHOD_SEQUENCE

public static String CREATION_METHOD_SEQUENCE

CREATION_METHOD_TABLEMAX

public static String CREATION_METHOD_TABLEMAX
Constructor Detail

CombinationLookupMeta

public CombinationLookupMeta()
Method Detail

getDatabaseMeta

public DatabaseMeta getDatabaseMeta()
Returns:
Returns the database.

setDatabaseMeta

public void setDatabaseMeta(DatabaseMeta database)
Parameters:
database - The database to set.

setTechKeyCreation

public void setTechKeyCreation(String techKeyCreation)
Set the way how the technical key field should be created.

Parameters:
techKeyCreation - which method to use for the creation of the technical key.

getTechKeyCreation

public String getTechKeyCreation()
Get the way how the technical key field should be created.

Returns:
creation way for the technical key.

getCommitSize

public int getCommitSize()
Returns:
Returns the commitSize.

setCommitSize

public void setCommitSize(int commitSize)
Parameters:
commitSize - The commitSize to set.

getCacheSize

public int getCacheSize()
Returns:
Returns the cacheSize.

setCacheSize

public void setCacheSize(int cacheSize)
Parameters:
cacheSize - The cacheSize to set.

getHashField

public String getHashField()
Returns:
Returns the hashField.

setHashField

public void setHashField(String hashField)
Parameters:
hashField - The hashField to set.

getKeyField

public String[] getKeyField()
Returns:
Returns the keyField (names in the stream).

setKeyField

public void setKeyField(String[] keyField)
Parameters:
keyField - The keyField to set.

getKeyLookup

public String[] getKeyLookup()
Returns:
Returns the keyLookup (names in the dimension table)

setKeyLookup

public void setKeyLookup(String[] keyLookup)
Parameters:
keyLookup - The keyLookup to set.

replaceFields

public boolean replaceFields()
Returns:
Returns the replaceFields.

setReplaceFields

public void setReplaceFields(boolean replaceFields)
Parameters:
replaceFields - The replaceFields to set.

getSequenceFrom

public String getSequenceFrom()
Returns:
Returns the sequenceFrom.

setSequenceFrom

public void setSequenceFrom(String sequenceFrom)
Parameters:
sequenceFrom - The sequenceFrom to set.

getTablename

public String getTablename()
Returns:
Returns the tablename.

setTablename

public void setTablename(String tablename)
Parameters:
tablename - The tablename to set.

getTechnicalKeyField

public String getTechnicalKeyField()
Returns:
Returns the technicalKeyField.

setTechnicalKeyField

public void setTechnicalKeyField(String technicalKeyField)
Parameters:
technicalKeyField - The technicalKeyField to set.

isUseAutoinc

public boolean isUseAutoinc()
Returns:
Returns the useAutoinc.

setUseAutoinc

public void setUseAutoinc(boolean useAutoinc)
Parameters:
useAutoinc - The useAutoinc to set.

useHash

public boolean useHash()
Returns:
Returns the useHash.

setUseHash

public void setUseHash(boolean useHash)
Parameters:
useHash - The useHash to set.

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleXMLException
Description copied from interface: StepMetaInterface
Load the values for this step from an XML Node

Specified by:
loadXML in interface StepMetaInterface
Parameters:
stepnode - the Node to get the info from
databases - The available list of databases to reference to
counters - Counters to reference.
Throws:
KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocate

public void allocate(int nrkeys)

clone

public Object clone()
Description copied from interface: StepMetaInterface
Make an exact copy of this step, make sure to explicitly copy Collections etc.

Specified by:
clone in interface StepMetaInterface
Overrides:
clone in class BaseStepMeta
Returns:
an exact copy of this step

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

getFields

public void getFields(RowMetaInterface row,
                      String origin,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space)
               throws KettleStepException
Description copied from class: BaseStepMeta
Gets the fields.

Specified by:
getFields in interface StepMetaInterface
Overrides:
getFields in class BaseStepMeta
Parameters:
row - the input row meta
origin - the name
info - the info
nextStep - the next step
space - the space
Throws:
KettleStepException - the kettle step exception

getXML

public String getXML()
Description copied from class: BaseStepMeta
Produces the XML string that describes this step's information.

Specified by:
getXML in interface StepMetaInterface
Overrides:
getXML in class BaseStepMeta
Returns:
String containing the XML describing this step.

readRep

public void readRep(Repository rep,
                    ObjectId id_step,
                    List<DatabaseMeta> databases,
                    Map<String,Counter> counters)
             throws KettleException
Description copied from interface: StepMetaInterface
Read the steps information from a Kettle repository

Specified by:
readRep in interface StepMetaInterface
Parameters:
rep - The repository to read from
id_step - The step ID
databases - The databases to reference
counters - The counters to reference
Throws:
KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    ObjectId id_transformation,
                    ObjectId id_step)
             throws KettleException
Description copied from interface: StepMetaInterface
Save the steps data into a Kettle repository

Specified by:
saveRep in interface StepMetaInterface
Parameters:
rep - The Kettle repository to save to
id_transformation - The transformation ID
id_step - The step ID
Throws:
KettleException - When an unexpected error occurred (database, network, etc)

check

public void check(List<CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  RowMetaInterface info)
Description copied from interface: StepMetaInterface
Checks the settings of this step and puts the findings in a remarks List.

Specified by:
check in interface StepMetaInterface
Parameters:
remarks - The list to put the remarks in @see org.pentaho.di.core.CheckResult
stepMeta - The stepMeta to help checking
prev - The fields coming from the previous step
input - The input step names
output - The output step names
info - The fields that are used as information by the step

getSQLStatements

public SQLStatement getSQLStatements(TransMeta transMeta,
                                     StepMeta stepMeta,
                                     RowMetaInterface prev)
Description copied from class: BaseStepMeta
Standard method to return one or more SQLStatement objects that the step needs in order to work correctly. This can mean "create table", "create index" statements but also "alter table ... add/drop/modify" statements.

Specified by:
getSQLStatements in interface StepMetaInterface
Overrides:
getSQLStatements in class BaseStepMeta
Parameters:
transMeta - TransInfo object containing the complete transformation
stepMeta - StepMeta object containing the complete step
prev - Row containing meta-data for the input fields (no data)
Returns:
The SQL Statements for this step or null if an error occurred. If nothing has to be done, the SQLStatement.getSQL() == null.

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta transMeta,
                             Trans trans)
Description copied from interface: StepMetaInterface
Get the executing step, needed by Trans to launch a step.

Specified by:
getStep in interface StepMetaInterface
Parameters:
stepMeta - The step info
stepDataInterface - the step data interface linked to this step. Here the step can store temporary data, database connections, etc.
cnr - The copy nr to get
transMeta - The transformation info
trans - The launching transformation

getStepData

public StepDataInterface getStepData()
Description copied from interface: StepMetaInterface
Get a new instance of the appropriate data class. This data class implements the StepDataInterface. It basically contains the persisting data that needs to live on, even if a worker thread is terminated.

Specified by:
getStepData in interface StepMetaInterface
Returns:
The appropriate StepDataInterface class.

analyseImpact

public void analyseImpact(List<DatabaseImpact> impact,
                          TransMeta transMeta,
                          StepMeta stepMeta,
                          RowMetaInterface prev,
                          String[] input,
                          String[] output,
                          RowMetaInterface info)
Description copied from class: BaseStepMeta
Each step must be able to report on the impact it has on a database, table field, etc.

Specified by:
analyseImpact in interface StepMetaInterface
Overrides:
analyseImpact in class BaseStepMeta
Parameters:
impact - The list of impacts @see org.pentaho.di.transMeta.DatabaseImpact
transMeta - The transformation information
stepMeta - The step information
prev - The fields entering this step
input - The previous step names
output - The output step names
info - The fields used as information by this step

getUsedDatabaseConnections

public DatabaseMeta[] getUsedDatabaseConnections()
Description copied from class: BaseStepMeta
This method returns all the database connections that are used by the step.

Specified by:
getUsedDatabaseConnections in interface StepMetaInterface
Overrides:
getUsedDatabaseConnections in class BaseStepMeta
Returns:
an array of database connections meta-data. Return an empty array if no connections are used.

equals

public boolean equals(Object other)
Overrides:
equals in class Object

getSchemaName

public String getSchemaName()
Returns:
the schemaName

setSchemaName

public void setSchemaName(String schemaName)
Parameters:
schemaName - the schemaName to set

getLastUpdateField

public String getLastUpdateField()
Returns:
the lastUpdateField

setLastUpdateField

public void setLastUpdateField(String lastUpdateField)
Parameters:
lastUpdateField - the lastUpdateField to set

supportsErrorHandling

public boolean supportsErrorHandling()
Specified by:
supportsErrorHandling in interface StepMetaInterface
Overrides:
supportsErrorHandling in class BaseStepMeta
Returns:
true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.