org.pentaho.di.trans.steps.tablecompare

Class TableCompareMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.tablecompare.TableCompareMeta

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class TableCompareMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta

attributes, databases, ioMeta, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
TableCompareMeta()

Method Summary

Modifier and Type	Method and Description
void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, RowMetaInterface info, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) 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.
DatabaseMeta	getCompareConnection()
String	getCompareSchemaField()
String	getCompareTableField()
String	getExcludeFieldsField()
void	getFields(RowMetaInterface inputRowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
String	getKeyDescriptionField()
String	getKeyFieldsField()
String	getNrErrorsField()
String	getNrErrorsInnerJoinField()
String	getNrErrorsLeftJoinField()
String	getNrErrorsRightJoinField()
String	getNrRecordsCompareField()
String	getNrRecordsReferenceField()
DatabaseMeta	getReferenceConnection()
String	getReferenceSchemaField()
String	getReferenceTableField()
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.
DatabaseMeta[]	getUsedDatabaseConnections() This method returns all the database connections that are used by the step.
String	getValueCompareField()
String	getValueReferenceField()
String	getXML() Produces the XML string that describes this step's information.
void	loadXML(Node stepnode, List<DatabaseMeta> databases, org.pentaho.metastore.api.IMetaStore metaStore) Load the values for this step from an XML Node
void	readRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_step, List<DatabaseMeta> databases) Read the steps information from a Kettle repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, ObjectId id_transformation, ObjectId id_step) Save the steps data into a Kettle repository
void	setCompareConnection(DatabaseMeta compareConnection)
void	setCompareSchemaField(String compareSchemaField)
void	setCompareTableField(String compareTableField)
void	setDefault() Set default values
void	setExcludeFieldsField(String excludeFieldsField)
void	setKeyDescriptionField(String keyDescriptionField)
void	setKeyFieldsField(String keyFieldsField)
void	setNrErrorsField(String nrErrorsField)
void	setNrErrorsInnerJoinField(String nrErrorsInnerJoinField)
void	setNrErrorsLeftJoinField(String nrErrorsLeftJoinField)
void	setNrErrorsRightJoinField(String nrErrorsRightJoinField)
void	setNrRecordsCompareField(String nrRecordsCompareField)
void	setNrRecordsReferenceField(String nrRecordsReferenceField)
void	setReferenceConnection(DatabaseMeta referenceConnection)
void	setReferenceSchemaField(String referenceSchemaField)
void	setReferenceTableField(String referenceTableField)
void	setValueCompareField(String valueCompareField)
void	setValueReferenceField(String valueReferenceField)
boolean	supportsErrorHandling()

Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta

analyseImpact, analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedLibraries, getXmlCode, handleStreamSelection, hasChanged, hasRepositoryReferences, isBasic, isDebug, isDetailed, isReferencedObjectEnabled, isRowLevel, loadReferencedObject, loadReferencedObject, loadStepAttributes, loadXML, loadXML, logBasic, logBasic, logDebug, logDebug, logDetailed, logDetailed, logError, logError, logError, logMinimal, logMinimal, logRowlevel, logRowlevel, lookupRepositoryReferences, readRep, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setChanged, setParentStepMeta

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pentaho.di.trans.step.StepMetaInterface

analyseImpact, analyseImpact, cancelQueries, check, cleanAfterHopFromRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, extractStepMetadataEntries, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta

Constructor Detail

TableCompareMeta

public TableCompareMeta()

Method Detail

getReferenceSchemaField

public String getReferenceSchemaField()

Returns:

the referenceSchemaField

setReferenceSchemaField

public void setReferenceSchemaField(String referenceSchemaField)

Parameters:

referenceSchemaField - the referenceSchemaField to set

getReferenceTableField

public String getReferenceTableField()

Returns:

the referenceTableField

setReferenceTableField

public void setReferenceTableField(String referenceTableField)

Parameters:

referenceTableField - the referenceTableField to set

getCompareSchemaField

public String getCompareSchemaField()

Returns:

the compareSchemaField

setCompareSchemaField

public void setCompareSchemaField(String compareSchemaField)

Parameters:

compareSchemaField - the compareSchemaField to set

getCompareTableField

public String getCompareTableField()

Returns:

the compareTableField

setCompareTableField

public void setCompareTableField(String compareTableField)

Parameters:

compareTableField - the compareTableField to set

getNrErrorsField

public String getNrErrorsField()

Returns:

the nrErrorsField

setNrErrorsField

public void setNrErrorsField(String nrErrorsField)

Parameters:

nrErrorsField - the nrErrorsField to set

getReferenceConnection

public DatabaseMeta getReferenceConnection()

Returns:

the referenceConnection

setReferenceConnection

public void setReferenceConnection(DatabaseMeta referenceConnection)

Parameters:

referenceConnection - the referenceConnection to set

getCompareConnection

public DatabaseMeta getCompareConnection()

