com.davidbracewell.hermes.annotator

Class SubTypeAnnotator

java.lang.Object

com.davidbracewell.hermes.annotator.SubTypeAnnotator

All Implemented Interfaces:

Annotator, Serializable

Direct Known Subclasses:

EntityAnnotator

public class SubTypeAnnotator
extends Object
implements Annotator, Serializable

The type Sub type annotator.

Author:

David B. Bracewell

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubTypeAnnotator(AnnotationType annotationType, boolean nonOverlapping, Collection<AnnotationType> subTypes) Instantiates a new Sub type annotator.
SubTypeAnnotator(AnnotationType annotationType, Collection<AnnotationType> subTypes) Instantiates a new Sub type annotator.

Method Summary

Modifier and Type	Method and Description
void	annotate(Document document) Annotates a document with one or more annotations of the types defined in provided().
Set<AnnotatableType>	satisfies() The set of annotation types that this annotator satisfies by this annotator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.davidbracewell.hermes.annotator.Annotator

getVersion, requires

Constructor Detail

SubTypeAnnotator

public SubTypeAnnotator(@NonNull
                        AnnotationType annotationType,
                        boolean nonOverlapping,
                        @NonNull
                        Collection<AnnotationType> subTypes)

Instantiates a new Sub type annotator.

Parameters:

annotationType - the annotation type

nonOverlapping - the non overlapping

subTypes - the sub types

Throws:

IllegalArgumentException - - If one or more of the sub types is not an instance of annotationType

SubTypeAnnotator

public SubTypeAnnotator(@NonNull
                        AnnotationType annotationType,
                        @NonNull
                        Collection<AnnotationType> subTypes)

Instantiates a new Sub type annotator.

Parameters:

annotationType - the annotation type

subTypes - the sub types

Method Detail

annotate

public void annotate(Document document)

Description copied from interface: Annotator

Annotates a document with one or more annotations of the types defined in provided().

Specified by:

annotate in interface Annotator

Parameters:

document - The document to annotate

satisfies

public Set<AnnotatableType> satisfies()

Description copied from interface: Annotator

The set of annotation types that this annotator satisfies by this annotator

Specified by:

satisfies in interface Annotator

Returns:

the set of satisfied annotation types