Package org.incenp.obofoundry.sssom.owl

Class SSSOMTDeclareFunction

java.lang.Object
org.incenp.obofoundry.sssom.owl.SSSOMTDeclareFunction
All Implemented Interfaces:
ISSSOMTFunction<Void>
public class SSSOMTDeclareFunction extends Object implements ISSSOMTFunction<Void>
Represents the SSSOM/T-OWL "declare" function.

This function may be used to make sure that some entities are known to the SSSOM/T-OWL application, before they can be used in create_axiom.

It expects an arbitrary number of arguments, each argument being the IRI of an entity to declare. By default, entities are declared as OWL classes. To declare entities of another type, use the /type= parameter.

For example, to declare an object property: 

 declare(BFO:0000066, /type="object_property");

All types of entities can be declared (class, which is the default, object_property, data_property, individual, datatype, and annotation_property. Only class and object_property are expected to be useful, though.

  • Constructor Details

    • SSSOMTDeclareFunction

      public SSSOMTDeclareFunction(SSSOMTOwlApplication application)
      Creates a new instance.
      Parameters:
      application - The SSSOM/T-OWL application object.

  • 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<Void>
      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<Void>
      Returns:
      The function signature.

    • call

      public Void 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<Void>
      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).