DocumentMappingResult (Gene Mapping 1.0.1 API)

java.lang.Object
- de.julielab.jules.ae.genemapping.DocumentMappingResult

```
public class DocumentMappingResult
extends java.lang.Object
```
This class is thought to be used as an overall result when all gene mentions of a document are mapped in a single process. Until now, the GeneMapper does not do this but uses this class in preparation of possible future work.

Author:

faessler

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  long candidateRetrievalTime
  
  long disambiguationTime
  
  java.lang.String docId
  
  java.util.List<MentionMappingResult> mentionResults
- Constructor Summary
  
  Constructors
  Constructor Description
  
  DocumentMappingResult()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  java.util.List<SynHit> getAllSynHits()
  Returns the SynHits of all mention mapping results.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - docId
```
public java.lang.String docId
```
  - mentionResults
```
public java.util.List<MentionMappingResult> mentionResults
```
  - candidateRetrievalTime
```
public long candidateRetrievalTime
```
  - disambiguationTime
```
public long disambiguationTime
```
- Constructor Detail
  - DocumentMappingResult
```
public DocumentMappingResult()
```
- Method Detail
  - getAllSynHits
```
public java.util.List<SynHit> getAllSynHits()
```
    Returns the SynHits of all mention mapping results. Please note that this method is used at several places in a context where the DocumentMappingResult only contains the result of a single GeneMention. Thus, as soon as a real document-wide mapping has been implemented, the semantics of this method could be different at different places (single MentionMappingResults vs. MentionMappingResults of whole documents).
    
    Returns: