Package org.incenp.obofoundry.sssom.transform

Class SSSOMTHasExtensionFunction

java.lang.Object

org.incenp.obofoundry.sssom.transform.SSSOMTHasExtensionFunction

All Implemented Interfaces:

IMappingFilter, ISSSOMTFunction<IMappingFilter>

public class SSSOMTHasExtensionFunction
extends Object
implements ISSSOMTFunction<IMappingFilter>, IMappingFilter

Represents the SSSOM/T filter function "has_extension".

This function may be used to select mappings that have a particular extension property.

For example, to select mappings that have an extension associated with the property https://example.org/properties/fooProperty (assuming the prefix name PROP has been declared to correspond to the https://example.org/properties/ prefix):

 has_extension(PROP:fooProperty) -> ...;
 

Constructor Summary

Constructors

Constructor	Description
SSSOMTHasExtensionFunction()

Method Summary

Modifier and Type	Method	Description
IMappingFilter	call(List<String> arguments, Map<String,String> keyedArguments)	Executes the function.
boolean	filter(Mapping mapping)	Check if a mapping satisfies a given condition.
String	getName()	Gets the name of the function, by which it can be called in a SSSOM/T ruleset.
String	getSignature()	Gets the expected signature of the function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SSSOMTHasExtensionFunction

public SSSOMTHasExtensionFunction()

Method Detail

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<IMappingFilter>

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<IMappingFilter>

Returns:

The function signature.

call

public IMappingFilter 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<IMappingFilter>

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

filter

public boolean filter(Mapping mapping)

Description copied from interface: IMappingFilter

Check if a mapping satisfies a given condition.

Specified by:

filter in interface IMappingFilter

Parameters:

mapping - The mapping to test.

Returns:

true if the mapping satisfies the condition, false otherwise.