MappingValueExtractor (SSSOM-Java 1.11.2 API)

java.lang.Object
- org.incenp.obofoundry.sssom.extract.MappingValueExtractor

All Implemented Interfaces:

IValueExtractor

Direct Known Subclasses:

HashExtractor, MappingExtensionExtractor, MappingSlotExtractor, SExpressionExtractor
```
public abstract class MappingValueExtractor
extends Object
implements IValueExtractor
```
Base class for extractors that extract a value from a specific mapping record.
This is used by all expressions of the form mapping. or mapping(N)..

Field Summary

Fields
Modifier and Type Field Description

protected int mappingNo

Constructor Summary

Constructors
Modifier Constructor Description

protected MappingValueExtractor(int mappingNo)
Creates a new instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract Object`	`extract(Mapping mapping)`	Extracts the desired value from the given mapping.
`Object`	`extract(MappingSet ms)`	Extracts the desired value from the given mapping set.

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

Methods inherited from interface org.incenp.obofoundry.sssom.extract.IValueExtractor
getType

- Field Detail
  - mappingNo
```
protected int mappingNo
```
- Constructor Detail
  - MappingValueExtractor
```
protected MappingValueExtractor(int mappingNo)
```
    Creates a new instance.
    
    Parameters:
    
    mappingNo - If non-negative, the 0-based index of the mapping from which to extract a value. If negative, the 1-based index starting from the last mapping of the set.
- Method Detail
  - extract
```
public Object extract(MappingSet ms)
```
    Description copied from interface: IValueExtractor
    
    Extracts the desired value from the given mapping set.
    
    Specified by:
    
    extract in interface IValueExtractor
    
    Parameters:
    
    ms - The mapping set from which to extract the value.
    
    Returns:
    
    The desired value, or null if the set does not contain a value at the specified location.
  - extract
```
protected abstract Object extract(Mapping mapping)
```
    Extracts the desired value from the given mapping.
    
    Parameters:
    
    mapping - The mapping from which to extract the value.
    
    Returns:
    
    The desired value, or null if the mapping does not have a value at the specified location.