Package com.tibco.patterns.grouping

## Interface IStringKeyMapping

- All Known Implementing Classes:
    `StringIntegerKeyMapping`, `StringKeyMapping`

      public interface IStringKeyMapping

  Implement this interface when the incoming keys are strings.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `java.lang.String` | `backmapInternalKey​(int internal_key)` | Looks up the original external key.
    `int` | `mapExternalKey​(java.lang.String external_key)` | If the external key has been encountered previously, the previously generated internal key is returned.
    `void` | `releaseForwardMap()` | Releases memory storage related to generating internal keys. After calling `releaseForwardMap()`, calls to `mapExternalKey()` will throw an exception.

- - ### Method Detail

    - #### mapExternalKey

          int mapExternalKey​(java.lang.String external_key)
                      throws GroupingException

      If the external key has been encountered previously, the previously generated internal key is returned. Otherwise, a new internal key is generated, stored, and returned.
      Parameters:
        `external_key` - An external key.
      Returns:
        the internal key associated to the external key.
      Throws:
        `GroupingException` - if an error occurred.

    - #### backmapInternalKey

          java.lang.String backmapInternalKey​(int internal_key)

      Looks up the original external key.
      Parameters:
        `internal_key` - An internal key.
      Returns:
        the external key associated to the internal key.

    - #### releaseForwardMap

          void releaseForwardMap()

      Releases memory storage related to generating internal keys.
      After calling `releaseForwardMap()`, calls to `mapExternalKey()` will throw an exception.