uk.ac.manchester.cs.owl.owlapi.SWRLRuleImpl Maven / Gradle / Ivy
/*
* This file is part of the OWL API.
*
* The contents of this file are subject to the LGPL License, Version 3.0.
*
* Copyright (C) 2011, The University of Manchester
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*
*
* Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0
* in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
*
* Copyright 2011, University of Manchester
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package uk.ac.manchester.cs.owl.owlapi;
import java.lang.ref.WeakReference;
import java.util.Collection;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Set;
import org.semanticweb.owlapi.model.AxiomType;
import org.semanticweb.owlapi.model.OWLAnnotation;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLAxiomVisitor;
import org.semanticweb.owlapi.model.OWLAxiomVisitorEx;
import org.semanticweb.owlapi.model.OWLClassExpression;
import org.semanticweb.owlapi.model.OWLObject;
import org.semanticweb.owlapi.model.OWLObjectVisitor;
import org.semanticweb.owlapi.model.OWLObjectVisitorEx;
import org.semanticweb.owlapi.model.SWRLAtom;
import org.semanticweb.owlapi.model.SWRLBuiltInAtom;
import org.semanticweb.owlapi.model.SWRLClassAtom;
import org.semanticweb.owlapi.model.SWRLDataPropertyAtom;
import org.semanticweb.owlapi.model.SWRLDataRangeAtom;
import org.semanticweb.owlapi.model.SWRLDifferentIndividualsAtom;
import org.semanticweb.owlapi.model.SWRLIndividualArgument;
import org.semanticweb.owlapi.model.SWRLLiteralArgument;
import org.semanticweb.owlapi.model.SWRLObject;
import org.semanticweb.owlapi.model.SWRLObjectPropertyAtom;
import org.semanticweb.owlapi.model.SWRLObjectVisitor;
import org.semanticweb.owlapi.model.SWRLObjectVisitorEx;
import org.semanticweb.owlapi.model.SWRLRule;
import org.semanticweb.owlapi.model.SWRLSameIndividualAtom;
import org.semanticweb.owlapi.model.SWRLVariable;
import org.semanticweb.owlapi.util.CollectionFactory;
import org.semanticweb.owlapi.util.SWRLVariableExtractor;
/**
* @author Matthew Horridge, The University Of Manchester, Bio-Health
* Informatics Group, Date: 15-Jan-2007
*/
public class SWRLRuleImpl extends OWLLogicalAxiomImpl implements SWRLRule {
private static final long serialVersionUID = 30406L;
private final LinkedHashSet head;
private final LinkedHashSet body;
private final boolean containsAnonymousClassExpressions;
private WeakReference> variables;
private WeakReference> classAtomsPredicates;
/**
* @param body
* rule body
* @param head
* rule head
* @param annotations
* annotations on the axiom
*/
public SWRLRuleImpl(Set body,
Set head,
Collection annotations) {
super(annotations);
this.head = new LinkedHashSet(head);
this.body = new LinkedHashSet(body);
containsAnonymousClassExpressions = hasAnon();
}
@Override
public SWRLRule getAxiomWithoutAnnotations() {
if (!isAnnotated()) {
return this;
}
return new SWRLRuleImpl(getBody(), getHead(), NO_ANNOTATIONS);
}
@Override
public OWLAxiom getAnnotatedAxiom(Set annotations) {
return new SWRLRuleImpl(getBody(), getHead(), annotations);
}
@Override
public Set getVariables() {
Set toReturn = null;
if (variables != null) {
toReturn = variables.get();
}
if (toReturn != null) {
return toReturn;
}
SWRLVariableExtractor extractor = new SWRLVariableExtractor();
accept(extractor);
toReturn = extractor.getVariables();
variables = new WeakReference>(toReturn);
return toReturn;
}
private boolean hasAnon() {
for (SWRLAtom atom : head) {
if (atom instanceof SWRLClassAtom
&& ((SWRLClassAtom) atom).getPredicate().isAnonymous()) {
return true;
}
}
for (SWRLAtom atom : body) {
if (atom instanceof SWRLClassAtom
&& ((SWRLClassAtom) atom).getPredicate().isAnonymous()) {
return true;
}
}
return false;
}
@Override
public boolean containsAnonymousClassExpressions() {
return containsAnonymousClassExpressions;
}
@Override
public Set getClassAtomPredicates() {
Set toReturn = null;
if (classAtomsPredicates != null) {
toReturn = classAtomsPredicates.get();
}
if (toReturn != null) {
return toReturn;
}
toReturn = new LinkedHashSet();
for (SWRLAtom atom : head) {
if (atom instanceof SWRLClassAtom) {
toReturn.add(((SWRLClassAtom) atom).getPredicate());
}
}
for (SWRLAtom atom : body) {
if (atom instanceof SWRLClassAtom) {
toReturn.add(((SWRLClassAtom) atom).getPredicate());
}
}
classAtomsPredicates = new WeakReference>(
toReturn);
return toReturn;
}
@Override
public void accept(OWLObjectVisitor visitor) {
visitor.visit(this);
}
@Override
public O accept(OWLObjectVisitorEx visitor) {
return visitor.visit(this);
}
@Override
public void accept(SWRLObjectVisitor visitor) {
visitor.visit(this);
}
@Override
public O accept(SWRLObjectVisitorEx visitor) {
return visitor.visit(this);
}
@Override
public Set getBody() {
return CollectionFactory
.getCopyOnRequestSetFromImmutableCollection(body);
}
@Override
public Set getHead() {
return CollectionFactory
.getCopyOnRequestSetFromImmutableCollection(head);
}
@Override
public void accept(OWLAxiomVisitor visitor) {
visitor.visit(this);
}
@Override
public O accept(OWLAxiomVisitorEx visitor) {
return visitor.visit(this);
}
@Override
public SWRLRule getSimplified() {
return (SWRLRule) this.accept(ATOM_SIMPLIFIER);
}
@Override
public boolean isLogicalAxiom() {
return true;
}
@Override
public boolean equals(Object obj) {
if (super.equals(obj)) {
if (!(obj instanceof SWRLRule)) {
return false;
}
SWRLRule other = (SWRLRule) obj;
return other.getBody().equals(body) && other.getHead().equals(head);
}
return false;
}
@Override
public AxiomType getAxiomType() {
return AxiomType.SWRL_RULE;
}
@Override
protected int compareObjectOfSameType(OWLObject object) {
SWRLRule other = (SWRLRule) object;
int diff = compareSets(getBody(), other.getBody());
if (diff == 0) {
diff = compareSets(getHead(), other.getHead());
}
return diff;
}
protected final AtomSimplifier ATOM_SIMPLIFIER = new AtomSimplifier();
protected class AtomSimplifier implements SWRLObjectVisitorEx {
@Override
public SWRLRule visit(SWRLRule node) {
Set nodebody = new HashSet();
for (SWRLAtom atom : node.getBody()) {
nodebody.add((SWRLAtom) atom.accept(this));
}
Set nodehead = new HashSet();
for (SWRLAtom atom : node.getHead()) {
nodehead.add((SWRLAtom) atom.accept(this));
}
return new SWRLRuleImpl(nodebody, nodehead, NO_ANNOTATIONS);
}
@Override
public SWRLClassAtom visit(SWRLClassAtom node) {
return node;
}
@Override
public SWRLDataRangeAtom visit(SWRLDataRangeAtom node) {
return node;
}
@Override
public SWRLObjectPropertyAtom visit(SWRLObjectPropertyAtom node) {
return node.getSimplified();
}
@Override
public SWRLDataPropertyAtom visit(SWRLDataPropertyAtom node) {
return node;
}
@Override
public SWRLBuiltInAtom visit(SWRLBuiltInAtom node) {
return node;
}
@Override
public SWRLVariable visit(SWRLVariable node) {
return node;
}
@Override
public SWRLIndividualArgument visit(SWRLIndividualArgument node) {
return node;
}
@Override
public SWRLLiteralArgument visit(SWRLLiteralArgument node) {
return node;
}
@Override
public SWRLSameIndividualAtom visit(SWRLSameIndividualAtom node) {
return node;
}
@Override
public SWRLDifferentIndividualsAtom visit(
SWRLDifferentIndividualsAtom node) {
return node;
}
}
}