org.pentaho.di.trans.steps.monetdbbulkloader

Class MonetDBBulkLoaderMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.monetdbbulkloader.MonetDBBulkLoaderMeta

All Implemented Interfaces:

Cloneable, ProvidesDatabaseConnectionInformation, StepAttributesInterface, StepMetaInjectionInterface, StepMetaInterface

Direct Known Subclasses:

MonetDBAgileMartMeta

public class MonetDBBulkLoaderMeta
extends BaseStepMeta
implements StepMetaInjectionInterface, StepMetaInterface, ProvidesDatabaseConnectionInformation

Created on 20-feb-2007

Author:

Sven Boden

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
MonetDBBulkLoaderMeta()

Method Summary

Modifier and Type	Method and Description
void	allocate(int nrvalues)
void	analyseImpact(List<DatabaseImpact> impact, TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev, String[] input, String[] output, 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<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.
List<StepInjectionMetaEntry>	extractStepMetadataEntries() Extracts the step metadata in a standard fashion.
String	getBufferSize()
DatabaseMeta	getDatabaseMeta() Returns the database meta for this step
DatabaseMeta	getDatabaseMeta(MonetDBBulkLoader loader)
String	getDbConnectionName()
String	getEncoding()
String	getFieldEnclosure()
boolean[]	getFieldFormatOk()
void	getFields(RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
String	getFieldSeparator()
String[]	getFieldStream()
String[]	getFieldTable()
String	getLogFile()
String	getMissingDatabaseConnectionInformationMessage() Provides a way for this object to return a custom message when database connection information is incomplete or missing.
String	getNULLrepresentation()
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, boolean autoSchema, MonetDBBulkLoaderData data, boolean safeMode)
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.
List<StepInjectionMetaEntry>	getStepInjectionMetadataEntries() Describe the metadata attributes that can be injected into this step metadata object.
StepMetaInjectionInterface	getStepMetaInjectionInterface()
SQLStatement	getTableDdl(TransMeta transMeta, String stepname, boolean autoSchema, MonetDBBulkLoaderData data, boolean safeMode)
String	getTableName() Returns the table name for this step
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.
void	injectStepMetadataEntries(List<StepInjectionMetaEntry> metadata) Inject the metadata specified into the step metadata
boolean	isAutoSchema()
boolean	isAutoStringWidths()
boolean	isCompatibilityDbVersionMode() Returns true if used the version of MonetBD Jan2014-SP2 or later, false otherwise.
boolean	isFullyQuoteSQL()
boolean	isTruncate()
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	setAutoSchema(boolean autoSchema)
void	setAutoStringWidths(boolean autoStringWidths)
void	setBufferSize(String bufferSize)
void	setCompatibilityDbVersionMode() Defines and sets true if it is used the version of MonetBD Jan2014-SP2 or later, false otherwise.
void	setDatabaseMeta(DatabaseMeta database)
void	setDbConnectionName(String dbConnectionName)
void	setDefault() Set default values
void	setEncoding(String encoding)
void	setFieldEnclosure(String fieldEnclosureStr)
void	setFieldFormatOk(boolean[] fieldFormatOk)
void	setFieldSeparator(String fieldSeparatorStr)
void	setFieldStream(String[] fieldStream)
void	setFieldTable(String[] fieldTable)
void	setFullyQuoteSQL(boolean fullyQuoteSQLbool)
void	setLogFile(String logFile)
void	setNULLrepresentation(String NULLrepresentationStr)
void	setSchemaName(String schemaName)
void	setTableName(String tableName)
void	setTruncate(boolean truncate)
RowMetaInterface	updateFields(RowMetaInterface prev, MonetDBBulkLoaderData data)
RowMetaInterface	updateFields(TransMeta transMeta, String stepname, MonetDBBulkLoaderData data)

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

analyseImpact, cancelQueries, check, check, createEntry, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, findAttribute, findParent, findParentEntry, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getResourceDependencies, getSQLStatements, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, 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, supportsErrorHandling

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, cancelQueries, check, cleanAfterHopFromRemove, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getResourceDependencies, getSQLStatements, getSQLStatements, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, passDataToServletOutput, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta, supportsErrorHandling

Constructor Detail

MonetDBBulkLoaderMeta

public MonetDBBulkLoaderMeta()

Method Detail

isAutoStringWidths

public boolean isAutoStringWidths()

setAutoStringWidths

public void setAutoStringWidths(boolean autoStringWidths)

isTruncate

public boolean isTruncate()

setTruncate

public void setTruncate(boolean truncate)

isFullyQuoteSQL

public boolean isFullyQuoteSQL()

setFullyQuoteSQL

public void setFullyQuoteSQL(boolean fullyQuoteSQLbool)

isAutoSchema

public boolean isAutoSchema()

setAutoSchema

public void setAutoSchema(boolean autoSchema)

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.

getDatabaseMeta

public DatabaseMeta getDatabaseMeta(MonetDBBulkLoader loader)

Returns:

Returns the database.

setDatabaseMeta

public void setDatabaseMeta(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.

getFieldTable

public String[] getFieldTable()

Returns:

Returns the fieldTable.

setFieldTable

public void setFieldTable(String[] fieldTable)

Parameters:

fieldTable - The fieldTable to set.

getFieldStream

public String[] getFieldStream()

Returns:

Returns the fieldStream.

setFieldStream

public void setFieldStream(String[] fieldStream)

Parameters:

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

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

getFields

public void getFields(RowMetaInterface rowMeta,
                      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:

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:

KettleStepException - the kettle step exception

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

getTableDdl

public SQLStatement getTableDdl(TransMeta transMeta,
                                String stepname,
                                boolean autoSchema,
                                MonetDBBulkLoaderData data,
                                boolean safeMode)
                         throws KettleException

Throws:

KettleException

updateFields

public RowMetaInterface updateFields(TransMeta transMeta,
                                     String stepname,
                                     MonetDBBulkLoaderData data)
                              throws KettleStepException

Throws:

KettleStepException

updateFields

public RowMetaInterface updateFields(RowMetaInterface prev,
                                     MonetDBBulkLoaderData data)

getSQLStatements

public SQLStatement getSQLStatements(TransMeta transMeta,
                                     StepMeta stepMeta,
                                     RowMetaInterface prev,
                                     boolean autoSchema,
                                     MonetDBBulkLoaderData data,
                                     boolean safeMode)
                              throws KettleStepException

Throws:

KettleStepException

analyseImpact

public void analyseImpact(List<DatabaseImpact> impact,
                          TransMeta transMeta,
                          StepMeta stepMeta,
                          RowMetaInterface prev,
                          String[] input,
                          String[] output,
                          RowMetaInterface info,
                          Repository repository,
                          org.pentaho.metastore.api.IMetaStore metaStore)
                   throws 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:

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

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

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

getLogFile

public String getLogFile()

setLogFile

public void setLogFile(String logFile)

getFieldSeparator

public String getFieldSeparator()

setFieldSeparator

public void setFieldSeparator(String fieldSeparatorStr)

getFieldEnclosure

public String getFieldEnclosure()

setFieldEnclosure

public void setFieldEnclosure(String fieldEnclosureStr)

getNULLrepresentation

public String getNULLrepresentation()

setNULLrepresentation

public void setNULLrepresentation(String NULLrepresentationStr)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getBufferSize

public String getBufferSize()

Returns:

the bufferSize

setBufferSize

public void setBufferSize(String bufferSize)

Parameters:

bufferSize - the bufferSize to set

getFieldFormatOk

public boolean[] getFieldFormatOk()

Returns:

the fieldFormatOk

setFieldFormatOk

public void setFieldFormatOk(boolean[] fieldFormatOk)

Parameters:

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

setDbConnectionName

public void setDbConnectionName(String dbConnectionName)

Parameters:

database - connection name to set

getDbConnectionName

public String getDbConnectionName()

Returns:

the database connection name

getStepMetaInjectionInterface

public StepMetaInjectionInterface getStepMetaInjectionInterface()

Specified by:

getStepMetaInjectionInterface in interface StepMetaInterface

Overrides:

getStepMetaInjectionInterface in class BaseStepMeta

Returns:

Optional interface that allows an external program to inject step metadata in a standardized fasion. This method will return null if the interface is not available for this step.

getStepInjectionMetadataEntries

public List<StepInjectionMetaEntry> getStepInjectionMetadataEntries()

Describe the metadata attributes that can be injected into this step metadata object.

Specified by:

getStepInjectionMetadataEntries in interface StepMetaInjectionInterface

Returns:

A list of step injection metadata entries. In case the data type of the entry is NONE (0) you will get at least one entry in the details section. You can use this list to see a description of all the metadata.

injectStepMetadataEntries

public void injectStepMetadataEntries(List<StepInjectionMetaEntry> metadata)

Description copied from interface: StepMetaInjectionInterface

Inject the metadata specified into the step metadata

Specified by:

injectStepMetadataEntries in interface StepMetaInjectionInterface

Parameters:

metadata - the metadata to inject.

extractStepMetadataEntries

public List<StepInjectionMetaEntry> extractStepMetadataEntries()
                                                        throws KettleException

Description copied from interface: StepMetaInjectionInterface

Extracts the step metadata in a standard fashion. Enables unit testing more easily by extracting the step metadata and then doing the re-injection into an empty step.

Specified by:

extractStepMetadataEntries in interface StepMetaInjectionInterface

Specified by:

extractStepMetadataEntries in interface StepMetaInterface

Overrides:

extractStepMetadataEntries in class BaseStepMeta

Returns:

The step metadata itself, not the metadata description. For lists it will have 0 entries in case there are no entries.

Throws:

KettleException

isCompatibilityDbVersionMode

public boolean isCompatibilityDbVersionMode()

Returns true if used the version of MonetBD Jan2014-SP2 or later, false otherwise.

Returns:

the compatibilityDbVersionMode

setCompatibilityDbVersionMode

public void setCompatibilityDbVersionMode()

Defines and sets true if it is used the version of MonetBD Jan2014-SP2 or later, false otherwise. Sets also false if it's impossible to define which version of db is used.