Package org.incenp.obofoundry.sssom.uriexpr

Class SSSOMTUriExpressionToExtFunction<T>

java.lang.Object
org.incenp.obofoundry.sssom.uriexpr.SSSOMTUriExpressionToExtFunction<T>
Type Parameters:
T - The type of objects produced by the application this function belongs to.
All Implemented Interfaces:
IMappingTransformer<Mapping>, ISSSOMTFunction<IMappingTransformer<Mapping>>
public class SSSOMTUriExpressionToExtFunction<T> extends Object implements ISSSOMTFunction<IMappingTransformer<Mapping>>, IMappingTransformer<Mapping>
Represents the SSSOM/T preprocessor function "uriexpr_toext".

That functions allows to store the components (slots) of a URI Expression into a mapping’s extension slots. It takes a single argument, which is the URI Expression to encode. Placeholders are expanded in that argument.

The value of each slot is stored into a SSSOM extension slot whose property name is formed by concatenating the name of the URI Expression schema and the name of the slot.

If the argument does not happen to contain a URI Expression, the original mapping is returned unmodified.

  • Constructor Details

    • SSSOMTUriExpressionToExtFunction

      public SSSOMTUriExpressionToExtFunction(SSSOMTransformApplication<T> application)
      Creates a new instance.
      Parameters:
      application - The application this function belongs to.

  • Method Details

    • getName

      public String getName()
      Description copied from interface: ISSSOMTFunction
      Gets the name of the function, by which it can be called in a SSSOM/T ruleset.
      Specified by:
      getName in interface ISSSOMTFunction<T>
      Returns:
      The function name.

    • getSignature

      public String getSignature()
      Description copied from interface: ISSSOMTFunction
      Gets the expected signature of the function. It should be a string that represents how many arguments (excluding keyed arguments) the function is expecting, where a single S character represents an argument.

      Regular expression syntax may be used to represent arguments that are optional or represent other kinds of constraints about the arguments list.

      Examples:

      • SSS for a function that expects exactly 3 arguments;
      • S+ for a function that expects at least one argument, possibly more;
      • (SS)+ for a function that one or more pairs of arguments (e.g. 2, 4, 6, but not 3 or 5).
      Specified by:
      getSignature in interface ISSSOMTFunction<T>
      Returns:
      The function signature.

    • call

      public IMappingTransformer<Mapping> call(List<String> arguments, Map<String,String> keyedArguments) throws SSSOMTransformError
      Description copied from interface: ISSSOMTFunction
      Executes the function.

      Before this method is called, the arguments list will have been checked against the signature and will be guaranteed to be correct (e.g. if the function declared to expects two arguments, it is guaranteed the arguments list will contains two items).

      Specified by:
      call in interface ISSSOMTFunction<T>
      Parameters:
      arguments - The arguments to the function. May be empty, but not null.
      keyedArguments - The keyed arguments to the function. May be empty, but null.
      Returns:
      The result of executing the function.
      Throws:
      SSSOMTransformError - If any error occurred when executing the function (which may include the case where the number of arguments was correct but their contents was not).

    • transform

      public Mapping transform(Mapping mapping)
      Description copied from interface: IMappingTransformer
      Transform a mapping into something else.
      Specified by:
      transform in interface IMappingTransformer<T>
      Parameters:
      mapping - The mapping to transform.
      Returns:
      The object generated from the mapping.