OWLVisitorForRestrictionData.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: OWLVisitorForRestrictionData.java
 * Description: Class collect information about restrictions
 */

/**
 * @file OWLVisitorForRestrictionData.java
 *
 * @brief Class collect information about restrictions
 */

package cz.vutbr.fit.knot.annotations.web;

import java.util.HashSet;
import java.util.Set;
import org.semanticweb.owlapi.model.OWLAxiom;
import org.semanticweb.owlapi.model.OWLClass;
import org.semanticweb.owlapi.model.OWLIndividual;
import org.semanticweb.owlapi.model.OWLObjectAllValuesFrom;
import org.semanticweb.owlapi.model.OWLObjectExactCardinality;
import org.semanticweb.owlapi.model.OWLObjectHasSelf;
import org.semanticweb.owlapi.model.OWLObjectHasValue;
import org.semanticweb.owlapi.model.OWLObjectMaxCardinality;
import org.semanticweb.owlapi.model.OWLObjectMinCardinality;
import org.semanticweb.owlapi.model.OWLObjectProperty;
import org.semanticweb.owlapi.model.OWLObjectSomeValuesFrom;
import org.semanticweb.owlapi.util.OWLOntologyWalker;
import org.semanticweb.owlapi.util.OWLOntologyWalkerVisitor;

/**
 * Class collect information about restrictions
 * 
 * @brief Class collect information about restrictions
 * @author Marek Kopecky
 */
class OWLVisitorForRestrictionData extends OWLOntologyWalkerVisitor<Object> {
  
  /**
   * Data class for cardinality restriction
   * Ontology axims are stored here for further processing
   * 
   * @brief Data class for cardinality restriction
   * @author Marek Kopecky
   */
  public static class CardinalityData {
    public int cardinality;
    public String propertyURI;
    public String classURI;
    public CardinalityData(int cardinality, String propertyURI, String classURI) {
      this.cardinality = cardinality;
      this.propertyURI = propertyURI;
      this.classURI = classURI;
    }
  }
  
  
  /**
   * Data class for someValueFrom and allValueFrom restriction
   * Ontology axims are stored here for further processing
   * 
   * @brief Data class for someValueFrom and allValueFrom restriction
   * @author Marek Kopecky
   */
  public static class ValueData {
    public String valueURI;
    public String propertyURI;
    public String classURI;
    public ValueData(String valueURI, String propertyURI, String classURI) {
      this.valueURI = valueURI;
      this.propertyURI = propertyURI;
      this.classURI = classURI;
    }
  }
  
  /**
   * Data class for hasValue restriction
   * Ontology axims are stored here for further processing
   * 
   * @brief Data class for hasValue restriction
   * @author Marek Kopecky
   */
  public static class HasValueData extends OWLVisitorForRestrictionData.ValueData {
    public OWLIndividual individual;
    public HasValueData(OWLIndividual individual, String propertyURI, String classURI) {
      super(individual.toStringID(), propertyURI, classURI);
      this.individual = individual;
    }
  }
  
  /**
   * Set of minCardinality data
   */
  Set<OWLVisitorForRestrictionData.CardinalityData> minCardinalityData;
  /**
   * Set of maxCardinality data
   */
  Set<OWLVisitorForRestrictionData.CardinalityData> maxCardinalityData;
  /**
   * Set of cardinality data
   */
  Set<OWLVisitorForRestrictionData.CardinalityData> cardinalityData;
  /**
   * Set of hasValue data
   */
  Set<OWLVisitorForRestrictionData.HasValueData> hasValueData;
  /**
   * Set of self data
   */
  Set<OWLVisitorForRestrictionData.ValueData> hasSelfData;
  /**
   * Set of someValuesFrom data
   */
  Set<OWLVisitorForRestrictionData.ValueData> someValuesFromData;
  /**
   * Set of allValuesFrom data
   */
  Set<OWLVisitorForRestrictionData.ValueData> allValuesFromData;
  
