org.pentaho.di.trans.steps.orabulkloader

Class OraBulkLoaderMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.orabulkloader.OraBulkLoaderMeta

All Implemented Interfaces:

Cloneable, ProvidesDatabaseConnectionInformation, StepAttributesInterface, StepMetaInterface

public class OraBulkLoaderMeta
extends BaseStepMeta
implements StepMetaInterface, ProvidesDatabaseConnectionInformation

Created on 20-feb-2007

Author:

Sven Boden

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_APPEND
static String	ACTION_INSERT
static String	ACTION_REPLACE
static String	ACTION_TRUNCATE
static String	DATE_MASK_DATE
static String	DATE_MASK_DATETIME
static String	METHOD_AUTO_CONCURRENT
static String	METHOD_AUTO_END
static String	METHOD_MANUAL

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
OraBulkLoaderMeta()

Method Summary

Modifier and Type	Method and Description
void	allocate(int nrvalues)
void	analyseImpact(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Each step must be able to report on the impact it has on a database, table field, etc.
void	check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, String[] input, String[] output, org.pentaho.di.core.row.RowMetaInterface info, org.pentaho.di.core.variables.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.
String	getAltRecordTerm()
String	getBadFile()
String	getBindSize()
int	getBindSizeAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)
String	getCharacterSetName()
String	getCommitSize()
int	getCommitSizeAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)
String	getControlFile()
org.pentaho.di.core.database.DatabaseMeta	getDatabaseMeta() Returns the database meta for this step
String	getDataFile()
String[]	getDateMask()
String	getDbNameOverride()
String	getDelimiter()
String	getDiscardFile()
String	getEnclosure()
String	getEncoding()
void	getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta, String origin, org.pentaho.di.core.row.RowMetaInterface[] info, StepMeta nextStep, org.pentaho.di.core.variables.VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
String[]	getFieldStream()
String[]	getFieldTable()
String	getLoadAction()
String	getLoadMethod()
String	getLogFile()
String	getMaxErrors()
int	getMaxErrorsAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)
String	getMissingDatabaseConnectionInformationMessage() Provides a way for this object to return a custom message when database connection information is incomplete or missing.
String	getReadSize()
int	getReadSizeAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)
org.pentaho.di.core.row.RowMetaInterface	getRequiredFields(org.pentaho.di.core.variables.VariableSpace space) The natural way of data flow in a transformation is source-to-target.
String	getSchemaName() Returns the schema name for this step.
String	getSqlldr()
org.pentaho.di.core.SQLStatement	getSQLStatements(TransMeta transMeta, StepMeta stepMeta, org.pentaho.di.core.row.RowMetaInterface prev, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Standard method to return an SQLStatement object with SQL statements 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() Returns the table name for this step
org.pentaho.di.core.database.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	isDirectPath()
boolean	isEraseFiles()
boolean	isFailOnError()
boolean	isFailOnWarning()
boolean	isParallel()
void	loadXML(Node stepnode, List<org.pentaho.di.core.database.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, org.pentaho.di.repository.ObjectId id_step, List<org.pentaho.di.core.database.DatabaseMeta> databases) Read the steps information from a Kettle repository
void	saveRep(Repository rep, org.pentaho.metastore.api.IMetaStore metaStore, org.pentaho.di.repository.ObjectId id_transformation, org.pentaho.di.repository.ObjectId id_step) Save the steps data into a Kettle repository
void	setAltRecordTerm(String altRecordTerm)
void	setBadFile(String badFile)
void	setBindSize(String bindSize)
void	setCharacterSetName(String characterSetName)
void	setCommitSize(String commitSize)
void	setConnection(String connectionName)
void	setControlFile(String controlFile)
void	setDatabaseMeta(org.pentaho.di.core.database.DatabaseMeta database)
void	setDataFile(String dataFile)
void	setDateMask(String[] dateMask)
void	setDbNameOverride(String dbNameOverride)
void	setDefault() Set default values
void	setDirectPath(boolean directPath)
void	setDiscardFile(String discardFile)
void	setEncoding(String encoding)
void	setEraseFiles(boolean eraseFiles)
void	setFailOnError(boolean failOnError)
void	setFailOnWarning(boolean failOnWarning)
void	setFieldStream(String[] updateStream)
void	setFieldTable(String[] updateLookup)
void	setLoadAction(String action)
void	setLoadMethod(String method)
void	setLogFile(String logFile)
void	setMaxErrors(String maxErrors)
void	setParallel(boolean parallel)
void	setReadSize(String readSize)
void	setSchemaName(String schemaName)
void	setSqlldr(String sqlldr)
void	setTableName(String tableName)

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

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

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

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

Field Detail

ACTION_APPEND

public static final String ACTION_APPEND

See Also:

Constant Field Values

ACTION_INSERT

public static final String ACTION_INSERT

See Also:

Constant Field Values

ACTION_REPLACE

public static final String ACTION_REPLACE

See Also:

Constant Field Values

ACTION_TRUNCATE

public static final String ACTION_TRUNCATE

See Also:

Constant Field Values

METHOD_AUTO_CONCURRENT

public static final String METHOD_AUTO_CONCURRENT

See Also:

Constant Field Values

METHOD_AUTO_END

public static final String METHOD_AUTO_END

See Also:

Constant Field Values

METHOD_MANUAL

public static final String METHOD_MANUAL

See Also:

Constant Field Values

DATE_MASK_DATE

public static final String DATE_MASK_DATE

See Also:

Constant Field Values

DATE_MASK_DATETIME

public static final String DATE_MASK_DATETIME

See Also:

Constant Field Values

Constructor Detail

OraBulkLoaderMeta

public OraBulkLoaderMeta()

Method Detail

setConnection

public void setConnection(String connectionName)

getCommitSizeAsInt

public int getCommitSizeAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)

