Package org.incenp.obofoundry.sssom.transform

Class BaseStringModifierFunction

java.lang.Object
org.incenp.obofoundry.sssom.transform.BaseStringModifierFunction
All Implemented Interfaces:
IFormatModifierFunction
Direct Known Subclasses:
SimpleStringModifierFunction, SSSOMTFormatFunction, SSSOMTPrefixFunction, SSSOMTReplaceModifierFunction, SSSOMTShortFunction, SSSOMTSuffixFunction
public abstract class BaseStringModifierFunction extends Object implements IFormatModifierFunction
Base class for format modifier functions that can act both on a single value and on a list of values, where all values in the list are to be processed in the same way as single values.

  • Constructor Details

    • BaseStringModifierFunction

      public BaseStringModifierFunction()

  • Method Details

    • call

      public Object call(Object value, List<String> extra)
      Description copied from interface: IFormatModifierFunction
      Executes the function.
      Specified by:
      call in interface IFormatModifierFunction
      Parameters:
      value - The original value this function is supposed to modify. It is guaranteed never to be null, but the exact type will depend on what the substituted placeholder was, and also on what any previous modifier function may have done with it.
      extra - Additional arguments to the function, if any. If the function declared that it expects some mandatory arguments (through the IFormatModifierFunction.getSignature() method), it is guaranteed the list will contains as many arguments as expected.
      Returns:
      The modified value. It may not need be of the same type as the original value (e.g., a function could transform a list value into a string value).

    • apply

      protected abstract String apply(Object value, List<String> extra)
      Applies the function to a single value.
      Parameters:
      value - The value to apply the function to.
      extra - Arguments to the function, if any.
      Returns:
      The modified value.