  /**
   * Initialize data structures.
   * @param walker Important for super-class constructor.
   */
  public OWLVisitorForRestrictionData(OWLOntologyWalker walker) {
    super(walker);
    minCardinalityData = new HashSet<OWLVisitorForRestrictionData.CardinalityData>();
    maxCardinalityData = new HashSet<OWLVisitorForRestrictionData.CardinalityData>();
    cardinalityData = new HashSet<OWLVisitorForRestrictionData.CardinalityData>();
    hasValueData = new HashSet<OWLVisitorForRestrictionData.HasValueData>();
    hasSelfData = new HashSet<OWLVisitorForRestrictionData.ValueData>();
    someValuesFromData = new HashSet<OWLVisitorForRestrictionData.ValueData>();
    allValuesFromData = new HashSet<OWLVisitorForRestrictionData.ValueData>();
  }
  
  
  /**
   * Gets minCardinality data
   * 
   * @return MinCardinality data
   */
  public Set<OWLVisitorForRestrictionData.CardinalityData> getMinCardinalityData() {
    return minCardinalityData;
  }
  
  /**
   * Gets maxCardinality data
   * 
   * @return MaxCardinality data
   */
  public Set<OWLVisitorForRestrictionData.CardinalityData> getMaxCardinalityData() {
    return maxCardinalityData;
  }
  
  /**
   * Gets cardinality data
   * 
   * @return Cardinality data
   */
  public Set<OWLVisitorForRestrictionData.CardinalityData> getCardinalityData() {
    return cardinalityData;
  }
  
  /**
   * Gets hasValue data
   * 
   * @return HasValue data
   */
  public Set<OWLVisitorForRestrictionData.HasValueData> getHasValueData() {
    return hasValueData;
  }
  
  /**
   * Gets hasSelf data
   * 
   * @return HasSelf data
   */
  public Set<OWLVisitorForRestrictionData.ValueData> getHasSelfData() {
    return hasSelfData;
  }
  
  /**
   * Get someValuesFrom data
   * 
   * @return SomeValuesFrom data
   */
  public Set<OWLVisitorForRestrictionData.ValueData> getSomeValuesFromData() {
    return someValuesFromData;
  }
  
  /**
   * Get allValuesFrom data
   * 
   * @return AllValuesFrom data
   */
  public Set<OWLVisitorForRestrictionData.ValueData> getAllValuesFromData() {
    return allValuesFromData;
  }
  
  /**
   * Determine, if string value represent number.
   * @param value string value
   * @return true, if value represent number, else false
   */
  public static boolean tryParseInt(String value)  
  {  
    if (value == null) {
      return false;
    }
    try {  
      Integer.parseInt(value);  
      return true;  
    } catch (NumberFormatException e) {  
      return false;  
    }  
  }
  
  /**
   * Determine, if uri represent anonymous class.
   * @param uri OWL Class uri.
   * @return true, if uri represent anonymous class
   */
  private boolean errorClassDetection(String uri) {
    String name = UploadOntology.getNameFromURI(uri);
    if (!name.startsWith("Error")) {
      return false;
    }
    String errorNumber = name.substring(5, name.length());
    return tryParseInt(errorNumber);
  }
  
  // <editor-fold defaultstate="collapsed" desc="MinCardinality">
  /**
   * Get information about MinCardinality restriction.
   * @param desc MinCardinality information.
   * @return Nothing, because this function is called by OWLOntologyWalker. 
   */
  @Override
  public Object visit(OWLObjectMinCardinality desc) {
    OWLAxiom axiom = getCurrentAxiom(); // get axiom
    Set<OWLObjectProperty> properties = axiom.getObjectPropertiesInSignature(); // get properties set
    if (properties.isEmpty()) { // undefined property
      return null;
    }
    OWLClass subjectClass = null;
    boolean subjectClassFound = false;
    for (OWLClass cls : axiom.getClassesInSignature()) {
        if (!cls.isOWLThing()) {
            subjectClassFound = true;
            subjectClass = cls;
            break;
        }
    }
    if (!subjectClassFound) { // subject wasn't found
        return null;
    }
    OWLVisitorForRestrictionData.CardinalityData data = new OWLVisitorForRestrictionData.CardinalityData(desc.getCardinality(), properties.iterator().next().toStringID(), subjectClass.toStringID());
    minCardinalityData.add(data);
    // We don't need to return anything here.
    return null;
  }
  // </editor-fold>

