Class Annotator

    • Constructor Detail

      • Annotator

        public Annotator()
    • Method Detail

      • annotate

        public final void annotate​(@NonNull
                                   @NonNull Document document)
        Annotates a document with one or more AnnotatableType defined in satisfies().
        Parameters:
        document - The document to annotate
      • annotateImpl

        protected abstract void annotateImpl​(Document document)
        Annotates a document with one or more AnnotatableType defined in satisfies().
        Parameters:
        document - The document to annotate
      • getProvider

        public String getProvider​(Language language)
        Gets the provider information for this annotator.. The provider information should relate to a version number, model used, or something else to identify the settings of the annotator.
        Parameters:
        language -
        Returns:
        the provider
      • requires

        public Set<AnnotatableType> requires()
        The annotation types required to be on a document before this annotator can annotate
        Returns:
        the set of required annotation types
      • satisfies

        public abstract Set<AnnotatableType> satisfies()
        The set of annotation types that this annotator satisfies by this annotator
        Returns:
        the set of satisfied annotation types