edu.stanford.protege.webprotege.frame.GetClassFrameActionHandler 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.frame;

import edu.stanford.protege.webprotege.access.AccessManager;
import edu.stanford.protege.webprotege.access.BuiltInAction;
import edu.stanford.protege.webprotege.dispatch.AbstractProjectActionHandler;
import edu.stanford.protege.webprotege.dispatch.Action;
import edu.stanford.protege.webprotege.ipc.ExecutionContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.inject.Inject;

import static edu.stanford.protege.webprotege.frame.ClassFrameTranslationOptions.AncestorsTreatment.EXCLUDE_ANCESTORS;
import static edu.stanford.protege.webprotege.frame.RelationshipTranslationOptions.RelationshipMinification.NON_MINIMIZED_RELATIONSHIPS;
import static edu.stanford.protege.webprotege.frame.RelationshipTranslationOptions.allOutgoingRelationships;
import static edu.stanford.protege.webprotege.frame.RelationshipTranslationOptions.noIncomingRelationships;

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 20/02/2013
 */
public class GetClassFrameActionHandler extends AbstractProjectActionHandler {

    private static final Logger logger = LoggerFactory.getLogger(GetClassFrameActionHandler.class);

    @Nonnull
    private final ClassFrameProvider classFrameProvider;

    @Nonnull
    private final PlainFrameRenderer plainFrameRenderer;

    @Inject
    public GetClassFrameActionHandler(@Nonnull AccessManager accessManager,
                                      @Nonnull ClassFrameProvider classFrameProvider,
                                      @Nonnull PlainFrameRenderer plainFrameRenderer) {
        super(accessManager);
        this.classFrameProvider = classFrameProvider;
        this.plainFrameRenderer = plainFrameRenderer;
    }

    /**
     * Gets the class of {@link Action} handled by this handler.
     * @return The class of {@link Action}.  Not {@code null}.
     */
    @Nonnull
    @Override
    public Class getActionClass() {
        return GetClassFrameAction.class;
    }

    @Nullable
    @Override
    protected BuiltInAction getRequiredExecutableBuiltInAction(GetClassFrameAction action) {
        return BuiltInAction.VIEW_PROJECT;
    }

    @Nonnull
    @Override
    public GetClassFrameResult execute(@Nonnull GetClassFrameAction action,
                                       @Nonnull ExecutionContext executionContext) {
        var subject = action.subject();
        var options = ClassFrameTranslationOptions.get(
                EXCLUDE_ANCESTORS,
                RelationshipTranslationOptions.get(allOutgoingRelationships(),
                                                   noIncomingRelationships(),
                                                   NON_MINIMIZED_RELATIONSHIPS));
        var classFrame = classFrameProvider.getFrame(subject, options);
        var renderedFrame = plainFrameRenderer.toClassFrame(classFrame);
        return new GetClassFrameResult((renderedFrame));
    }
}