org.pentaho.di.trans.steps.ivwloader
Class IngresVectorwiseLoaderMeta

java.lang.Object
  extended by org.pentaho.di.trans.step.BaseStepMeta
      extended by org.pentaho.di.trans.steps.ivwloader.IngresVectorwiseLoaderMeta
All Implemented Interfaces:
Cloneable, ProvidesDatabaseConnectionInformation, StepAttributesInterface, StepMetaInterface

public class IngresVectorwiseLoaderMeta
extends BaseStepMeta
implements StepMetaInterface, ProvidesDatabaseConnectionInformation

Metadata for the VectorWise bulk loader.


Field Summary
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
IngresVectorwiseLoaderMeta()
          Default constructor.
 
Method Summary
 void allocate(int nrRows)
           
 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
 String getDelimiter()
           
 String getEncoding()
           
 String getErrorFileName()
           
 String[] getFieldDatabase()
           
 String[] getFieldFormat()
           
 String[] getFieldStream()
           
 String getFifoFileName()
           
 String getMaxNrErrors()
           
 String getMissingDatabaseConnectionInformationMessage()
          Provides a way for this object to return a custom message when database connection information is incomplete or missing.
 String getSchemaName()
          Returns the schema name for this step.
 String getSqlPath()
           
 SQLStatement getSQLStatements(TransMeta transMeta, StepMeta stepMeta, RowMetaInterface prev)
          Standard method to return one or more SQLStatement objects that the step needs in order to work correctly.
 StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int cnr, TransMeta tr, 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
 String getXML()
          Produces the XML string that describes this step's information.
 boolean isContinueOnError()
           
 boolean isEscapingSpecialCharacters()
           
 boolean isRejectErrors()
           
 boolean isTruncatingTable()
           
 boolean isUseAuthentication()
           
 boolean isUseDynamicVNode()
           
 boolean isUseSSV()
           
 boolean isUseStandardConversion()
           
 boolean isUsingVwload()
           
 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 setBufferSize(String bufferSize)
           
 void setContinueOnError(boolean continueOnError)
           
 void setDatabaseMeta(DatabaseMeta databaseMeta)
           
 void setDefault()
          Set default values
 void setDelimiter(String delimiter)
           
 void setEncoding(String encoding)
           
 void setErrorFileName(String errorFileName)
           
 void setEscapingSpecialCharacters(boolean escapingSpecialCharacters)
           
 void setFieldDatabase(String[] fieldDatabase)
           
 void setFieldFormat(String[] fieldFormat)
           
 void setFieldStream(String[] fieldStream)
           
 void setFifoFileName(String fifoFileName)
           
 void setMaxNrErrors(String maxNrErrors)
           
 void setRejectErrors(boolean rejectErrors)
           
 void setSqlPath(String sqlPath)
           
 void setTablename(String tablename)
           
 void setTruncatingTable(boolean truncatingTable)
           
 void setUseAuthentication(boolean useAuthentication)
           
 void setUseDynamicVNode(boolean createDynamicVNode)
           
 void setUseSSV(boolean useSSV)
           
 void setUseStandardConversion(boolean useStandardConversion)
           
 void setUsingVwload(boolean usingVwload)
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getFields, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getStepInjectionMetadataEntries, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getTooltip, getUsedArguments, getUsedDatabaseConnections, 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
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, getDialogClassName, getFields, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta, supportsErrorHandling
 

Constructor Detail

IngresVectorwiseLoaderMeta

public IngresVectorwiseLoaderMeta()
Default constructor.

Method Detail

getStep

public StepInterface getStep(StepMeta stepMeta,
                             StepDataInterface stepDataInterface,
                             int cnr,
                             TransMeta tr,
                             Trans trans)
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
tr - The transformation info
trans - The launching transformation
See Also:
StepMetaInterface.getStep(org.pentaho.di.trans.step.StepMeta, org.pentaho.di.trans.step.StepDataInterface, int, org.pentaho.di.trans.TransMeta, org.pentaho.di.trans.Trans)

getStepData

public StepDataInterface getStepData()
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.
See Also:
StepMetaInterface.getStepData()

clone

public Object clone()
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
See Also:
BaseStepMeta.clone()

setDefault

public void setDefault()
Description copied from interface: StepMetaInterface
Set default values

Specified by:
setDefault in interface StepMetaInterface

isRejectErrors

public boolean isRejectErrors()
Returns:
the rejectErrors

setRejectErrors

public void setRejectErrors(boolean rejectErrors)
Parameters:
rejectErrors - the rejectErrors to set.

allocate

public void allocate(int nrRows)

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

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.

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

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)

getDatabaseMeta

public DatabaseMeta getDatabaseMeta()
Description copied from interface: ProvidesDatabaseConnectionInformation
Returns the database meta for this step

