edu.stanford.protege.webprotege.entity.SubjectClosureResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-service Show documentation
The newest version!
package edu.stanford.protege.webprotege.entity;

import com.google.common.collect.ImmutableSet;
import edu.stanford.protege.webprotege.index.AnnotationAssertionAxiomsByValueIndex;
import edu.stanford.protege.webprotege.index.EntitiesInProjectSignatureByIriIndex;
import edu.stanford.protege.webprotege.index.ProjectOntologiesIndex;
import org.semanticweb.owlapi.model.*;

import javax.annotation.Nonnull;
import javax.inject.Inject;
import java.util.HashSet;
import java.util.Set;
import java.util.stream.Stream;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Matthew Horridge
 * Stanford Center for Biomedical Informatics Research
 * 2020-08-13
 *
 * Given an entity, returns other entities that could be the subject of the supplied entity.  This is
 * based on annotation assertions.  For example, given AnnotationAssertion(:p :A :C), the IRI :C would
 * be resolved to {:A :C}.
 */
public class SubjectClosureResolver {

    @Nonnull
    private final AnnotationAssertionAxiomsByValueIndex annotationAssertionAxiomsByValueIndex;

    @Nonnull
    private final ProjectOntologiesIndex projectOntologiesIndex;

    @Nonnull
    private final EntitiesInProjectSignatureByIriIndex entitiesInProjectSignatureIndex;

    @Inject
    public SubjectClosureResolver(@Nonnull AnnotationAssertionAxiomsByValueIndex annotationAssertionAxiomsByValueIndex,
                                  @Nonnull ProjectOntologiesIndex projectOntologiesIndex,
                                  @Nonnull EntitiesInProjectSignatureByIriIndex entitiesInProjectSignatureIndex) {
        this.annotationAssertionAxiomsByValueIndex = checkNotNull(annotationAssertionAxiomsByValueIndex);
        this.projectOntologiesIndex = projectOntologiesIndex;
        this.entitiesInProjectSignatureIndex = entitiesInProjectSignatureIndex;
    }

    @Nonnull
    public Stream resolve(@Nonnull OWLEntity entity) {
        var resultBuilder = ImmutableSet.builder();
        resultBuilder.add(entity);
        var entityIri = entity.getIRI();
        getIncomingEntities(entityIri, resultBuilder, new HashSet<>());
        return resultBuilder.build().stream();
    }

    private void getIncomingEntities(@Nonnull OWLAnnotationValue targetValue,
                                     @Nonnull ImmutableSet.Builder resultBuilder,
                                     @Nonnull Set processed) {
        if(!processed.add(targetValue)) {
            return;
        }
        var subjects = getSubjectsForValue(targetValue);
        subjects.forEach(subject -> {
            if(subject instanceof IRI) {
                var subjectIri = (IRI) subject;
                entitiesInProjectSignatureIndex.getEntitiesInSignature(subjectIri)
                                               .forEach(resultBuilder::add);
            }
            var subjectAsValue = (OWLAnnotationValue) subject;
            getIncomingEntities(subjectAsValue, resultBuilder, processed);
        });
    }

    @Nonnull
    private Stream getSubjectsForValue(@Nonnull OWLAnnotationValue targetValue) {
        return projectOntologiesIndex.getOntologyIds()
                              .flatMap(ontId -> annotationAssertionAxiomsByValueIndex.getAxiomsByValue(targetValue, ontId))
                .map(OWLAnnotationAssertionAxiom::getSubject);
    }
}