edu.stanford.protege.webprotege.project.NewProjectSettings 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.project;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;
import edu.stanford.protege.webprotege.common.UserId;
import edu.stanford.protege.webprotege.csv.DocumentId;

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

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 18/01/2012
 */
@AutoValue

public abstract class NewProjectSettings {


    private static final String OWNER = "owner";

    private static final String DISPLAY_NAME = "displayName";

    private static final String LANG_TAG = "langTag";

    private static final String DESCRIPTION = "description";

    private static final String SOURCE_DOCUMENT_ID = "sourceDocumentId";

    /**
     * Creates a NewProjectSettings object that describes the basic settings for a new project and also specifies a
     * set of source documents (via a set of {@link DocumentId} objects) from which to create the project.
     *
     * @param projectOwner       The desired owner of the project.  Not null.
     * @param displayName        The desired project name for the new project.  Not null.
     * @param projectDescription The desired project description for the new project.  Not null.
     * @param sourceDocumentId   A {@link DocumentId} object that should be used to identify the source document with
     *                           which to initialise a project.  May be null.
     * @throws NullPointerException if either projectOwner, displayName, projectDescription or sourceDocumentId are
     *                              null.
     */
    @JsonCreator
    public static NewProjectSettings get(@JsonProperty(OWNER) @Nonnull UserId projectOwner,
                                         @JsonProperty(DISPLAY_NAME) @Nonnull String displayName,
                                         @JsonProperty(LANG_TAG) @Nonnull String langTag,
                                         @JsonProperty(DESCRIPTION) @Nonnull String projectDescription,
                                         @JsonProperty(SOURCE_DOCUMENT_ID) @Nonnull DocumentId sourceDocumentId) {
        return new AutoValue_NewProjectSettings(projectOwner,
                                                displayName,
                                                langTag,
                                                projectDescription,
                                                sourceDocumentId);
    }

    /**
     * Creates a NewProjectSettings object that describes the basic settings for a new project.
     *
     * @param projectOwner       The desired owner of the project.  Not null.
     * @param displayName        The desired project name for the new project.  Not {@code null}.
     * @param langTag            The langTag to be used for new entities.
     * @param projectDescription The desired project description for the new project.  Not {@code null}.
     * @throws NullPointerException if either projectOwner, displayName or projectDescription are null.
     */
    public static NewProjectSettings get(@JsonProperty(OWNER) UserId projectOwner,
                                         @JsonProperty(DISPLAY_NAME) String displayName,
                                         @JsonProperty(LANG_TAG) String langTag,
                                         @JsonProperty(DESCRIPTION) String projectDescription) {
        return new AutoValue_NewProjectSettings(projectOwner,
                                                displayName,
                                                langTag,
                                                projectDescription,
                                                null);
    }

    /**
     * Gets the desired owner of the project.
     *
     * @return The {@link UserId} representing the desired ownner of the project.  Not null.
     */
    @JsonProperty(OWNER)
    @Nonnull
    public abstract UserId getProjectOwner();

    /**
     * Gets the desired name of the project.
     *
     * @return A string representing the project name.  Not null.
     */
    @JsonProperty(DISPLAY_NAME)
    @Nonnull
    public abstract String getDisplayName();

    /**
     * Gets the langTag that is used for new entities and for the primary display name.
     */
    @JsonProperty(LANG_TAG)
    @Nonnull
    public abstract String getLangTag();


    /**
     * Gets the desired project description.
     *
     * @return A string representing the project description.  Not null.
     */
    @JsonProperty(DESCRIPTION)
    @Nonnull
    public abstract String getProjectDescription();

    /**
     * Determines whether of not this new project settings object has a source document associated with it.
     *
     * @return true if there is a source documents associated with this {@link NewProjectSettings} object,
     * otherwise false.
     */
    @JsonIgnore
    public boolean hasSourceDocument() {
        return getSourceDocumentId().isPresent();
    }

    /**
     * Gets a set of {@link DocumentId}s that identify source documents that should be used to create a new project.
     *
     * @return A {@link DocumentId} object identifying a source document.
     */
    @Nonnull
    public Optional getSourceDocumentId() {
        return Optional.ofNullable(sourceDocument());
    }

    @Nullable
    protected abstract DocumentId sourceDocument();

}