edu.stanford.protege.webprotege.viz.EntityGraphSettings 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.viz;

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 com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import edu.stanford.protege.webprotege.criteria.MultiMatchType;

import javax.annotation.Nonnull;
import java.util.List;

import static com.google.common.collect.ImmutableList.toImmutableList;
import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static java.util.stream.Collectors.toList;

/**
 * Matthew Horridge
 * Stanford Center for Biomedical Informatics Research
 * 2019-12-06
 */
@AutoValue

public abstract class EntityGraphSettings {

    public static final String FILTERS = "filters";

    public static final String RANK_SPACING = "rankSpacing";

    @Nonnull
    public static EntityGraphSettings getDefault() {
        return get(ImmutableList.of(), 1.0);
    }

    @JsonCreator
    public static EntityGraphSettings get(@Nonnull @JsonProperty(FILTERS) ImmutableList criteria,
                                          @JsonProperty(value = RANK_SPACING,
                                                        defaultValue = "1.0") double rankSpacing) {
        return new AutoValue_EntityGraphSettings(criteria, rankSpacing);
    }

    @JsonIgnore
    @Nonnull
    public ImmutableList getActiveFilterNames() {
        return getFilters().stream()
                           .filter(EntityGraphFilter::isActive)
                           .map(EntityGraphFilter::getName)
                           .collect(toImmutableList());
    }

    /**
     * Gets the criteria that are used for filtering edges in an
     * term graph
     *
     * @return The criteria.
     */
    @Nonnull
    @JsonProperty(FILTERS)
    public abstract ImmutableList getFilters();

    @JsonIgnore
    @Nonnull
    public EdgeCriteria getCombinedActiveFilterCriteria() {
        List inclusionCriteria = getFilters()
                .stream()
                .filter(EntityGraphFilter::isActive)
                .map(EntityGraphFilter::getInclusionCriteria)
                .collect(toList());

        List exclusionCriteria = getFilters()
                .stream()
                .filter(EntityGraphFilter::isActive)
                .map(EntityGraphFilter::getExclusionCriteria)
                .map(NegatedEdgeCriteria::get)
                .collect(toList());
        return CompositeEdgeCriteria.get(MultiMatchType.ALL,
                CompositeEdgeCriteria.get(inclusionCriteria, MultiMatchType.ANY),
                                         CompositeEdgeCriteria.get(exclusionCriteria, MultiMatchType.ALL));
    }

    @JsonIgnore
    @Nonnull
    public ImmutableSet getFilterNames() {
        return getFilters().stream()
                           .map(EntityGraphFilter::getName)
                           .collect(toImmutableSet());
    }

    @JsonProperty(RANK_SPACING)
    public abstract double getRankSpacing();
}