org.pentaho.di.trans.steps.pgbulkloader

Class PGBulkLoaderMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

org.pentaho.di.trans.steps.pgbulkloader.PGBulkLoaderMeta

All Implemented Interfaces:

Cloneable, ProvidesDatabaseConnectionInformation, StepAttributesInterface, StepMetaInjectionInterface, StepMetaInterface

public class PGBulkLoaderMeta
extends BaseStepMeta
implements StepMetaInjectionInterface, StepMetaInterface, ProvidesDatabaseConnectionInformation

Created on 20-feb-2007

Author:

Sven Boden (originally)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_INSERT
static String	ACTION_TRUNCATE
static String	DATE_MASK_DATE
static String	DATE_MASK_DATETIME
static String	DATE_MASK_PASS_THROUGH
static int	NR_DATE_MASK_DATE
static int	NR_DATE_MASK_DATETIME
static int	NR_DATE_MASK_PASS_THROUGH

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

loggingObject, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
PGBulkLoaderMeta()

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.
List<StepInjectionMetaEntry>	extractStepMetadataEntries() Extracts the step metadata in a standard fashion.
org.pentaho.di.core.database.DatabaseMeta	getDatabaseMeta() Returns the database meta for this step
String[]	getDateMask()
String	getDbNameOverride()
String	getDelimiter()
String	getEnclosure()
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	getMissingDatabaseConnectionInformationMessage() Provides a way for this object to return a custom message when database connection information is incomplete or missing.
String	getPsqlpath() Deprecated. doesn't follow naming standards - use getPsqlPath
String	getPsqlPath() Gets the PostgreSQL path
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.
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.
List<StepInjectionMetaEntry>	getStepInjectionMetadataEntries() Describe the metadata attributes that can be injected into this step metadata object.
StepMetaInjectionInterface	getStepMetaInjectionInterface()
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.
void	injectStepMetadataEntries(List<StepInjectionMetaEntry> metadata) Inject the metadata specified into the step metadata
boolean	isStopOnError()
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	setDatabaseMeta(org.pentaho.di.core.database.DatabaseMeta database)
void	setDateMask(String[] dateMask)
void	setDbNameOverride(String dbNameOverride)
void	setDefault() Set default values
void	setDelimiter(String delimiter)
void	setEnclosure(String enclosure)
void	setFieldStream(String[] fieldStream)
void	setFieldTable(String[] fieldTable)
void	setLoadAction(String action)
void	setPsqlpath(String PsqlPath) Deprecated. doesn't follow naming standards - use setPsqlPath
void	setPsqlPath(String PsqlPath) Sets the PostgreSQL path
void	setSchemaName(String schemaName)
void	setStopOnError(boolean value)
void	setStopOnError(Boolean value)
void	setTableName(String tableName)

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

analyseImpact, cancelQueries, check, check, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, exportResources, findAttribute, findParent, getActiveReferencedObjectDescription, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getReferencedObjectDescriptions, getRepCode, getRepositoryDirectory, getRequiredFields, getResourceDependencies, getSQLStatements, getStepInjectionMetadataEntries, getStepIOMeta, 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, getActiveReferencedObjectDescription, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getReferencedObjectDescriptions, getResourceDependencies, getSQLStatements, getStepIOMeta, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedLibraries, handleStreamSelection, hasChanged, hasRepositoryReferences, isReferencedObjectEnabled, loadReferencedObject, loadXML, lookupRepositoryReferences, readRep, resetStepIoMeta, saveRep, searchInfoAndTargetSteps, setChanged, setParentStepMeta, supportsErrorHandling

Field Detail

ACTION_INSERT

public static final String ACTION_INSERT

See Also:

Constant Field Values

ACTION_TRUNCATE

public static final String ACTION_TRUNCATE

See Also:

Constant Field Values

DATE_MASK_PASS_THROUGH

public static final String DATE_MASK_PASS_THROUGH

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

NR_DATE_MASK_PASS_THROUGH

public static final int NR_DATE_MASK_PASS_THROUGH

See Also:

Constant Field Values

NR_DATE_MASK_DATE

public static final int NR_DATE_MASK_DATE

See Also:

Constant Field Values

NR_DATE_MASK_DATETIME

public static final int NR_DATE_MASK_DATETIME

See Also:

Constant Field Values

Constructor Detail

PGBulkLoaderMeta

public PGBulkLoaderMeta()

Method Detail

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.

getPsqlpath

@Deprecated
public String getPsqlpath()

Deprecated. doesn't follow naming standards - use getPsqlPath

Returns:

PSQL Path

getPsqlPath

public String getPsqlPath()

Gets the PostgreSQL path

setPsqlpath

@Deprecated
public void setPsqlpath(String PsqlPath)

Deprecated. doesn't follow naming standards - use setPsqlPath

Parameters:

PSQL - Path

setPsqlPath

public void setPsqlPath(String PsqlPath)

Sets the PostgreSQL path

Parameters:

PsqlPath -

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.

getDateMask

public String[] getDateMask()

setDateMask

public void setDateMask(String[] dateMask)

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.

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

setLoadAction

public void setLoadAction(String action)

getLoadAction

public String getLoadAction()

getDelimiter

public String getDelimiter()

getEnclosure

public String getEnclosure()

getDbNameOverride

public String getDbNameOverride()

setDbNameOverride

public void setDbNameOverride(String dbNameOverride)

setDelimiter

public void setDelimiter(String delimiter)

setEnclosure

public void setEnclosure(String enclosure)

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.

isStopOnError

public boolean isStopOnError()

setStopOnError

public void setStopOnError(Boolean value)

setStopOnError

public void setStopOnError(boolean value)

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 org.pentaho.di.core.exception.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:

org.pentaho.di.core.exception.KettleException