org.pentaho.di.trans.steps.tableoutput
Class TableOutputMeta

java.lang.Object
  org.pentaho.di.trans.step.BaseStepMeta
      org.pentaho.di.trans.steps.tableoutput.TableOutputMeta

All Implemented Interfaces:

Cloneable, ProvidesDatabaseConnectionInformation, StepAttributesInterface, StepMetaInterface

Direct Known Subclasses:

InfobrightLoaderMeta, TableAgileMartMeta

public class TableOutputMeta
extends BaseStepMeta
implements StepMetaInterface, ProvidesDatabaseConnectionInformation

Table Output meta data.

Since:

2-jun-2003

Author:

Matt Casters

Field Summary

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

TableOutputMeta()

Method Summary

void	allocate(int nrRows)
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.
String	getCommitSize()
DatabaseMeta	getDatabaseMeta() Returns the database meta for this step
String[]	getFieldDatabase()
void	getFields(RowMetaInterface row, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space) Gets the fields.
String[]	getFieldStream()
String	getGeneratedKeyField()
String	getMissingDatabaseConnectionInformationMessage() Provides a way for this object to return a custom message when database connection information is incomplete or missing.
String	getPartitioningField()
RowMetaInterface	getRequiredFields(VariableSpace space) The natural way of data flow in a transformation is source-to-target.
String	getSchemaName() Returns the schema name for this step.
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.
SQLStatement	getSQLStatements(TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String tk, boolean use_autoinc, String pk)
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() Deprecated. Use getTableName()
String	getTableName() Returns the table name for this step
String	getTableNameField()
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	ignoreErrors()
boolean	isPartitioningDaily()
boolean	isPartitioningEnabled()
boolean	isPartitioningMonthly()
boolean	isReturningGeneratedKeys()
boolean	isTableNameInField()
boolean	isTableNameInTable()
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 commitSizeInt)
void	setCommitSize(String commitSize)
void	setDatabaseMeta(DatabaseMeta database)
void	setDefault() Set default values
void	setFieldDatabase(String[] fieldDatabase)
void	setFieldStream(String[] fieldStream)
void	setGeneratedKeyField(String generatedKeyField)
void	setIgnoreErrors(boolean ignoreErrors)
void	setPartitioningDaily(boolean partitioningDaily)
void	setPartitioningEnabled(boolean partitioningEnabled)
void	setPartitioningField(String partitioningField)
void	setPartitioningMonthly(boolean partitioningMontly)
void	setReturningGeneratedKeys(boolean returningGeneratedKeys)
void	setSchemaName(String schemaName)
void	setSpecifyFields(boolean specifyFields)
void	setTablename(String tablename) Deprecated. Use setTableName(String)
void	setTableName(String tableName) Assign the table name to write to.
void	setTableNameField(String tableNameField)
void	setTableNameInField(boolean tableNameInField)
void	setTableNameInTable(boolean tableNameInTable)
void	setTruncateTable(boolean truncateTable)
void	setUseBatchUpdate(boolean useBatchUpdate)
boolean	specifyFields()
boolean	supportsErrorHandling()
boolean	truncateTable()
boolean	useBatchUpdate()

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, 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

equals, 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, getResourceDependencies, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta

Constructor Detail

TableOutputMeta

public TableOutputMeta()

Method Detail

getGeneratedKeyField

public String getGeneratedKeyField()

Returns:

Returns the generatedKeyField.

setGeneratedKeyField

public void setGeneratedKeyField(String generatedKeyField)

Parameters:

generatedKeyField - The generatedKeyField to set.

isReturningGeneratedKeys

public boolean isReturningGeneratedKeys()

Returns:

Returns the returningGeneratedKeys.

setReturningGeneratedKeys

public void setReturningGeneratedKeys(boolean returningGeneratedKeys)

Parameters:

returningGeneratedKeys - The returningGeneratedKeys to set.

isTableNameInTable

public boolean isTableNameInTable()

Returns:

Returns the tableNameInTable.

setTableNameInTable

public void setTableNameInTable(boolean tableNameInTable)

Parameters:

tableNameInTable - The tableNameInTable to set.

getTableNameField

public String getTableNameField()

Returns:

Returns the tableNameField.

setTableNameField

public void setTableNameField(String tableNameField)

Parameters:

tableNameField - The tableNameField to set.

isTableNameInField

public boolean isTableNameInField()

Returns:

Returns the tableNameInField.

setTableNameInField

public void setTableNameInField(boolean tableNameInField)

Parameters:

tableNameInField - The tableNameInField to set.

isPartitioningDaily

public boolean isPartitioningDaily()

Returns:

Returns the partitioningDaily.

setPartitioningDaily

public void setPartitioningDaily(boolean partitioningDaily)

Parameters:

partitioningDaily - The partitioningDaily to set.

isPartitioningMonthly

public boolean isPartitioningMonthly()

Returns:

Returns the partitioningMontly.

setPartitioningMonthly

public void setPartitioningMonthly(boolean partitioningMontly)

Parameters:

partitioningMontly - The partitioningMontly to set.

isPartitioningEnabled

public boolean isPartitioningEnabled()

Returns:

Returns the partitioningEnabled.

setPartitioningEnabled

