Examples with VSpan de.tudarmstadt.ukp.clarin.webanno.api.annotation.rendering.model.VSpan used on opensource projects

Example 1 with VSpan

use of de.tudarmstadt.ukp.clarin.webanno.api.annotation.rendering.model.VSpan in project webanno by webanno.

the class ChainRenderer method render.

@Override
public void render(JCas aJcas, List<AnnotationFeature> aFeatures, VDocument aResponse, AnnotatorState aState) {
    List<AnnotationFeature> visibleFeatures = aFeatures.stream().filter(f -> f.isVisible() && f.isEnabled()).collect(Collectors.toList());
    // Find the features for the arc and span labels - it is possible that we do not find a
    // feature for arc/span labels because they may have been disabled.
    AnnotationFeature spanLabelFeature = null;
    AnnotationFeature arcLabelFeature = null;
    for (AnnotationFeature f : visibleFeatures) {
        if (WebAnnoConst.COREFERENCE_TYPE_FEATURE.equals(f.getName())) {
            spanLabelFeature = f;
        }
        if (WebAnnoConst.COREFERENCE_RELATION_FEATURE.equals(f.getName())) {
            arcLabelFeature = f;
        }
    }
    // At this point arc and span feature labels must have been found! If not, the later code
    // will crash.
    ChainAdapter typeAdapter = getTypeAdapter();
    Type chainType = typeAdapter.getAnnotationType(aJcas.getCas());
    Feature chainFirst = chainType.getFeatureByBaseName(typeAdapter.getChainFirstFeatureName());
    int colorIndex = 0;
    // Iterate over the chains
    for (FeatureStructure chainFs : selectFS(aJcas.getCas(), chainType)) {
        AnnotationFS linkFs = (AnnotationFS) chainFs.getFeatureValue(chainFirst);
        AnnotationFS prevLinkFs = null;
        // Iterate over the links of the chain
        while (linkFs != null) {
            Feature linkNext = linkFs.getType().getFeatureByBaseName(typeAdapter.getLinkNextFeatureName());
            AnnotationFS nextLinkFs = (AnnotationFS) linkFs.getFeatureValue(linkNext);
            // Is link after window? If yes, we can skip the rest of the chain
            if (linkFs.getBegin() >= aState.getWindowEndOffset()) {
                // Go to next chain
                break;
            }
            // end within the window
            if (!(linkFs.getBegin() >= aState.getWindowBeginOffset()) && (linkFs.getEnd() <= aState.getWindowEndOffset())) {
                // prevLinkFs remains null until we enter the window
                linkFs = nextLinkFs;
                // Go to next link
                continue;
            }
            String bratTypeName = TypeUtil.getUiTypeName(typeAdapter);
            // Render span
            {
                String bratLabelText = TypeUtil.getUiLabelText(typeAdapter, linkFs, (spanLabelFeature != null) ? asList(spanLabelFeature) : emptyList());
                String bratHoverText = TypeUtil.getUiHoverText(typeAdapter, linkFs, (spanLabelFeature != null) ? asList(spanLabelFeature) : emptyList());
                VRange offsets = new VRange(linkFs.getBegin() - aState.getWindowBeginOffset(), linkFs.getEnd() - aState.getWindowBeginOffset());
                aResponse.add(new VSpan(typeAdapter.getLayer(), linkFs, bratTypeName, offsets, colorIndex, singletonMap("label", bratLabelText), singletonMap("label", bratHoverText)));
            }
            // and last link are within the window ;)
            if (prevLinkFs != null) {
                String bratLabelText = null;
                if (typeAdapter.isLinkedListBehavior() && arcLabelFeature != null) {
                    // Render arc label
                    bratLabelText = TypeUtil.getUiLabelText(typeAdapter, prevLinkFs, asList(arcLabelFeature));
                } else {
                    // Render only chain type
                    bratLabelText = TypeUtil.getUiLabelText(typeAdapter, prevLinkFs, emptyList());
                }
                aResponse.add(new VArc(typeAdapter.getLayer(), new VID(prevLinkFs, 1, VID.NONE, VID.NONE), bratTypeName, prevLinkFs, linkFs, colorIndex, singletonMap("label", bratLabelText)));
            }
            // Render errors if required features are missing
            renderRequiredFeatureErrors(visibleFeatures, linkFs, aResponse);
            // if (BratAjaxCasUtil.isSame(linkFs, nextLinkFs)) {
            // log.error("Loop in CAS detected, aborting rendering of chains");
            // break;
            // }
            prevLinkFs = linkFs;
            linkFs = nextLinkFs;
        }
        // The color index is updated even for chains that have no visible links in the current
        // window because we would like the chain color to be independent of visibility. In
        // particular the color of a chain should not change when switching pages/scrolling.
        colorIndex++;
    }
}

