org.pentaho.di.trans.steps.replacestring

Class ReplaceStringMeta

java.lang.Object

org.pentaho.di.trans.step.BaseStepMeta

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

All Implemented Interfaces:

Cloneable, StepAttributesInterface, StepMetaInterface

public class ReplaceStringMeta
extends BaseStepMeta
implements StepMetaInterface

Field Summary

Fields

Modifier and Type	Field and Description
static int	CASE_SENSITIVE_NO
static int	CASE_SENSITIVE_YES
static String[]	caseSensitiveCode
static String[]	caseSensitiveDesc
static int	IS_UNICODE_NO
static int	IS_UNICODE_YES
static String[]	isUnicodeCode
static String[]	isUnicodeDesc
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

attributes, databases, log, loggingObject, parentStepMeta, repository, STEP_ATTRIBUTES_FILE

Constructor Summary

Constructors

Constructor and Description
ReplaceStringMeta()

Method Summary

Modifier and Type	Method and Description
void	afterInjectionSynchronization() If we use injection we can have different arrays lengths.
void	allocate(int nrkeys)
void	check(List<CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, 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.
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, Repository repository, org.pentaho.metastore.api.IMetaStore metaStore) Gets the fields.
static int	getIsUnicodeByDesc(String tt)
static String	getIsUnicodeDesc(int i)
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.
boolean[]	isSetEmptyString()
int[]	isUnicode()
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	setCaseSensitive(int[] caseSensitive)
void	setDefault() Set default values
void	setEmptyString(boolean[] setEmptyString)
void	setFieldInStream(String[] keyStream)
void	setFieldOutStream(String[] keyStream)
void	setFieldReplaceByString(String[] replaceFieldByString)
void	setIsUnicode(int[] isUnicode)
void	setReplaceByString(String[] replaceByString)
void	setReplaceString(String[] replaceString)
void	setUseRegEx(int[] useRegEx)
void	setWholeWord(int[] wholeWord)
boolean	supportsErrorHandling()

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

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

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

Field Detail

caseSensitiveCode

public static final String[] caseSensitiveCode

isUnicodeCode

public static final String[] isUnicodeCode

caseSensitiveDesc

public static final String[] caseSensitiveDesc

isUnicodeDesc

public static final String[] isUnicodeDesc

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

IS_UNICODE_NO

public static final int IS_UNICODE_NO

See Also:

Constant Field Values

IS_UNICODE_YES

public static final int IS_UNICODE_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:

keyStream - The fieldInStream to set.

getCaseSensitive

public int[] getCaseSensitive()

isUnicode

public int[] isUnicode()

getWholeWord

public int[] getWholeWord()

setWholeWord

public void setWholeWord(int[] wholeWord)

getUseRegEx

public int[] getUseRegEx()

setUseRegEx

public void setUseRegEx(int[] useRegEx)

isSetEmptyString

public boolean[] isSetEmptyString()

Returns:

the setEmptyString

setEmptyString

public void setEmptyString(boolean[] setEmptyString)

Parameters:

setEmptyString - the setEmptyString to set

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

setReplaceByString

public void setReplaceByString(String[] replaceByString)

getFieldReplaceByString

public String[] getFieldReplaceByString()

setFieldReplaceByString

public void setFieldReplaceByString(String[] replaceFieldByString)

setCaseSensitive

public void setCaseSensitive(int[] caseSensitive)

setIsUnicode

public void setIsUnicode(int[] isUnicode)

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 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,
                    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 inputRowMeta,
                      String name,
                      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:

inputRowMeta - the input row meta that is modified in this method to reflect the output row metadata of the step

name - 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 stepinfo,
                  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

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

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

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)

getIsUnicodeDesc

public static String getIsUnicodeDesc(int i)

getWholeWordDesc

public static String getWholeWordDesc(int i)

getUseRegExDesc

public static String getUseRegExDesc(int i)

getCaseSensitiveByDesc

public static int getCaseSensitiveByDesc(String tt)

getIsUnicodeByDesc

public static int getIsUnicodeByDesc(String tt)

getWholeWordByDesc

public static int getWholeWordByDesc(String tt)

getUseRegExByDesc

public static int getUseRegExByDesc(String tt)

afterInjectionSynchronization

public void afterInjectionSynchronization()

If we use injection we can have different arrays lengths. We need synchronize them for consistency behavior with UI