// Copyright (c) 2006 - 2008, Clark & Parsia, LLC. <http://www.clarkparsia.com>
// This source code is available under the terms of the Affero General Public License v3.
//
// Please see LICENSE.txt for full license terms, including the availability of proprietary exceptions.
// Questions, comments, or requests for clarification: licensing@clarkparsia.com
package com.clarkparsia.pellint.lintpattern.axiom;
import org.semanticweb.owlapi.model.OWLClassAxiom;
import org.semanticweb.owlapi.model.OWLDisjointClassesAxiom;
import org.semanticweb.owlapi.model.OWLDisjointUnionAxiom;
import org.semanticweb.owlapi.model.OWLEquivalentClassesAxiom;
import org.semanticweb.owlapi.model.OWLObjectCardinalityRestriction;
import org.semanticweb.owlapi.model.OWLObjectExactCardinality;
import org.semanticweb.owlapi.model.OWLObjectMaxCardinality;
import org.semanticweb.owlapi.model.OWLObjectMinCardinality;
import org.semanticweb.owlapi.model.OWLSubClassOfAxiom;
import com.clarkparsia.pellint.format.LintFormat;
import com.clarkparsia.pellint.format.SimpleLintFormat;
import com.clarkparsia.pellint.model.Lint;
import com.clarkparsia.pellint.model.Severity;
import com.clarkparsia.pellint.util.OWLDeepEntityVisitorAdapter;
/**
* <p>
* Title:
* </p>
* <p>
* Description:
* </p>
* <p>
* Copyright: Copyright (c) 2008
* </p>
* <p>
* Company: Clark & Parsia, LLC. <http://www.clarkparsia.com>
* </p>
*
* @author Harris Lin
*/
public class LargeCardinalityPattern extends AxiomLintPattern {
private static final LintFormat DEFAULT_LINT_FORMAT = new SimpleLintFormat();
private int m_MaxAllowed = 10;
private CardinalitySizeCollector m_Visitor;
public LargeCardinalityPattern() {
m_Visitor = new CardinalitySizeCollector();
}
public String getName() {
return getClass().getSimpleName() + " (MaxAllowed = " + m_MaxAllowed + ")";
}
public String getDescription() {
return "Cardinality restriction is too large - maximum recommended is " + m_MaxAllowed;
}
public boolean isFixable() {
return false;
}
public LintFormat getDefaultLintFormat() {
return DEFAULT_LINT_FORMAT;
}
public void setMaxAllowed(int value) {
m_MaxAllowed = value;
}
public void visit(OWLDisjointClassesAxiom axiom) {
visitNaryClassAxiom(axiom);
}
public void visit(OWLDisjointUnionAxiom axiom) {
visitNaryClassAxiom(axiom);
}
public void visit(OWLEquivalentClassesAxiom axiom) {
visitNaryClassAxiom(axiom);
}
public void visit(OWLSubClassOfAxiom axiom) {
visitNaryClassAxiom(axiom);
}
private void visitNaryClassAxiom(OWLClassAxiom axiom) {
m_Visitor.reset();
axiom.accept(m_Visitor);
int cardinalitySize = m_Visitor.getCardinalitySize();
if (cardinalitySize > m_MaxAllowed) {
Lint lint = makeLint();
lint.addParticipatingAxiom(axiom);
lint.setSeverity(new Severity(cardinalitySize));
setLint(lint);
}
}
}
class CardinalitySizeCollector extends OWLDeepEntityVisitorAdapter {
private int m_Size;
public void reset() {
m_Size = 0;
}
public int getCardinalitySize() {
return m_Size;
}
public void visit(OWLObjectExactCardinality card) {
process(card);
super.visit(card);
}
public void visit(OWLObjectMaxCardinality card) {
process(card);
super.visit(card);
}
public void visit(OWLObjectMinCardinality card) {
process(card);
super.visit(card);
}
protected void process(OWLObjectCardinalityRestriction card) {
int size = card.getCardinality();
if (size > m_Size) {
m_Size = size;
}
}
}