edu.stanford.protege.webprotege.entity.SetEntityDeprecatedDelegateHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-service Show documentation
The newest version!
package edu.stanford.protege.webprotege.entity;

import edu.stanford.protege.webprotege.access.AccessManager;
import edu.stanford.protege.webprotege.access.BuiltInAction;
import edu.stanford.protege.webprotege.change.AddAxiomChange;
import edu.stanford.protege.webprotege.change.FixedChangeListGenerator;
import edu.stanford.protege.webprotege.change.OntologyChange;
import edu.stanford.protege.webprotege.dispatch.AbstractProjectActionHandler;
import edu.stanford.protege.webprotege.ipc.ExecutionContext;
import edu.stanford.protege.webprotege.project.DefaultOntologyIdManager;
import edu.stanford.protege.webprotege.project.chg.ChangeManager;
import org.semanticweb.owlapi.model.OWLDataFactory;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;

/**
 * Matthew Horridge
 * Stanford Center for Biomedical Informatics Research
 * 2021-09-01
 */
public class SetEntityDeprecatedDelegateHandler extends AbstractProjectActionHandler {

    private final ChangeManager changeManager;

    private final OWLDataFactory dataFactory;

    private final DefaultOntologyIdManager defaultOntologyIdManager;

    public SetEntityDeprecatedDelegateHandler(@Nonnull AccessManager accessManager,
                                              ChangeManager changeManager,
                                              OWLDataFactory dataFactory,
                                              DefaultOntologyIdManager defaultOntologyIdManager) {
        super(accessManager);
        this.changeManager = changeManager;
        this.dataFactory = dataFactory;
        this.defaultOntologyIdManager = defaultOntologyIdManager;
    }

    @Nonnull
    @Override
    public Class getActionClass() {
        return SetEntityDeprecatedRequest.class;
    }

    @Nullable
    @Override
    protected BuiltInAction getRequiredExecutableBuiltInAction(SetEntityDeprecatedRequest action) {
        return BuiltInAction.EDIT_ONTOLOGY;
    }

    @Nonnull
    @Override
    public SetEntityDeprecatedResponse execute(@Nonnull SetEntityDeprecatedRequest action,
                                               @Nonnull ExecutionContext executionContext) {

        var axiom = dataFactory.getDeprecatedOWLAnnotationAssertionAxiom(action.entityIri());
        var changes = List.of(new AddAxiomChange(defaultOntologyIdManager.getDefaultOntologyId(),
                                                                 axiom));
        var result = changeManager.applyChanges(executionContext.userId(),
                                                new FixedChangeListGenerator<>(action.changeRequestId(),
                                                                               changes, "", "Deprecated entity"));
        return new SetEntityDeprecatedResponse();
    }
}