Skip to content

#6209 - Clean up deprecated code in AnnotationDetailEditorPanel #6210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reckart merged 1 commit into from
Aug 3, 2026
+5 −236
Merged

#6209 - Clean up deprecated code in AnnotationDetailEditorPanel #6210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions ...n/java/de/tudarmstadt/ukp/clarin/webanno/api/annotation/action/ReadOnlyActionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import java.io.Serializable;

import org.apache.uima.cas.CAS;
import org.apache.uima.cas.text.AnnotationFS;
import org.apache.wicket.ajax.AjaxRequestTarget;

import de.tudarmstadt.ukp.clarin.webanno.api.annotation.exception.NotEditableException;
Expand Down Expand Up @@ -69,12 +68,6 @@ public void actionSelect(AjaxRequestTarget aTarget)
// Passive viewer - ignore
}

@Override
public void actionSelect(AjaxRequestTarget aTarget, AnnotationFS aAnnoFs)
{
// Passive viewer - ignore
}

@Override
public void actionSelect(AjaxRequestTarget aTarget, VID aVid)
{
Expand All @@ -87,24 +80,6 @@ public void actionSelectAndJump(AjaxRequestTarget aTarget, VID aVid)
// Passive viewer - ignore
}

@Override
public void actionSelectAndJump(AjaxRequestTarget aTarget, AnnotationFS aFS)
{
// Passive viewer - ignore
}

@Override
public void actionJump(AjaxRequestTarget aTarget, VID aVid)
{
// Passive viewer - ignore
}

@Override
public void actionJump(AjaxRequestTarget aTarget, AnnotationFS aFS)
{
// Passive viewer - ignore
}

@Override
public void actionJump(AjaxRequestTarget aTarget, int aBegin, int aEnd)
{
Expand All @@ -119,12 +94,6 @@ public void actionClear(AjaxRequestTarget aTarget)

// --- Mutating actions are not permitted ---------------------------------------------------

@Override
public void actionCreateOrUpdate(AjaxRequestTarget aTarget, CAS aCas) throws AnnotationException
{
throw new NotEditableException("This editor is read-only.");
}

@Override
public void actionDelete(AjaxRequestTarget aTarget) throws AnnotationException
{
Expand Down
39 changes: 0 additions & 39 deletions ...api/src/main/java/de/tudarmstadt/ukp/inception/editor/action/AnnotationActionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
import java.io.IOException;

import org.apache.uima.cas.CAS;
import org.apache.uima.cas.text.AnnotationFS;
import org.apache.wicket.ajax.AjaxRequestTarget;

import de.tudarmstadt.ukp.clarin.webanno.model.SourceDocument;
Expand All @@ -30,15 +29,6 @@

public interface AnnotationActionHandler
{
/**
* @deprecated Replaced by {@code CreateRelationAnnotationHandler} and
* {@code CreateSpanAnnotationHandler}.
*/
@SuppressWarnings("javadoc")
@Deprecated
void actionCreateOrUpdate(AjaxRequestTarget aTarget, CAS aCas)
throws IOException, AnnotationException;

/**
* Load the annotation pointed to in {@link AnnotatorState#getSelection()} in the detail panel.
*
Expand All @@ -51,40 +41,11 @@ void actionCreateOrUpdate(AjaxRequestTarget aTarget, CAS aCas)
*/
void actionSelect(AjaxRequestTarget aTarget) throws IOException, AnnotationException;

/**
* @deprecated This method is not able to handle sub-annotations such as chain links. Better use
* {@link #actionSelect(AjaxRequestTarget, VID)}
*/
@SuppressWarnings("javadoc")
@Deprecated
void actionSelect(AjaxRequestTarget aTarget, AnnotationFS aAnnoFs)
throws IOException, AnnotationException;

void actionSelect(AjaxRequestTarget aTarget, VID aVid) throws IOException, AnnotationException;

void actionSelectAndJump(AjaxRequestTarget aTarget, VID aVid)
throws IOException, AnnotationException;

void actionJump(AjaxRequestTarget aTarget, VID aVid) throws IOException, AnnotationException;

/**
* @deprecated This method is not able to handle sub-annotations such as chain links. Better use
* {@link #actionSelectAndJump(AjaxRequestTarget, VID)}
*/
@SuppressWarnings("javadoc")
@Deprecated
void actionSelectAndJump(AjaxRequestTarget aTarget, AnnotationFS aFS)
throws IOException, AnnotationException;

/**
* @deprecated This method is not able to handle sub-annotations such as chain links. Better use
* {@link #actionJump(AjaxRequestTarget, VID)}
*/
@SuppressWarnings("javadoc")
@Deprecated
void actionJump(AjaxRequestTarget aTarget, AnnotationFS aFS)
throws IOException, AnnotationException;

void actionJump(AjaxRequestTarget aTarget, int aBegin, int aEnd)
throws IOException, AnnotationException;

Expand Down
171 changes: 5 additions & 166 deletions ...a/de/tudarmstadt/ukp/clarin/webanno/ui/annotation/detail/AnnotationDetailEditorPanel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;

import org.apache.commons.lang3.exception.ExceptionUtils;
Expand Down Expand Up @@ -411,14 +410,6 @@ public void actionSelect(AjaxRequestTarget aTarget) throws IOException, Annotati
}
}

@Deprecated
@Override
public void actionSelect(AjaxRequestTarget aTarget, AnnotationFS annoFs)
throws IOException, AnnotationException
{
actionSelect(aTarget, new VID(annoFs));
}

@Override
public void actionSelect(AjaxRequestTarget aTarget, VID aVid)
throws IOException, AnnotationException
Expand All @@ -433,22 +424,6 @@ public void actionSelect(AjaxRequestTarget aTarget, VID aVid)
actionSelect(aTarget);
}