getCommitSize

public String getCommitSize()

Returns:

Returns the commitSize.

setCommitSize

public void setCommitSize(String commitSize)

Parameters:

commitSize - The commitSize to set.

getDatabaseMeta

public org.pentaho.di.core.database.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(org.pentaho.di.core.database.DatabaseMeta database)

Parameters:

database - The database 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:

Returns the tableName.

setTableName

public void setTableName(String tableName)

Parameters:

tableName - The tableName to set.

getSqlldr

public String getSqlldr()

setSqlldr

public void setSqlldr(String sqlldr)

getFieldTable

public String[] getFieldTable()

Returns:

Returns the fieldTable.

setFieldTable

public void setFieldTable(String[] updateLookup)

Parameters:

fieldTable - The fieldTable to set.

getFieldStream

public String[] getFieldStream()

Returns:

Returns the fieldStream.

setFieldStream

public void setFieldStream(String[] updateStream)

Parameters:

fieldStream - The fieldStream to set.

getDateMask

public String[] getDateMask()

setDateMask

public void setDateMask(String[] dateMask)

isFailOnWarning

public boolean isFailOnWarning()

setFailOnWarning

public void setFailOnWarning(boolean failOnWarning)

isFailOnError

public boolean isFailOnError()

setFailOnError

public void setFailOnError(boolean failOnError)

getCharacterSetName

public String getCharacterSetName()

setCharacterSetName

public void setCharacterSetName(String characterSetName)

getAltRecordTerm

public String getAltRecordTerm()

setAltRecordTerm

public void setAltRecordTerm(String altRecordTerm)

loadXML

public void loadXML(Node stepnode,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases,
                    org.pentaho.metastore.api.IMetaStore metaStore)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleXMLException - When an unexpected XML error occurred. (malformed etc.)

allocate

public void allocate(int nrvalues)

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

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,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_step,
                    List<org.pentaho.di.core.database.DatabaseMeta> databases)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

saveRep

public void saveRep(Repository rep,
                    org.pentaho.metastore.api.IMetaStore metaStore,
                    org.pentaho.di.repository.ObjectId id_transformation,
                    org.pentaho.di.repository.ObjectId id_step)
             throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException - When an unexpected error occurred (database, network, etc)

getFields

public void getFields(org.pentaho.di.core.row.RowMetaInterface rowMeta,
                      String origin,
                      org.pentaho.di.core.row.RowMetaInterface[] info,
                      StepMeta nextStep,
                      org.pentaho.di.core.variables.VariableSpace space,
                      Repository repository,
                      org.pentaho.metastore.api.IMetaStore metaStore)
               throws org.pentaho.di.core.exception.KettleStepException

