Class RegexAnnotator

  • All Implemented Interfaces:
    Serializable

    public class RegexAnnotator
    extends Annotator
    Annotator that constructs annotations based on regular expression matches. Matches are performed on word boundaries.
    Author:
    David B. Bracewell
    See Also:
    Serialized Form
    • Constructor Detail

      • RegexAnnotator

        public RegexAnnotator​(@NonNull
                              @NonNull String regex,
                              @NonNull
                              @NonNull AnnotationType providedType)
        Instantiates a new RegexAnnotator.
        Parameters:
        regex - the regular expression to match
        providedType - the annotation type to use for constructed annotations.
      • RegexAnnotator

        public RegexAnnotator​(@NonNull
                              @NonNull String regex,
                              @NonNull
                              @NonNull String providedType)
        Instantiates a new RegexAnnotator.
        Parameters:
        regex - the regular expression to match
        providedType - the annotation type to use for constructed annotations.
    • Method Detail

      • annotateImpl

        protected void annotateImpl​(@NonNull
                                    @NonNull 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
      • getProvider

        public String getProvider​(Language language)
        Description copied from class: Annotator
        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.
        Overrides:
        getProvider in class Annotator
        Returns:
        the provider
      • satisfies

        public Set<AnnotatableType> satisfies()
        Description copied from class: Annotator
        The set of annotation types that this annotator satisfies by this annotator
        Specified by:
        satisfies in class Annotator
        Returns:
        the set of satisfied annotation types