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

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.monetdbbulkloader.MonetDBBulkLoaderMeta
All Implemented Interfaces:
Cloneable, ProvidesDatabaseConnectionInformation, StepAttributesInterface, StepMetaInterface
Direct Known Subclasses:
MonetDBAgileMartMeta

public class MonetDBBulkLoaderMeta
extends BaseStepMeta
implements StepMetaInterface, ProvidesDatabaseConnectionInformation

Created on 20-feb-2007

Author:
Sven Boden

Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
MonetDBBulkLoaderMeta()
           
 
Method Summary
 void allocate(int nrvalues)
           
 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 getBufferSize()
           
 DatabaseMeta getDatabaseMeta()
          Returns the database meta for this step
 DatabaseMeta getDatabaseMeta(MonetDBBulkLoader loader)
           
 String getDbConnectionName()
           
 String getDelimiter()
           
 String getEnclosure()
           
 String getEncoding()
           
 boolean[] getFieldFormatOk()
           
 void getFields(RowMetaInterface rowMeta, String origin, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String[] getFieldStream()
           
 String[] getFieldTable()
           
 String getLogFile()
           
 String getMClientPath()
           
 String getMissingDatabaseConnectionInformationMessage()
          Provides a way for this object to return a custom message when database connection information is incomplete or missing.
 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.
 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.
 boolean isAutoSchema()
           
 boolean isAutoStringWidths()
           
 boolean isTruncate()
           
 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 setAutoSchema(boolean autoSchema)
           
 void setAutoStringWidths(boolean autoStringWidths)
           
 void setBufferSize(String bufferSize)
           
 void setDatabaseMeta(DatabaseMeta database)
           
 void setDbConnectionName(String dbConnectionName)
           
 void setDefault()
          Set default values
 void setEncoding(String encoding)
           
 void setFieldFormatOk(boolean[] fieldFormatOk)
           
 void setFieldStream(String[] fieldStream)
           
 void setFieldTable(String[] fieldTable)
           
 void setLogFile(String logFile)
           
 void setMClientPath(String clientPath)
           
 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
cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getResourceDependencies, getSQLStatements, 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, 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
cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getOptionalStreams, getParentStepMeta, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, 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)

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

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

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getDelimiter

public String getDelimiter()

getEnclosure

public String getEnclosure()

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

setMClientPath

public void setMClientPath(String clientPath)
Parameters:
clientPath - the mClientPath to set

getMClientPath

public String getMClientPath()
Returns:
the mClientPath

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