Example 2 with VSpan

use of de.tudarmstadt.ukp.clarin.webanno.api.annotation.rendering.model.VSpan in project webanno by webanno.

the class SpanRenderer method render.

@Override
public void render(JCas aJcas, List<AnnotationFeature> aFeatures, VDocument aResponse, AnnotatorState aBratAnnotatorModel) {
    List<AnnotationFeature> visibleFeatures = aFeatures.stream().filter(f -> f.isVisible() && f.isEnabled()).collect(Collectors.toList());
    SpanAdapter typeAdapter = getTypeAdapter();
    Type type = getType(aJcas.getCas(), typeAdapter.getAnnotationTypeName());
    int windowBegin = aBratAnnotatorModel.getWindowBeginOffset();
    int windowEnd = aBratAnnotatorModel.getWindowEndOffset();
    List<Sentence> visibleSentences = selectCovered(aJcas, Sentence.class, windowBegin, windowEnd);
    for (AnnotationFS fs : selectCovered(aJcas.getCas(), type, windowBegin, windowEnd)) {
        String bratTypeName = TypeUtil.getUiTypeName(typeAdapter);
        Map<String, String> features = getFeatures(typeAdapter, fs, visibleFeatures);
        Map<String, String> hoverFeatures = getHoverFeatures(typeAdapter, fs, aFeatures);
        Sentence beginSent = null;
        Sentence endSent = null;
        // the visible window
        for (Sentence sent : visibleSentences) {
            if (beginSent == null) {
                // offset of the current annotation.
                if (sent.getBegin() <= fs.getBegin() && fs.getBegin() <= sent.getEnd()) {
                    beginSent = sent;
                }
                // second sentence.
                if (fs.getBegin() == fs.getEnd()) {
                    endSent = sent;
                }
            }
            if (endSent == null) {
                if (sent.getBegin() <= fs.getEnd() && fs.getEnd() <= sent.getEnd()) {
                    endSent = sent;
                }
            }
            if (beginSent != null && endSent != null) {
                break;
            }
        }
        if (beginSent == null || endSent == null) {
            throw new IllegalStateException("Unable to determine sentences in which the annotation starts/ends: " + fs);
        }
        List<Sentence> sentences = selectCovered(aJcas, Sentence.class, beginSent.getBegin(), endSent.getEnd());
        List<VRange> ranges = new ArrayList<>();
        if (sentences.size() > 1) {
            for (Sentence sentence : sentences) {
                if (sentence.getBegin() <= fs.getBegin() && fs.getBegin() < sentence.getEnd()) {
                    ranges.add(new VRange(fs.getBegin() - windowBegin, sentence.getEnd() - windowBegin));
                } else if (sentence.getBegin() <= fs.getEnd() && fs.getEnd() <= sentence.getEnd()) {
                    ranges.add(new VRange(sentence.getBegin() - windowBegin, fs.getEnd() - windowBegin));
                } else {
                    ranges.add(new VRange(sentence.getBegin() - windowBegin, sentence.getEnd() - windowBegin));
                }
            }
            aResponse.add(new VSpan(typeAdapter.getLayer(), fs, bratTypeName, ranges, features, hoverFeatures));
        } else {
            // FIXME It should be possible to remove this case and the if clause because
            // the case that a FS is inside a single sentence is just a special case
            aResponse.add(new VSpan(typeAdapter.getLayer(), fs, bratTypeName, new VRange(fs.getBegin() - windowBegin, fs.getEnd() - windowBegin), features, hoverFeatures));
        }
        // Render errors if required features are missing
        renderRequiredFeatureErrors(visibleFeatures, fs, aResponse);
        // Render slots
        int fi = 0;
        for (AnnotationFeature feat : typeAdapter.listFeatures()) {
            if (MultiValueMode.ARRAY.equals(feat.getMultiValueMode()) && LinkMode.WITH_ROLE.equals(feat.getLinkMode())) {
                List<LinkWithRoleModel> links = typeAdapter.getFeatureValue(feat, fs);
                for (int li = 0; li < links.size(); li++) {
                    LinkWithRoleModel link = links.get(li);
                    FeatureStructure targetFS = selectByAddr(fs.getCAS(), link.targetAddr);
                    aResponse.add(new VArc(typeAdapter.getLayer(), new VID(fs, fi, li), bratTypeName, fs, targetFS, link.role, features));
                }
            }
            fi++;
        }
    }
}

Example 3 with VSpan