public void setPartitioningEnabled(boolean partitioningEnabled)

Parameters:

partitioningEnabled - The partitioningEnabled to set.

getPartitioningField

public String getPartitioningField()

Returns:

Returns the partitioningField.

setPartitioningField

public void setPartitioningField(String partitioningField)

Parameters:

partitioningField - The partitioningField to set.

allocate

public void allocate(int nrRows)

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

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

getDatabaseMeta

public DatabaseMeta getDatabaseMeta()

Description copied from interface: ProvidesDatabaseConnectionInformation

Returns the database meta for this step

Specified by:

getDatabaseMeta in interface ProvidesDatabaseConnectionInformation

Returns:

Returns the database.

setDatabaseMeta

public void setDatabaseMeta(DatabaseMeta database)

Parameters:

database - The database to set.

getCommitSize

public String getCommitSize()

Returns:

Returns the commitSize.

setCommitSize

public void setCommitSize(int commitSizeInt)

Parameters:

commitSize - The commitSize to set.

setCommitSize

public void setCommitSize(String commitSize)

Parameters:

commitSize - The commitSize to set.

getTableName

public String getTableName()

Description copied from interface: ProvidesDatabaseConnectionInformation

Returns the table name for this step

Specified by:

getTableName in interface ProvidesDatabaseConnectionInformation

Returns:

the table name

setTableName

public void setTableName(String tableName)

Assign the table name to write to.

Parameters:

tableName - The table name to set

getTablename

@Deprecated
public String getTablename()

Deprecated. Use getTableName()

Returns:

Returns the tablename.

setTablename

@Deprecated
public void setTablename(String tablename)

Deprecated. Use setTableName(String)

Parameters:

tablename - The tablename to set.

truncateTable

public boolean truncateTable()

Returns:

Returns the truncate table flag.

setTruncateTable

public void setTruncateTable(boolean truncateTable)

Parameters:

truncateTable - The truncate table flag to set.

setIgnoreErrors

public void setIgnoreErrors(boolean ignoreErrors)

Parameters:

ignoreErrors - The ignore errors flag to set.

ignoreErrors

public boolean ignoreErrors()

Returns:

Returns the ignore errors flag.

setSpecifyFields

public void setSpecifyFields(boolean specifyFields)

Parameters:

specifyFields - The specify fields flag to set.

specifyFields

public boolean specifyFields()

Returns:

Returns the specify fields flag.

setUseBatchUpdate

public void setUseBatchUpdate(boolean useBatchUpdate)

Parameters:

useBatchUpdate - The useBatchUpdate flag to set.

useBatchUpdate

public boolean useBatchUpdate()

Returns:

Returns the useBatchUpdate flag.

setDefault

public void setDefault()

Description copied from interface: StepMetaInterface

Set default values

Specified by:

setDefault in interface StepMetaInterface

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)

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

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

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

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.

getSQLStatements

public SQLStatement getSQLStatements(TransMeta transMeta,
                                     StepMeta stepMeta,
                                     RowMetaInterface prev,
                                     String tk,
                                     boolean use_autoinc,
                                     String pk)

getRequiredFields

public RowMetaInterface getRequiredFields(VariableSpace space)
                                   throws KettleException

Description copied from class: BaseStepMeta

The natural way of data flow in a transformation is source-to-target. However, this makes mapping to target tables difficult to do. To help out here, we supply information to the transformation meta-data model about which fields are required for a step. This allows us to automate certain tasks like the mapping to pre-defined tables. The Table Output step in this case will output the fields in the target table using this method. This default implementation returns an empty row meaning that no fields are required for this step to operate.

Specified by:

getRequiredFields in interface StepMetaInterface

Overrides:

getRequiredFields in class BaseStepMeta

Parameters:

space - the variable space to use to do variable substitution.

Returns:

the required fields for this steps meta data.

Throws:

KettleException - in case the required fields can't be determined

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.

getFieldStream

public String[] getFieldStream()

Returns:

Fields containing the values in the input stream to insert.

setFieldStream

public void setFieldStream(String[] fieldStream)

Parameters:

fieldStream - The fields containing the values in the input stream to insert in the table.

getFieldDatabase

public String[] getFieldDatabase()

Returns:

Fields containing the fieldnames in the database insert.

setFieldDatabase

public void setFieldDatabase(String[] fieldDatabase)

Parameters:

fieldDatabase - The fields containing the names of the fields to insert.

getSchemaName

public String getSchemaName()

Description copied from interface: ProvidesDatabaseConnectionInformation

Returns the schema name for this step.

Specified by:

getSchemaName in interface ProvidesDatabaseConnectionInformation

Returns:

the schemaName

setSchemaName

public void setSchemaName(String schemaName)

Parameters:

schemaName - the schemaName 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.

getMissingDatabaseConnectionInformationMessage

public String getMissingDatabaseConnectionInformationMessage()

Description copied from interface: ProvidesDatabaseConnectionInformation

Provides a way for this object to return a custom message when database connection information is incomplete or missing. If this returns null a default message will be displayed for missing information.

Specified by:

getMissingDatabaseConnectionInformationMessage in interface ProvidesDatabaseConnectionInformation

Returns:

A friendly message that describes that database connection information is missing and, potentially, why.