edu.stanford.protege.webprotege.entity.EntityNode 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.entity;

import com.fasterxml.jackson.annotation.*;
import com.google.auto.value.AutoValue;
import com.google.common.collect.*;
import edu.stanford.protege.webprotege.common.*;
import edu.stanford.protege.webprotege.tag.Tag;
import edu.stanford.protege.webprotege.watches.Watch;
import org.semanticweb.owlapi.model.OWLEntity;

import javax.annotation.Nonnull;
import java.io.Serializable;
import java.util.*;

import static com.google.common.collect.ImmutableMap.toImmutableMap;

/**
 * Matthew Horridge Stanford Center for Biomedical Informatics Research 28 Nov 2017
 */
@AutoValue

public abstract class EntityNode implements Serializable, Comparable {

    private static final boolean NOT_DEPRECATED = false;

    private static final ImmutableSet NO_WATCHES = ImmutableSet.of();

    private static final int NO_OPEN_COMMENTS = 0;

    private static final ImmutableSet NO_ENTITY_TAGS = ImmutableSet.of();

    private static final ImmutableSet NO_STATUSES = ImmutableSet.of();


    @Nonnull
    public static EntityNode get(@Nonnull OWLEntity entity,
                                 @Nonnull String browserText,
                                 @Nonnull ImmutableMap shortForms,
                                 boolean deprecated,
                                 @Nonnull Set watches,
                                 int openCommentCount,
                                 Collection tags,
                                 Set statuses) {
        return new AutoValue_EntityNode(entity,
                browserText,
                ImmutableSet.copyOf(tags),
                deprecated,
                ImmutableSet.copyOf(watches),
                openCommentCount,
                shortForms,
                ImmutableSet.copyOf(statuses));
    }

    @JsonCreator
    @Nonnull
    public static EntityNode get(@JsonProperty("entity") @Nonnull OWLEntity entity,
                                 @JsonProperty("browserText") @Nonnull String browserText,
                                 @JsonProperty("shortForms") @Nonnull ImmutableList shortForms,
                                 @JsonProperty("deprecated") boolean deprecated,
                                 @JsonProperty("watches") @Nonnull Set watches,
                                 @JsonProperty("openCommentCount") int openCommentCount,
                                 @JsonProperty("tags") Collection tags,
                                 @JsonProperty("statuses") Set statuses) {
        ImmutableMap map = shortForms.stream()
                .collect(toImmutableMap(ShortForm::getDictionaryLanguage,
                        ShortForm::getShortForm));

        return get(entity,
                browserText,
                map,
                deprecated,
                ImmutableSet.copyOf(watches),
                openCommentCount,
                ImmutableSet.copyOf(tags),
                ImmutableSet.copyOf(statuses));
    }

    /**
     * Gets a basic {@link EntityNode} for the specified {@link OWLEntityData}.  The
     * node will be rendered without any indications of deprecation status,
     * watches, open comments count, and term tags
     *
     * @param entityData The term data
     * @return A basic rendering of the specified term data
     */
    @Nonnull
    public static EntityNode getFromEntityData(@Nonnull OWLEntityData entityData) {
        return get(entityData.getEntity(),
                entityData.getBrowserText(),
                entityData.getShortForms(),
                NOT_DEPRECATED,
                NO_WATCHES,
                NO_OPEN_COMMENTS,
                NO_ENTITY_TAGS,
                NO_STATUSES);
    }

    @Nonnull
    public abstract OWLEntity getEntity();

    @Nonnull
    public abstract String getBrowserText();

    @JsonIgnore
    @Nonnull
    public String getText() {
        return getBrowserText();
    }

    public String getText(@Nonnull DictionaryLanguageData prefLang) {
        return getText(Collections.singletonList(prefLang.getDictionaryLanguage()), getBrowserText());
    }

    public String getText(@Nonnull List prefLang, String defaultText) {
        return prefLang.stream()
                .map(language -> getShortForms().get(language))
                .filter(Objects::nonNull)
                .findFirst()
                .orElse(defaultText);
    }

    public abstract ImmutableSet getTags();

    public abstract boolean isDeprecated();

    public abstract ImmutableSet getWatches();

    public abstract int getOpenCommentCount();

    @JsonIgnore
    @Nonnull
    public abstract ImmutableMap getShortForms();

    @JsonProperty("statuses")
    public abstract ImmutableSet getStatuses();

    @JsonProperty("shortForms")
    public ImmutableList getShortFormsList() {
        return getShortForms().entrySet()
                .stream()
                .map(entry -> ShortForm.get(entry.getKey(), entry.getValue()))
                .collect(ImmutableList.toImmutableList());
    }

    @Override
    public int compareTo(EntityNode o) {
        return this.getBrowserText().compareToIgnoreCase(o.getBrowserText());
    }


}