use of de.tudarmstadt.ukp.clarin.webanno.api.annotation.rendering.model.VSpan in project webanno by webanno.

the class BratRenderer method render.

/**
 * wrap JSON responses to BRAT visualizer
 *
 * @param aResponse
 *            the response.
 * @param aState
 *            the annotator model.
 * @param aJCas
 *            the JCas.
 * @param aAnnotationService
 *            the annotation service.s
 */
public static void render(GetDocumentResponse aResponse, AnnotatorState aState, VDocument aVDoc, JCas aJCas, AnnotationSchemaService aAnnotationService, ColoringStrategy aColoringStrategy) {
    aResponse.setRtlMode(ScriptDirection.RTL.equals(aState.getScriptDirection()));
    aResponse.setFontZoom(aState.getPreferences().getFontZoom());
    // Render invisible baseline annotations (sentence, tokens)
    renderTokenAndSentence(aJCas, aResponse, aState);
    // Render visible (custom) layers
    Map<String[], Queue<String>> colorQueues = new HashMap<>();
    for (AnnotationLayer layer : aVDoc.getAnnotationLayers()) {
        ColoringStrategy coloringStrategy = aColoringStrategy != null ? aColoringStrategy : ColoringStrategy.getStrategy(aAnnotationService, layer, aState.getPreferences(), colorQueues);
        TypeAdapter typeAdapter = aAnnotationService.getAdapter(layer);
        for (VSpan vspan : aVDoc.spans(layer.getId())) {
            List<Offsets> offsets = toOffsets(vspan.getRanges());
            String bratLabelText = TypeUtil.getUiLabelText(typeAdapter, vspan.getFeatures());
            String bratHoverText = TypeUtil.getUiHoverText(typeAdapter, vspan.getHoverFeatures());
            String color;
            if (vspan.getColorHint() == null) {
                color = getColor(vspan, coloringStrategy, bratLabelText);
            } else {
                color = vspan.getColorHint();
            }
            aResponse.addEntity(new Entity(vspan.getVid(), vspan.getType(), offsets, bratLabelText, color, bratHoverText));
        }
        for (VArc varc : aVDoc.arcs(layer.getId())) {
            String bratLabelText;
            if (varc.getLabelHint() == null) {
                bratLabelText = TypeUtil.getUiLabelText(typeAdapter, varc.getFeatures());
            } else {
                bratLabelText = varc.getLabelHint();
            }
            String color;
            if (varc.getColorHint() == null) {
                color = getColor(varc, coloringStrategy, bratLabelText);
            } else {
                color = varc.getColorHint();
            }
            aResponse.addRelation(new Relation(varc.getVid(), varc.getType(), getArgument(varc.getSource(), varc.getTarget()), bratLabelText, color));
        }
    }
    List<Sentence> sentences = new ArrayList<>(select(aJCas, Sentence.class));
    for (VComment vcomment : aVDoc.comments()) {
        String type;
        switch(vcomment.getCommentType()) {
            case ERROR:
                type = AnnotationComment.ANNOTATION_ERROR;
                break;
            case INFO:
                type = AnnotationComment.ANNOTATOR_NOTES;
                break;
            case YIELD:
                type = "Yield";
                break;
            default:
                type = AnnotationComment.ANNOTATOR_NOTES;
                break;
        }
        AnnotationFS fs;
        if (!vcomment.getVid().isSynthetic() && ((fs = selectByAddr(aJCas, vcomment.getVid().getId())) instanceof Sentence)) {
            int index = sentences.indexOf(fs) + 1;
            aResponse.addComment(new SentenceComment(index, type, vcomment.getComment()));
        } else {
            aResponse.addComment(new AnnotationComment(vcomment.getVid(), type, vcomment.getComment()));
        }
    }
    // Render markers
    for (VMarker vmarker : aVDoc.getMarkers()) {
        if (vmarker instanceof VAnnotationMarker) {
            VAnnotationMarker marker = (VAnnotationMarker) vmarker;
            aResponse.addMarker(new AnnotationMarker(vmarker.getType(), marker.getVid()));
        } else if (vmarker instanceof VSentenceMarker) {
            VSentenceMarker marker = (VSentenceMarker) vmarker;
            aResponse.addMarker(new SentenceMarker(vmarker.getType(), marker.getIndex()));
        } else if (vmarker instanceof VTextMarker) {
            VTextMarker marker = (VTextMarker) vmarker;
            aResponse.addMarker(new TextMarker(marker.getType(), marker.getBegin(), marker.getEnd()));
        } else {
            LOG.warn("Unknown how to render marker: [" + vmarker + "]");
        }
    }
}