edu.stanford.protege.webprotege.entity.CreateClassesAction 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
The newest version!
package edu.stanford.protege.webprotege.entity;

import com.fasterxml.jackson.annotation.JsonClassDescription;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.google.common.collect.ImmutableSet;
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.Request;
import edu.stanford.protege.webprotege.dispatch.ProjectAction;
import org.semanticweb.owlapi.model.OWLClass;

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 22/02/2013
 */
@JsonTypeName("webprotege.entities.CreateClasses")
@JsonClassDescription("Represents a request to create OWL classes in a specified project")
public record CreateClassesAction(ChangeRequestId changeRequestId,
                                  @JsonPropertyDescription("The id of the project where the classes will be created")
                                  ProjectId projectId,
                                  @JsonPropertyDescription("""
                                          The source text that contains the user supplied names for the classes.

                                          Multiple user-supplied class names should be separated with a new line.""")
                                  String sourceText,
                                  @JsonPropertyDescription("The language tag that should be used for the labels of the created classes")
                                  String langTag,
                                  @JsonPropertyDescription("""
                                          A set of classes that the created classes will be subclasses of.

                                          May be empty.""")
                                  ImmutableSet parents) implements ProjectAction, Request, ContentChangeRequest {

    public static final String CHANNEL = "webprotege.entities.CreateClasses";

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