Description copied from class: BaseStepMeta

Gets the fields.

Specified by:

getFields in interface StepMetaInterface

Overrides:

getFields in class BaseStepMeta

Parameters:

rowMeta - 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:

org.pentaho.di.core.exception.KettleStepException - the kettle step exception

check

public void check(List<org.pentaho.di.core.CheckResultInterface> remarks,
                  TransMeta transMeta,
                  StepMeta stepMeta,
                  org.pentaho.di.core.row.RowMetaInterface prev,
                  String[] input,
                  String[] output,
                  org.pentaho.di.core.row.RowMetaInterface info,
                  org.pentaho.di.core.variables.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

getSQLStatements

public org.pentaho.di.core.SQLStatement getSQLStatements(TransMeta transMeta,
                                                         StepMeta stepMeta,
                                                         org.pentaho.di.core.row.RowMetaInterface prev,
                                                         Repository repository,
                                                         org.pentaho.metastore.api.IMetaStore metaStore)
                                                  throws org.pentaho.di.core.exception.KettleStepException

Description copied from class: BaseStepMeta

Standard method to return an SQLStatement object with SQL statements 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)

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

Returns:

The SQL Statements for this step. If nothing has to be done, the SQLStatement.getSQL() == null. @see SQLStatement

Throws:

org.pentaho.di.core.exception.KettleStepException

analyseImpact

public void analyseImpact(List<DatabaseImpact> impact,
                          TransMeta transMeta,
                          StepMeta stepMeta,
                          org.pentaho.di.core.row.RowMetaInterface prev,
                          String[] input,
                          String[] output,
                          org.pentaho.di.core.row.RowMetaInterface info,
                          Repository repository,
                          org.pentaho.metastore.api.IMetaStore metaStore)
                   throws org.pentaho.di.core.exception.KettleStepException

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

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:

org.pentaho.di.core.exception.KettleStepException

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.

getUsedDatabaseConnections

public org.pentaho.di.core.database.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.

isDirectPath

public boolean isDirectPath()

Returns:

Do we want direct path loading.

setDirectPath

public void setDirectPath(boolean directPath)

Parameters:

directPath - do we want direct path

getRequiredFields

public org.pentaho.di.core.row.RowMetaInterface getRequiredFields(org.pentaho.di.core.variables.VariableSpace space)
                                                           throws org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException - in case the required fields can't be determined

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

getBadFile

public String getBadFile()

setBadFile

public void setBadFile(String badFile)

getControlFile

public String getControlFile()

setControlFile

public void setControlFile(String controlFile)

getDataFile

public String getDataFile()

setDataFile

public void setDataFile(String dataFile)

getDiscardFile

public String getDiscardFile()

setDiscardFile

public void setDiscardFile(String discardFile)

getLogFile

public String getLogFile()

setLogFile

public void setLogFile(String logFile)

setLoadAction

public void setLoadAction(String action)

getLoadAction

public String getLoadAction()

setLoadMethod

public void setLoadMethod(String method)

getLoadMethod

public String getLoadMethod()

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getDelimiter

public String getDelimiter()

getEnclosure

public String getEnclosure()

isEraseFiles

public boolean isEraseFiles()

setEraseFiles

public void setEraseFiles(boolean eraseFiles)

getBindSizeAsInt

public int getBindSizeAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)

getBindSize

public String getBindSize()

setBindSize

public void setBindSize(String bindSize)

getMaxErrorsAsInt

public int getMaxErrorsAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)

getMaxErrors

public String getMaxErrors()

setMaxErrors

public void setMaxErrors(String maxErrors)

getReadSizeAsInt

public int getReadSizeAsInt(org.pentaho.di.core.variables.VariableSpace varSpace)

getReadSize

public String getReadSize()

setReadSize

public void setReadSize(String readSize)

getDbNameOverride

public String getDbNameOverride()

setDbNameOverride

public void setDbNameOverride(String dbNameOverride)

isParallel

public boolean isParallel()

Returns:

the parallel

setParallel

public void setParallel(boolean parallel)

Parameters:

parallel - the parallel to set

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.