Package org.incenp.obofoundry.sssom.transform

Class SSSOMTReplaceModifierFunction

java.lang.Object
org.incenp.obofoundry.sssom.transform.BaseStringModifierFunction
org.incenp.obofoundry.sssom.transform.SSSOMTReplaceModifierFunction
All Implemented Interfaces:
IFormatModifierFunction
public class SSSOMTReplaceModifierFunction extends BaseStringModifierFunction
Represents the SSSOM/T modifier function "replace".

Use this function to perform a basic find-and-replace operation within the substituted value. The function accepts two parameters, being the text to find and the replacement text, respectively.

For example, to get a shortened identifier for the predicate_id, but with the colon (:) character replaced by an underscore (_): 

 "%{predicate_id|short|replace(':', '_')}

  • Constructor Details

    • SSSOMTReplaceModifierFunction

      public SSSOMTReplaceModifierFunction()

  • Method Details

    • getName

      public String getName()
      Description copied from interface: IFormatModifierFunction
      Gets the name by which the function should be called in a placeholder.
      Returns:
      The function name.

    • getSignature

      public String getSignature()
      Description copied from interface: IFormatModifierFunction
      Gets the expected signature of the function. This works similarly to ISSSOMTFunction.getSignature(), but it only concerns the additional arguments beyond the value of the substituted placeholder to modify (e.g. extra_arg1 in the example above).
      Returns:
      The function signature.

    • apply

      protected String apply(Object value, List<String> extra)
      Description copied from class: BaseStringModifierFunction
      Applies the function to a single value.
      Specified by:
      apply in class BaseStringModifierFunction
      Parameters:
      value - The value to apply the function to.
      extra - Arguments to the function, if any.
      Returns:
      The modified value.