  // <editor-fold defaultstate="collapsed" desc="MaxCardinality">
  /**
   * Get information about MaxCardinality restriction.
   * @param desc MaxCardinality information.
   * @return Nothing, because this function is called by OWLOntologyWalker. 
   */
  @Override
  public Object visit(OWLObjectMaxCardinality desc) {
    OWLAxiom axiom = getCurrentAxiom(); // get axiom
    Set<OWLObjectProperty> properties = axiom.getObjectPropertiesInSignature(); // get properties set
    if (properties.isEmpty()) { // undefined property
      return null;
    }
    OWLClass subjectClass = null;
    boolean subjectClassFound = false;
    for (OWLClass cls : axiom.getClassesInSignature()) {
        if (!cls.isOWLThing()) {
            subjectClassFound = true;
            subjectClass = cls;
            break;
        }
    }
    if (!subjectClassFound) { // subject wasn't found
        return null;
    }
    OWLVisitorForRestrictionData.CardinalityData data = new OWLVisitorForRestrictionData.CardinalityData(desc.getCardinality(), properties.iterator().next().toStringID(), subjectClass.toStringID());
    maxCardinalityData.add(data);
    // We don't need to return anything here.
    return null;
  }
  // </editor-fold>

  // <editor-fold defaultstate="collapsed" desc="ExactCardinality">
  /**
   * Get information about ExactCardinality restriction.
   * @param desc ExactCardinality information.
   * @return Nothing, because this function is called by OWLOntologyWalker. 
   */
  @Override
  public Object visit(OWLObjectExactCardinality desc) {
    OWLAxiom axiom = getCurrentAxiom(); // get axiom
    Set<OWLObjectProperty> properties = axiom.getObjectPropertiesInSignature(); // get properties set
    if (properties.isEmpty()) { // undefined property
      return null;
    }
    OWLClass subjectClass = null;
    boolean subjectClassFound = false;
    for (OWLClass cls : axiom.getClassesInSignature()) {
        if (!cls.isOWLThing()) {
            subjectClassFound = true;
            subjectClass = cls;
            break;
        }
    }
    if (!subjectClassFound) { // subject wasn't found
        return null;
    }
    OWLVisitorForRestrictionData.CardinalityData data = new OWLVisitorForRestrictionData.CardinalityData(desc.getCardinality(), properties.iterator().next().toStringID(), subjectClass.toStringID());
    cardinalityData.add(data);
    // We don't need to return anything here.
    return null;
  }
  // </editor-fold>

  // <editor-fold defaultstate="collapsed" desc="hasValue">
  /**
   * Get information about HasValue restriction.
   * @param desc HasValue information.
   * @return Nothing, because this function is called by OWLOntologyWalker. 
   */
  @Override
  public Object visit(OWLObjectHasValue desc) {
    OWLAxiom axiom = getCurrentAxiom(); // get axiom
    Set<OWLObjectProperty> properties = axiom.getObjectPropertiesInSignature(); // get properties set
    if (properties.isEmpty()) { // undefined property
      return null;
    }
    OWLClass subjectClass = null;
    boolean subjectClassFound = false;
    for (OWLClass cls : axiom.getClassesInSignature()) {
        if (!cls.isOWLThing()) {
            subjectClassFound = true;
            subjectClass = cls;
            break;
        }
    }
    if (!subjectClassFound) { // subject wasn't found
        return null;
    }
    OWLVisitorForRestrictionData.HasValueData data = new OWLVisitorForRestrictionData.HasValueData(desc.getValue(), properties.iterator().next().toStringID(), subjectClass.toStringID());
    hasValueData.add(data);
    // We don't need to return anything here.
    return null;
  }
  // </editor-fold>

