SentenceLevelAnnotator (com.gengoai:hermes 1.1-SNAPSHOT API)

java.lang.Object
- com.gengoai.hermes.annotator.Annotator
- - com.gengoai.hermes.annotator.SentenceLevelAnnotator

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DefaultDependencyAnnotator, DefaultPartOfSpeechAnnotator, DefaultPhraseChunkAnnotator, DefaultTokenTypeEntityAnnotator, LexiconAnnotator, ViterbiAnnotator
```
public abstract class SentenceLevelAnnotator
extends Annotator
```
Base for annotators that work at the sentence level.

Author:

David B. Bracewell

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

SentenceLevelAnnotator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`annotate(Annotation sentence)`	Annotates a single sentence.
`protected void`	`annotateImpl(Document document)`	Annotates a document with one or more AnnotatableType defined in `satisfies()`.
`protected Set<AnnotatableType>`	`furtherRequires()`	The annotation types beyond sentence and token that are also required.
`Set<AnnotatableType>`	`requires()`	The annotation types required to be on a document before this annotator can annotate

Methods inherited from class com.gengoai.hermes.annotator.Annotator
annotate, getProvider, satisfies

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

- Constructor Detail
  - SentenceLevelAnnotator
```
public SentenceLevelAnnotator()
```
- Method Detail
  - annotate
```
protected abstract void annotate(Annotation sentence)
```
    Annotates a single sentence.
    
    Parameters:
    
    sentence - The sentence to annotate
  - annotateImpl
```
protected final void annotateImpl(Document document)
```
    Description copied from class: Annotator
    
    Annotates a document with one or more AnnotatableType defined in satisfies().
    
    Specified by:
    
    annotateImpl in class Annotator
    
    Parameters:
    
    document - The document to annotate
  - furtherRequires
```
protected Set<AnnotatableType> furtherRequires()
```
    The annotation types beyond sentence and token that are also required. By default will return an empty Set.
    
    Returns:
    
    The annotations beyond sentence and token that are required for this annotator to perform annotation
  - requires
```
public final Set<AnnotatableType> requires()
```
    Description copied from class: Annotator
    
    The annotation types required to be on a document before this annotator can annotate
    
    Overrides:
    
    requires in class Annotator
    
    Returns:
    
    the set of required annotation types