Returns:

the compareConnection

setCompareConnection

public void setCompareConnection(DatabaseMeta compareConnection)

Parameters:

compareConnection - the compareConnection to set

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.

getKeyFieldsField

public String getKeyFieldsField()

Returns:

the keyFieldsField

setKeyFieldsField

public void setKeyFieldsField(String keyFieldsField)

Parameters:

keyFieldsField - the keyFieldsField to set

getExcludeFieldsField

public String getExcludeFieldsField()

Returns:

the excludeFieldsField

setExcludeFieldsField

public void setExcludeFieldsField(String excludeFieldsField)

Parameters:

excludeFieldsField - the excludeFieldsField to set

getNrRecordsReferenceField

public String getNrRecordsReferenceField()

Returns:

the nrRecordsReferenceField

setNrRecordsReferenceField

public void setNrRecordsReferenceField(String nrRecordsReferenceField)

Parameters:

nrRecordsReferenceField - the nrRecordsReferenceField to set

getNrRecordsCompareField

public String getNrRecordsCompareField()

Returns:

the nrRecordsCompareField

setNrRecordsCompareField

public void setNrRecordsCompareField(String nrRecordsCompareField)

Parameters:

nrRecordsCompareField - the nrRecordsCompareField to set

getNrErrorsLeftJoinField

public String getNrErrorsLeftJoinField()

Returns:

the nrErrorsLeftJoinField

setNrErrorsLeftJoinField

public void setNrErrorsLeftJoinField(String nrErrorsLeftJoinField)

Parameters:

nrErrorsLeftJoinField - the nrErrorsLeftJoinField to set

getNrErrorsInnerJoinField

public String getNrErrorsInnerJoinField()

Returns:

the nrErrorsInnerJoinField

setNrErrorsInnerJoinField

public void setNrErrorsInnerJoinField(String nrErrorsInnerJoinField)

Parameters:

nrErrorsInnerJoinField - the nrErrorsInnerJoinField to set

getNrErrorsRightJoinField

public String getNrErrorsRightJoinField()

Returns:

the nrErrorsRightJoinField

setNrErrorsRightJoinField

public void setNrErrorsRightJoinField(String nrErrorsRightJoinField)

Parameters:

nrErrorsRightJoinField - the nrErrorsRightJoinField to set

getKeyDescriptionField

public String getKeyDescriptionField()

Returns:

the keyDescriptionField

setKeyDescriptionField

public void setKeyDescriptionField(String keyDescriptionField)

Parameters:

keyDescriptionField - the keyDescriptionField to set

getValueReferenceField

public String getValueReferenceField()

Returns:

the valueReferenceField

setValueReferenceField

public void setValueReferenceField(String valueReferenceField)

Parameters:

valueReferenceField - the valueReferenceField to set

getValueCompareField

public String getValueCompareField()

Returns:

the valueCompareField

setValueCompareField

public void setValueCompareField(String valueCompareField)

Parameters:

valueCompareField - the valueCompareField to set

loadXML

public void loadXML(Node stepnode,
                    List<DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws KettleXMLException

Description copied from interface: StepMetaInterface

Load the values for this step from an XML Node

Specified by:

loadXML in interface StepMetaInterface

Overrides:

loadXML in class BaseStepMeta

Parameters:

stepnode - the Node to get the info from

databases - The available list of databases to reference to

metaStore - the metastore to optionally load external reference metadata from

Throws:

KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

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

getFields

public void getFields(RowMetaInterface inputRowMeta,
                      String origin,
                      RowMetaInterface[] info,
                      StepMeta nextStep,
                      VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws KettleStepException

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

inputRowMeta - the input row meta that is modified in this method to reflect the output row metadata of the step

origin - Name of the step to use as input for the origin field in the values

info - Fields used as extra lookup information

nextStep - the next step that is targeted

space - the space The variable space to use to replace variables

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

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.

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

readRep

public void readRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    ObjectId id_step,
                    List<DatabaseMeta> databases)
             throws KettleException

Description copied from interface: StepMetaInterface

Read the steps information from a Kettle repository

Specified by:

readRep in interface StepMetaInterface

Overrides:

readRep in class BaseStepMeta

Parameters:

rep - The repository to read from

metaStore - The MetaStore to read external information from

id_step - The step ID

databases - The databases to reference

Throws:

KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    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

Overrides:

saveRep in class BaseStepMeta

Parameters:

rep - The Kettle repository to save to

metaStore - the metaStore to optionally write 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,
                  VariableSpace space,
                  Repository repository,
                  org.pentaho.metastore.api.IMetaStore metaStore)

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

Overrides:

check in class BaseStepMeta

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

space - the variable space to resolve variable expressions with

repository - the repository to use to load Kettle metadata objects impacting the output fields

metaStore - the MetaStore to use to load additional external data or metadata impacting the output fields

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta tr,
                             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

tr - 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.

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.