edu.stanford.protege.webprotege.axioms.AddAxiomsRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-api Show documentation

There is a newer version: 2.1.0

Show newest version

package edu.stanford.protege.webprotege.axioms;

import com.fasterxml.jackson.annotation.JsonTypeName;
import edu.stanford.protege.webprotege.common.ChangeRequestId;
import edu.stanford.protege.webprotege.common.ContentChangeRequest;
import edu.stanford.protege.webprotege.common.ProjectId;
import edu.stanford.protege.webprotege.common.ProjectRequest;

/**
 * Matthew Horridge
 * Stanford Center for Biomedical Informatics Research
 * 2021-09-01
 *
 * Requests that the specified axioms are added to the specified project.  The axioms will be added to the ontology
 * that is specified by the ontology document.  If the ontology document identifies an anonymous ontology then the
 * axioms will be added to the root ontology.
 * @param projectId The identifier for the project
 * @param ontologyDocument An ontology document containing the axioms serialized into a UTF-8 String.  The axioms will be added to an ontology
 *                         that is identified by the ontology document header.  If this header specifies an anonymous
 *                         ontology then the axioms will be added to the project root ontology.
 * @param mimeType The MIME type of the ontology document.
 */
@JsonTypeName("webprotege.axioms.AddAxioms")
public record AddAxiomsRequest(ChangeRequestId changeRequestId, ProjectId projectId, String ontologyDocument, String mimeType, String commitMessage) implements ProjectRequest, ContentChangeRequest {

    public static final String CHANNEL = "webprotege.axioms.AddAxioms";

    @Override
    public String getChannel() {
        return CHANNEL;
    }
}