Package org.incenp.obofoundry.sssom.owl

Class SSSOMTDirectFunction

java.lang.Object
org.incenp.obofoundry.sssom.owl.SSSOMTDirectFunction
All Implemented Interfaces:
ISSSOMTFunction<IMappingTransformer<org.semanticweb.owlapi.model.OWLAxiom>>
public class SSSOMTDirectFunction extends Object implements ISSSOMTFunction<IMappingTransformer<org.semanticweb.owlapi.model.OWLAxiom>>
Represents the SSSOM/T-OWL generator function "direct".

That function creates axioms that are the direct “OWL reification” of the mappings, as per the serialisation rules set forth in the SSSOM specification.

The function also accepts an optional /annots=... parameter; if present, it should be a list of SSSOM metadata fields that should be used to annotate the generated axiom. When that parameter is present, another parameter, /annots_uris=... can be used to specify how metadata fields should be rendered into annotation properties (allowed values: direct, standard_map; default is standard_map).

For backwards compatibility, the value of the /annots=... parameter may be given as a positional argument instead.

If no /annots=... parameter and no position argument are specified, the list defaults to metadata,-mapping_cardinality, indicating that all available metadata slots should be turned into annotations, except mapping_cardinality. To avoid generating any annotation at all, specify an explicitly empty list (/annots="").

See Also:

  • Constructor Details

  • 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<IMappingTransformer<org.semanticweb.owlapi.model.OWLAxiom>>
      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<IMappingTransformer<org.semanticweb.owlapi.model.OWLAxiom>>
      Returns:
      The function signature.

    • call

      public IMappingTransformer<org.semanticweb.owlapi.model.OWLAxiom> 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<IMappingTransformer<org.semanticweb.owlapi.model.OWLAxiom>>
      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).