CompositePatternResolver (Gene ID Mapper 2.5.0 API)

java.lang.Object
- de.julielab.genemapper.composites.CompositePatternResolver

Direct Known Subclasses:

EmbeddedAcronymPatternResolver, EnumerationResolver, NumberElipseEnumerationPatternResolver, PatternResolutionChain, SlashDashAlternativePatternResolver, TwoPartedRangePatternResolver
```
public abstract class CompositePatternResolver
extends Object
```
This is the base class for composite gene name resolution classes.

For each composite type there is a subclass handling the respective cases.

Constructor Summary

Constructors
Constructor Description

CompositePatternResolver()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getName()`
`abstract String`	`isEligible(String geneName)`	Checks the gene name for eligibility with regards to the original gene name string.
`abstract String`	`matches(String tagging)`	Requires the completed composite tagging via `FlairCompositeMentionTagger` and returns `true` if the respective subclass handles the given case.
`abstract List<ResolvedCompositeGeneName>`	`resolve(String originalMention, org.apache.commons.lang3.tuple.Pair<List<CompositeToken>,String> tokenizedMentionAndTagging)`

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

- Constructor Detail
  - CompositePatternResolver
```
public CompositePatternResolver()
```
- Method Detail
  - getName
```
public String getName()
```
  - isEligible
```
public abstract String isEligible(String geneName)
```
    Checks the gene name for eligibility with regards to the original gene name string.
    
    This step should return true in doubt but false when it is clear that the given mention cannot be a composite handled by the respective subclass. This is done to reduce unnecessary composite tagging time.
    
    Parameters:
    
    geneName - The original gene name string.
    
    Returns:
    
    true if this mention should tagged for composite tokens or false otherwise.
  - matches
```
public abstract String matches(String tagging)
```
    Requires the completed composite tagging via FlairCompositeMentionTagger and returns true if the respective subclass handles the given case.
    
    Parameters:
    
    tagging - The gene name composite tagging result.
    
    Returns:
    
    Whether or not the given tagging is handled.
  - resolve
```
public abstract List<ResolvedCompositeGeneName> resolve(String originalMention,
                                                        org.apache.commons.lang3.tuple.Pair<List<CompositeToken>,String> tokenizedMentionAndTagging)
```