  // <editor-fold defaultstate="collapsed" desc="hasSelf">
  /**
   * Get information about HasSelf restriction.
   * @param desc Base information about restriction.
   * @return Nothing, because this function is called by OWLOntologyWalker. 
   */
  @Override
  public Object visit(OWLObjectHasSelf desc) {
    OWLAxiom axiom = getCurrentAxiom(); // get axiom
    Set<OWLObjectProperty> properties = axiom.getObjectPropertiesInSignature(); // get properties set
    if (properties.isEmpty()) { // undefined property
      return null;
    }
    desc.isDataRestriction();
    OWLClass subjectClass = null;
    boolean subjectClassFound = false;
    for (OWLClass cls : axiom.getClassesInSignature()) {
        if (!cls.isOWLThing()) {
            subjectClassFound = true;
            subjectClass = cls;
            break;
        }
    }
    if (!subjectClassFound) { // subject wasn't found
        return null;
    }
    OWLVisitorForRestrictionData.ValueData data = new OWLVisitorForRestrictionData.ValueData("", properties.iterator().next().toStringID(), subjectClass.toStringID());
    hasSelfData.add(data);
    // We don't need to return anything here.
    return null;
  }
  // </editor-fold>

  // <editor-fold defaultstate="collapsed" desc="someValuesFrom">
  /**
   * Get information about SomeValuesFrom restriction.
   * @param desc SomeValuesFrom information.
   * @return Nothing, because this function is called by OWLOntologyWalker. 
   */
  @Override
  public Object visit(OWLObjectSomeValuesFrom desc) {
    try {
      OWLAxiom axiom = getCurrentAxiom(); // get axiom
      Set<OWLObjectProperty> properties = axiom.getObjectPropertiesInSignature(); // get properties set
      if (properties.isEmpty()) { // undefined property
        return null;
      }
      OWLClass subjectClass = null;
      boolean subjectClassFound = false;
      for (OWLClass cls : axiom.getClassesInSignature()) {
          if (!cls.isOWLThing() && !cls.toStringID().equals(desc.getFiller().asOWLClass().toStringID())) {
              subjectClassFound = true;
              subjectClass = cls;
              break;
          }
      }
      if (!subjectClassFound) { // subject wasn't found, was skipped, because subject is object too
        subjectClassFound = true;
        subjectClass = desc.getFiller().asOWLClass();
      }
      if (errorClassDetection(desc.getFiller().asOWLClass().toStringID())) {
        return null;
      }
      OWLVisitorForRestrictionData.ValueData data = new OWLVisitorForRestrictionData.ValueData(desc.getFiller().asOWLClass().toStringID(), properties.iterator().next().toStringID(), subjectClass.toStringID());
      someValuesFromData.add(data);
    } catch (Exception e) {}
    // We don't need to return anything here.
    return null;
  }
  // </editor-fold>
    
  // <editor-fold defaultstate="collapsed" desc="allValuesFrom">
  /**
   * Get information about AllValuesFrom restriction.
   * @param desc AllValuesFrom information.
   * @return Nothing, because this function is called by OWLOntologyWalker. 
   */
  @Override
  public Object visit(OWLObjectAllValuesFrom desc) {
    try {
      OWLAxiom axiom = getCurrentAxiom(); // get axiom
      Set<OWLObjectProperty> properties = axiom.getObjectPropertiesInSignature(); // get properties set
      if (properties.isEmpty()) { // undefined property
        return null;
      }
      OWLClass subjectClass = null;
      boolean subjectClassFound = false;
      for (OWLClass cls : axiom.getClassesInSignature()) {
          if (!cls.isOWLThing() && !cls.toStringID().equals(desc.getFiller().asOWLClass().toStringID())) {
              subjectClassFound = true;
              subjectClass = cls;
              break;
          }
      }
      if (!subjectClassFound) { // subject wasn't found, was skipped, because subject is object too
        subjectClassFound = true;
        subjectClass = desc.getFiller().asOWLClass();
      }
      if (errorClassDetection(desc.getFiller().asOWLClass().toStringID())) {
        return null;
      }
      OWLVisitorForRestrictionData.ValueData data = new OWLVisitorForRestrictionData.ValueData(desc.getFiller().asOWLClass().toStringID(), properties.iterator().next().toStringID(), subjectClass.toStringID());
      allValuesFromData.add(data);
    } catch (Exception e) {}
    // We don't need to return anything here.
    return null;
  }
  // </editor-fold>
}