org.pentaho.di.trans.steps.replacestring
Class ReplaceStringMeta

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

public class ReplaceStringMeta
extends BaseStepMeta
implements StepMetaInterface


Field Summary
static int CASE_SENSITIVE_NO
           
static int CASE_SENSITIVE_YES
           
static String[] caseSensitiveCode
           
static String[] caseSensitiveDesc
           
static int USE_REGEX_NO
           
static int USE_REGEX_YES
           
static String[] useRegExCode
           
static String[] useRegExDesc
           
static int WHOLE_WORD_NO
           
static int WHOLE_WORD_YES
           
static String[] wholeWordCode
           
static String[] wholeWordDesc
           
 
Fields inherited from class org.pentaho.di.trans.step.BaseStepMeta
loggingObject, STEP_ATTRIBUTES_FILE
 
Constructor Summary
ReplaceStringMeta()
           
 
Method Summary
 void allocate(int nrkeys)
           
 void check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, 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.
 int[] getCaseSensitive()
           
static int getCaseSensitiveByDesc(String tt)
           
static String getCaseSensitiveDesc(int i)
           
 String[] getFieldInStream()
           
 String[] getFieldOutStream()
           
 String[] getFieldReplaceByString()
           
 void getFields(RowMetaInterface inputRowMeta, String name, RowMetaInterface[] info, StepMeta nextStep, VariableSpace space)
          Gets the fields.
 String[] getReplaceByString()
           
 String[] getReplaceString()
           
 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.
 int[] getUseRegEx()
           
static int getUseRegExByDesc(String tt)
           
static String getUseRegExDesc(int i)
           
 int[] getWholeWord()
           
static int getWholeWordByDesc(String tt)
           
static String getWholeWordDesc(int i)
           
 String getXML()
          Produces the XML string that describes this step's information.
 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 setCaseSensitive(int[] caseSensitive)
           
 void setDefault()
          Set default values
 void setFieldInStream(String[] keyStream)
           
 void setFieldOutStream(String[] keyStream)
           
 void setReplaceString(String[] replaceString)
           
 boolean supportsErrorHandling()
           
 
Methods inherited from class org.pentaho.di.trans.step.BaseStepMeta
analyseImpact, cancelQueries, excludeFromCopyDistributeVerification, excludeFromRowLayoutVerification, exportResources, findAttribute, findParent, getDescription, getDialogClassName, getLog, getLogChannelId, getName, getObjectCopy, getObjectId, getObjectRevision, getObjectType, getOptionalStreams, getParent, getParentStepMeta, getRepCode, getRepositoryDirectory, getRequiredFields, getRequiredFields, getResourceDependencies, getSQLStatements, 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
 
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, getOptionalStreams, getParentStepMeta, getRequiredFields, getResourceDependencies, getSQLStatements, getStepIOMeta, getStepMetaInjectionInterface, getSupportedTransformationTypes, getTableFields, getUsedArguments, getUsedDatabaseConnections, getUsedLibraries, handleStreamSelection, hasRepositoryReferences, lookupRepositoryReferences, resetStepIoMeta, searchInfoAndTargetSteps, setParentStepMeta
 

Field Detail

caseSensitiveCode

public static final String[] caseSensitiveCode

caseSensitiveDesc

public static final String[] caseSensitiveDesc

CASE_SENSITIVE_NO

public static final int CASE_SENSITIVE_NO
See Also:
Constant Field Values

CASE_SENSITIVE_YES

public static final int CASE_SENSITIVE_YES
See Also:
Constant Field Values

wholeWordDesc

public static final String[] wholeWordDesc

wholeWordCode

public static final String[] wholeWordCode

WHOLE_WORD_NO

public static final int WHOLE_WORD_NO
See Also:
Constant Field Values

WHOLE_WORD_YES

public static final int WHOLE_WORD_YES
See Also:
Constant Field Values

useRegExDesc

public static final String[] useRegExDesc

useRegExCode

public static final String[] useRegExCode

USE_REGEX_NO

public static final int USE_REGEX_NO
See Also:
Constant Field Values

USE_REGEX_YES

public static final int USE_REGEX_YES
See Also:
Constant Field Values
Constructor Detail

ReplaceStringMeta

public ReplaceStringMeta()
Method Detail

getFieldInStream

public String[] getFieldInStream()
Returns:
Returns the fieldInStream.

setFieldInStream

public void setFieldInStream(String[] keyStream)
Parameters:
fieldInStream - The fieldInStream to set.

getCaseSensitive

public int[] getCaseSensitive()

getWholeWord

public int[] getWholeWord()

getUseRegEx

public int[] getUseRegEx()

getFieldOutStream

public String[] getFieldOutStream()
Returns:
Returns the fieldOutStream.

setFieldOutStream

public void setFieldOutStream(String[] keyStream)
Parameters:
keyStream - The fieldOutStream to set.

getReplaceString

public String[] getReplaceString()

setReplaceString

public void setReplaceString(String[] replaceString)

getReplaceByString

public String[] getReplaceByString()

getFieldReplaceByString

public String[] getFieldReplaceByString()

setCaseSensitive

public void setCaseSensitive(int[] caseSensitive)

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

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 inputRowMeta,
                      String name,
                      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:
inputRowMeta - the input row meta
name - 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 stepinfo,
                  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
stepinfo - 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

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.

supportsErrorHandling

public boolean supportsErrorHandling()
Specified by:
supportsErrorHandling in interface StepMetaInterface
Overrides:
supportsErrorHandling in class BaseStepMeta
Returns:
true if this step supports error "reporting" on rows: the ability to send rows to a certain target step.

getCaseSensitiveDesc

public static String getCaseSensitiveDesc(int i)

getWholeWordDesc

public static String getWholeWordDesc(int i)

getUseRegExDesc

public static String getUseRegExDesc(int i)

getCaseSensitiveByDesc

public static int getCaseSensitiveByDesc(String tt)

getWholeWordByDesc

public static int getWholeWordByDesc(String tt)

getUseRegExByDesc

public static int getUseRegExByDesc(String tt)