Interface EntityResolver

  • All Known Implementing Classes:
    CasAnnotationViewer.DefaultEntityResolver

    public interface EntityResolver
    Pluggable interface that supports Entity View mode in the CasAnnotationViewer. Users implement this interface with logic that for their particular type system can determine which Entity an Annotation refers to.

    In the viewer, all annotations whose Entity objects are equal will be displayed in the same color, and the Entity's canonical form will be shown in the legend.

    • Method Detail

      • getEntity

        EntityResolver.Entity getEntity​(Annotation aAnnotation)
        Returns the Entity to which an annotation refers. Returns the canonical form String for an annotation.

        For two annotations that refer to the same Entity, this should return Entity objects that are equal.

        If the annotation does not represent an entity at all, null should be returned.

        Parameters:
        aAnnotation - the annotation to resolve
        Returns:
        the Entity to which the annotation refers, null if the annotation does not represent an