@Deprecated
@Override
public void actionJump(AjaxRequestTarget aTarget, AnnotationFS aFS)
throws IOException, AnnotationException
{
editorPage.actionShowSelectedDocument(aTarget, getModelObject().getDocument(),
aFS.getBegin(), aFS.getEnd());
}

@Override
public void actionJump(AjaxRequestTarget aTarget, VID aVid)
throws IOException, AnnotationException
{
actionJump(aTarget, selectAnnotationByAddr(editorPage.getEditorCas(), aVid.getId()));
}

@Override
public void actionJump(AjaxRequestTarget aTarget, int aBegin, int aEnd)
throws IOException, AnnotationException
Expand All @@ -469,20 +444,19 @@ public void actionShowSelectedDocument(AjaxRequestTarget aTarget, SourceDocument
}

@Deprecated
@Override
public void actionSelectAndJump(AjaxRequestTarget aTarget, AnnotationFS annoFs)
private void actionSelectAndJump(AjaxRequestTarget aTarget, AnnotationFS annoFs)
throws IOException, AnnotationException
{
actionSelect(aTarget, annoFs);
actionSelect(aTarget, new VID(annoFs));

var state = getModelObject();
var doc = state.getDocument();

// For arcs, pass the endpoint ranges as additional ping ranges
if (state.getSelection().isArc()) {
var cas = editorPage.getEditorCas();
var originFs = ICasUtil.selectAnnotationByAddr(cas, state.getSelection().getOrigin());
var targetFs = ICasUtil.selectAnnotationByAddr(cas, state.getSelection().getTarget());
var originFs = selectAnnotationByAddr(cas, state.getSelection().getOrigin());
var targetFs = selectAnnotationByAddr(cas, state.getSelection().getTarget());
var endpointRanges = List.of(new VRange(originFs.getBegin(), originFs.getEnd()),
new VRange(targetFs.getBegin(), targetFs.getEnd()));
editorPage.actionShowSelectedDocument(aTarget, doc, annoFs.getBegin(), annoFs.getEnd(),
Expand All @@ -498,147 +472,12 @@ public void actionSelectAndJump(AjaxRequestTarget aTarget, VID aVid)
throws IOException, AnnotationException
{
var cas = editorPage.getEditorCas();
var targetFs = ICasUtil.selectFsByAddr(cas, aVid.getId());
var targetFs = selectFsByAddr(cas, aVid.getId());
if (targetFs instanceof AnnotationFS) {
actionSelectAndJump(aTarget, (AnnotationFS) targetFs);
}
}

@Override
@Deprecated
public void actionCreateOrUpdate(AjaxRequestTarget aTarget, CAS aCas)
throws IOException, AnnotationException
{
LOG.trace("actionAnnotate");

editorPage.ensureIsEditable();

var state = getModelObject();
if (!state.getSelection().isSet()) {
return;
}

// Creating or updating an annotation should not change the current default layer - even
// though it might temporarily do so as e.g. a relation is created.
var savedDefaultLayer = state.getDefaultAnnotationLayer();

// Note that refresh changes the selected layer if a relation is created. Then the layer
// switches from the selected span layer to the relation layer that is attached to the span
try {
if (state.getSelection().isArc()) {
prepareCreateOrUpdateRelation(aTarget, aCas, state);
}
else {
// Re-set the selected layer from the drop-down since it might have changed if we
// have previously created a relation annotation
state.setSelectedAnnotationLayer(state.getDefaultAnnotationLayer());
}

// Can check state only now because the methods above may juggle the selection.. argh
if (state.getSelectableLayers().isEmpty()) {
info("No text-level annotation layers are available in this project.");
aTarget.addChildren(getPage(), IFeedback.class);
return;
}

if (state.getSelectedAnnotationLayer() == null) {
error("No layer is selected. First select a layer.");
aTarget.addChildren(getPage(), IFeedback.class);
return;
}

if (state.getSelectedAnnotationLayer().isReadonly()) {
error("Layer is not editable.");
aTarget.addChildren(getPage(), IFeedback.class);
return;
}

LOG.trace("actionAnnotate() selectedLayer: {}",
state.getSelectedAnnotationLayer().getUiName());
LOG.trace("actionAnnotate() defaultLayer: {}",
state.getDefaultAnnotationLayer().getUiName());

internalCommitAnnotation(aTarget, aCas);

internalCompleteAnnotation(aTarget, aCas);

if (aTarget != null) {
refresh(aTarget);
}

state.clearArmedSlot();
}
finally {
state.setDefaultAnnotationLayer(savedDefaultLayer);
}
}

/**
* @deprecated To be removed without replacement.
*/
@Deprecated
private void prepareCreateOrUpdateRelation(AjaxRequestTarget aTarget, CAS aCas,
AnnotatorState state)
throws IllegalPlacementException, IOException, AnnotationException
{
LOG.trace("actionAnnotate() relation annotation - looking for attached layer");

// FIXME REC I think this whole section which meddles around with the selected
// annotation layer should be moved out of there to the place where we originally
// set the annotation layer...!

// Fetch the annotation representing the origin endpoint of the relation
var originFS = selectAnnotationByAddr(aCas, state.getSelection().getOrigin());
var targetFS = selectAnnotationByAddr(aCas, state.getSelection().getTarget());

if (!schemaProperties.isCrossLayerRelationsEnabled()
&& !originFS.getType().equals(targetFS.getType())) {
reset(aTarget);
throw new IllegalPlacementException(
"Cannot create relation between spans on different layers");
}

// Fetch the annotation layer for the origin annotation
var originLayer = annotationService.findLayer(state.getProject(), originFS);

var previousLayer = state.getSelectedAnnotationLayer();

// If we are creating a relation annotation, we have to set the current layer
// depending on the type of relation that is permitted between the source/target
// span. This is necessary because we have no separate UI control to set the
// relation annotation type.
// It is possible because currently only a single relation layer is allowed to
// attach to any given span layer.

// If we drag an arc in a chain layer, then the arc is of the same layer as the span
// Chain layers consist of arcs and spans
if (ChainLayerSupport.TYPE.equals(originLayer.getType())) {
// one layer both for the span and arc annotation
state.setSelectedAnnotationLayer(originLayer);
}
// Otherwise, look up the possible relation layer(s) in the database.
else {
var viableRelationLayers = annotationService.getRelationLayersFor(originLayer);
if (viableRelationLayers.isEmpty()) {
throw new IllegalPlacementException(
"There are no relation layers that can be created between these endpoints");
}
if (viableRelationLayers.size() == 1) {
var relationLayer = viableRelationLayers.get(0);
state.setSelectedAnnotationLayer(relationLayer);
}
}

state.setDefaultAnnotationLayer(originLayer);

// If we switched layers, we need to initialize the feature editors for the new layer
if (!Objects.equals(previousLayer, state.getSelectedAnnotationLayer())) {
LOG.trace("Layer changed from {} to {} - need to reload feature editors", previousLayer,
state.getSelectedAnnotationLayer());
loadFeatureEditorModels(aTarget);
}
}

/**
* Persists the potentially modified CAS, remembers feature values, reloads the feature editors
* using the latest info from the CAS, updates the sentence number and focus unit, performs
Expand Down
Loading