Specified by:
getDatabaseMeta in interface ProvidesDatabaseConnectionInformation
Returns:
the databaseMeta

setDatabaseMeta

public void setDatabaseMeta(DatabaseMeta databaseMeta)
Parameters:
databaseMeta - the databaseMeta to set

getTableName

public String getTableName()
Description copied from interface: ProvidesDatabaseConnectionInformation
Returns the table name for this step

Specified by:
getTableName in interface ProvidesDatabaseConnectionInformation
Returns:
the tablename

setTablename

public void setTablename(String tablename)
Parameters:
tablename - the tablename to set

getFieldStream

public String[] getFieldStream()
Returns:
the fieldStream

setFieldStream

public void setFieldStream(String[] fieldStream)
Parameters:
fieldStream - the fieldStream to set

getFieldDatabase

public String[] getFieldDatabase()
Returns:
the fieldDatabase

setFieldDatabase

public void setFieldDatabase(String[] fieldDatabase)
Parameters:
fieldDatabase - the fieldDatabase to set

getFieldFormat

public String[] getFieldFormat()
Returns:
the fieldFormat

setFieldFormat

public void setFieldFormat(String[] fieldFormat)
Parameters:
fieldFormat - the fieldFormat to set

getSQLStatements

public SQLStatement getSQLStatements(TransMeta transMeta,
                                     StepMeta stepMeta,
                                     RowMetaInterface prev)
Description copied from class: BaseStepMeta
Standard method to return one or more SQLStatement objects that the step needs in order to work correctly. This can mean "create table", "create index" statements but also "alter table ... add/drop/modify" statements.

Specified by:
getSQLStatements in interface StepMetaInterface
Overrides:
getSQLStatements in class BaseStepMeta
Parameters:
transMeta - TransInfo object containing the complete transformation
stepMeta - StepMeta object containing the complete step
prev - Row containing meta-data for the input fields (no data)
Returns:
The SQL Statements for this step or null if an error occurred. If nothing has to be done, the SQLStatement.getSQL() == null.

getFifoFileName

public String getFifoFileName()
Returns:
the fifoFileName

setFifoFileName

public void setFifoFileName(String fifoFileName)
Parameters:
fifoFileName - the fifoFileName to set

getSqlPath

public String getSqlPath()
Returns:
the sqlPath

setSqlPath

public void setSqlPath(String sqlPath)
Parameters:
sqlPath - the sqlPath to set

getEncoding

public String getEncoding()
Returns:
the encoding

setEncoding

public void setEncoding(String encoding)
Parameters:
encoding - the encoding to set

getDelimiter

public String getDelimiter()
Returns:
the delimiter

setDelimiter

public void setDelimiter(String delimiter)
Parameters:
delimiter - the delimiter to set

getErrorFileName

public String getErrorFileName()

setErrorFileName

public void setErrorFileName(String errorFileName)

isContinueOnError

public boolean isContinueOnError()

setContinueOnError

public void setContinueOnError(boolean continueOnError)

isUseStandardConversion

public boolean isUseStandardConversion()

setUseStandardConversion

public void setUseStandardConversion(boolean useStandardConversion)

isUseDynamicVNode

public boolean isUseDynamicVNode()

setUseDynamicVNode

public void setUseDynamicVNode(boolean createDynamicVNode)

isUseSSV

public boolean isUseSSV()

setUseSSV

public void setUseSSV(boolean useSSV)

isEscapingSpecialCharacters

public boolean isEscapingSpecialCharacters()
Returns:
the escapingSpecialCharacters

setEscapingSpecialCharacters

public void setEscapingSpecialCharacters(boolean escapingSpecialCharacters)
Parameters:
escapingSpecialCharacters - the escapingSpecialCharacters to set

getBufferSize

public String getBufferSize()
Returns:
the bufferSize

setBufferSize

public void setBufferSize(String bufferSize)
Parameters:
bufferSize - the bufferSize to set

isUseAuthentication

public boolean isUseAuthentication()
Returns:
the useAuthentication

setUseAuthentication

public void setUseAuthentication(boolean useAuthentication)
Parameters:
useAuthentication - the useAuthentication to set

isUsingVwload

public boolean isUsingVwload()

setUsingVwload

public void setUsingVwload(boolean usingVwload)

isTruncatingTable

public boolean isTruncatingTable()

setTruncatingTable

public void setTruncatingTable(boolean truncatingTable)

getMaxNrErrors

public String getMaxNrErrors()

setMaxNrErrors

public void setMaxNrErrors(String maxNrErrors)

getSchemaName

public String getSchemaName()
Description copied from interface: ProvidesDatabaseConnectionInformation
Returns the schema name for this step.

Specified by:
getSchemaName in interface ProvidesDatabaseConnectionInformation
Returns:

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.