SSSOMTPrefixFunction (SSSOM-Java 1.11.2 API)

java.lang.Object
- org.incenp.obofoundry.sssom.transform.BaseStringModifierFunction
- - org.incenp.obofoundry.sssom.transform.SSSOMTPrefixFunction

All Implemented Interfaces:

IFormatModifierFunction
```
public class SSSOMTPrefixFunction
extends BaseStringModifierFunction
```
Represents the SSSOM/T modifier function "prefix".
This function replaces the substituted text, which is expected to be a IRI, by the prefix part of its short form. It does not take any additional argument.

Constructor Summary

Constructors
Constructor Description

SSSOMTPrefixFunction(PrefixManager prefixManager)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`apply(Object value, List<String> extra)`	Applies the function to a single value.
`String`	`getName()`	Gets the name by which the function should be called in a placeholder.
`String`	`getSignature()`	Gets the expected signature of the function.

Methods inherited from class org.incenp.obofoundry.sssom.transform.BaseStringModifierFunction
call

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SSSOMTPrefixFunction
```
public SSSOMTPrefixFunction(PrefixManager prefixManager)
```
    Creates a new instance.
    
    Parameters:
    
    prefixManager - The prefix manager to use to find the prefix name of the IRI in the substituted text.
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: IFormatModifierFunction
    
    Gets the name by which the function should be called in a placeholder.
    
    Returns:
    
    The function name.
  - getSignature
```
public String getSignature()
```
    Description copied from interface: IFormatModifierFunction
    
    Gets the expected signature of the function. This works similarly to ISSSOMTFunction.getSignature(), but it only concerns the additional arguments beyond the value of the substituted placeholder to modify (e.g. extra_arg1 in the example above).
    
    Returns:
    
    The function signature.
  - apply
```
protected String apply(Object value,
                       List<String> extra)
```
    Description copied from class: BaseStringModifierFunction
    
    Applies the function to a single value.
    
    Specified by:
    
    apply in class BaseStringModifierFunction
    
    Parameters:
    
    value - The value to apply the function to.
    
    extra - Arguments to the function, if any.
    
    Returns:
    
    The modified value.