Package org.pentaho.di.trans.steps.stringoperations

Class StringOperationsMeta

java.lang.Object
org.pentaho.di.trans.step.BaseStepMeta
org.pentaho.di.trans.steps.stringoperations.StringOperationsMeta
All Implemented Interfaces:
Cloneable, StepAttributesInterface, StepMetaInterface
public class StringOperationsMeta extends BaseStepMeta implements StepMetaInterface
This class takes care of the meta data for the StringOperations step.
Since:
02 April 2009
Author:
Samatar Hassan

  • Field Details

    • trimTypeCode

      public static final String[] trimTypeCode
      The trim type codes

    • TRIM_NONE

      public static final int TRIM_NONE
      See Also:

    • TRIM_LEFT

      public static final int TRIM_LEFT
      See Also:

    • TRIM_RIGHT

      public static final int TRIM_RIGHT
      See Also:

    • TRIM_BOTH

      public static final int TRIM_BOTH
      See Also:

    • trimTypeDesc

      public static final String[] trimTypeDesc
      The trim description

    • lowerUpperCode

      public static final String[] lowerUpperCode
      The lower upper codes

    • LOWER_UPPER_NONE

      public static final int LOWER_UPPER_NONE
      See Also:

    • LOWER_UPPER_LOWER

      public static final int LOWER_UPPER_LOWER
      See Also:

    • LOWER_UPPER_UPPER

      public static final int LOWER_UPPER_UPPER
      See Also:

    • lowerUpperDesc

      public static final String[] lowerUpperDesc
      The lower upper description

    • initCapDesc

      public static final String[] initCapDesc

    • initCapCode

      public static final String[] initCapCode

    • INIT_CAP_NO

      public static final int INIT_CAP_NO
      See Also:

    • INIT_CAP_YES

      public static final int INIT_CAP_YES
      See Also:

    • digitsCode

      public static final String[] digitsCode

    • DIGITS_NONE

      public static final int DIGITS_NONE
      See Also:

    • DIGITS_ONLY

      public static final int DIGITS_ONLY
      See Also:

    • DIGITS_REMOVE

      public static final int DIGITS_REMOVE
      See Also:

    • digitsDesc

      public static final String[] digitsDesc

    • maskXMLDesc

      public static final String[] maskXMLDesc

    • maskXMLCode

      public static final String[] maskXMLCode

    • MASK_NONE

      public static final int MASK_NONE
      See Also:

    • MASK_ESCAPE_XML

      public static final int MASK_ESCAPE_XML
      See Also:

    • MASK_CDATA

      public static final int MASK_CDATA
      See Also:

    • MASK_UNESCAPE_XML

      public static final int MASK_UNESCAPE_XML
      See Also:

    • MASK_ESCAPE_SQL

      public static final int MASK_ESCAPE_SQL
      See Also:

    • MASK_ESCAPE_HTML

      public static final int MASK_ESCAPE_HTML
      See Also:

    • MASK_UNESCAPE_HTML

      public static final int MASK_UNESCAPE_HTML
      See Also:

    • removeSpecialCharactersCode

      public static final String[] removeSpecialCharactersCode

    • REMOVE_SPECIAL_CHARACTERS_NONE

      public static final int REMOVE_SPECIAL_CHARACTERS_NONE
      See Also:

    • REMOVE_SPECIAL_CHARACTERS_CR

      public static final int REMOVE_SPECIAL_CHARACTERS_CR
      See Also:

    • REMOVE_SPECIAL_CHARACTERS_LF

      public static final int REMOVE_SPECIAL_CHARACTERS_LF
      See Also:

    • REMOVE_SPECIAL_CHARACTERS_CRLF

      public static final int REMOVE_SPECIAL_CHARACTERS_CRLF
      See Also:

    • REMOVE_SPECIAL_CHARACTERS_TAB

      public static final int REMOVE_SPECIAL_CHARACTERS_TAB
      See Also:

    • REMOVE_SPECIAL_CHARACTERS_ESPACE

      public static final int REMOVE_SPECIAL_CHARACTERS_ESPACE
      See Also:

    • removeSpecialCharactersDesc

      public static final String[] removeSpecialCharactersDesc

    • paddingDesc

      public static final String[] paddingDesc
      The padding description

    • paddingCode

      public static final String[] paddingCode

    • PADDING_NONE

      public static final int PADDING_NONE
      See Also:

    • PADDING_LEFT

      public static final int PADDING_LEFT
      See Also:

    • PADDING_RIGHT

      public static final int PADDING_RIGHT
      See Also:

  • Constructor Details

    • StringOperationsMeta

      public StringOperationsMeta()

  • Method Details

    • getFieldInStream

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

    • setFieldInStream

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

    • getFieldOutStream

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

    • setFieldOutStream

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

    • getPadLen

      public String[] getPadLen()

    • setPadLen

      public void setPadLen(String[] value)

    • getPadChar

      public String[] getPadChar()

    • setPadChar

      public void setPadChar(String[] value)

    • getTrimType

      public String[] getTrimType()

    • setTrimType

      public void setTrimType(String[] trimType)

    • getLowerUpper

      public String[] getLowerUpper()

    • setLowerUpper

      public void setLowerUpper(String[] lowerUpper)

    • getInitCap

      public String[] getInitCap()

    • setInitCap

      public void setInitCap(String[] value)

    • getMaskXML

      public String[] getMaskXML()

    • setMaskXML

      public void setMaskXML(String[] value)

    • getDigits

      public String[] getDigits()

    • setDigits

      public void setDigits(String[] value)

    • getRemoveSpecialCharacters

      public String[] getRemoveSpecialCharacters()

    • setRemoveSpecialCharacters

      public void setRemoveSpecialCharacters(String[] value)

    • getPaddingType

      public String[] getPaddingType()

    • setPaddingType

      public void setPaddingType(String[] value)

    • 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 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, 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 inputRowMeta, String name, 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:
      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:
      org.pentaho.di.core.exception.KettleStepException - the kettle step exception

    • check

      public void check(List<org.pentaho.di.core.CheckResultInterface> remarks, TransMeta transMeta, StepMeta stepinfo, 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
      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.

    • getTrimTypeCode

      public static String getTrimTypeCode(int i)

    • getLowerUpperCode

      public static String getLowerUpperCode(int i)

    • getInitCapCode

      public static String getInitCapCode(int i)

    • getMaskXMLCode

      public static String getMaskXMLCode(int i)

    • getDigitsCode

      public static String getDigitsCode(int i)

    • getRemoveSpecialCharactersCode

      public static String getRemoveSpecialCharactersCode(int i)

    • getPaddingCode

      public static String getPaddingCode(int i)

    • getTrimTypeDesc

      public static String getTrimTypeDesc(int i)

    • getLowerUpperDesc

      public static String getLowerUpperDesc(int i)

    • getInitCapDesc

      public static String getInitCapDesc(int i)

    • getMaskXMLDesc

      public static String getMaskXMLDesc(int i)

    • getDigitsDesc

      public static String getDigitsDesc(int i)

    • getRemoveSpecialCharactersDesc

      public static String getRemoveSpecialCharactersDesc(int i)

    • getPaddingDesc

      public static String getPaddingDesc(int i)

    • getLowerUpperByCode

      public static int getLowerUpperByCode(String tt)

    • getTrimTypeByDesc

      public static int getTrimTypeByDesc(String tt)

    • getLowerUpperByDesc

      public static int getLowerUpperByDesc(String tt)

    • getInitCapByDesc

      public static int getInitCapByDesc(String tt)

    • getMaskXMLByDesc

      public static int getMaskXMLByDesc(String tt)

    • getDigitsByDesc

      public static int getDigitsByDesc(String tt)

    • getRemoveSpecialCharactersByDesc

      public static int getRemoveSpecialCharactersByDesc(String tt)

    • getPaddingByDesc

      public static int getPaddingByDesc(String tt)