io.mindmaps.migration.owl.Namer Maven / Gradle / Ivy

Go to download
/*
 * MindmapsDB - A Distributed Semantic Database
 * Copyright (C) 2016  Mindmaps Research Ltd
 *
 * MindmapsDB 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.
 *
 * MindmapsDB 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 MindmapsDB. If not, see .
 */
package io.mindmaps.migration.owl;

import org.semanticweb.owlapi.model.IRI;

import io.mindmaps.concept.Entity;
import io.mindmaps.concept.ResourceType;

/**
 * 
 * A Namer provides functions to generate Mindmaps ontology names (IDs for
 * types, relations, roles etc.) from OWL ontology elements. All methods have default
 * implementations.
 * 
 * 
 * The implementation is not configurable: future work may provide for configuring prefixes, 
 * or some mapping schema from OWL to MM prefixes, including the standard OWL/RDF prefixes
 * etc. Such mapping schema should be based on some practical experience with the migration tool.
 * 
 * @author borislav
 *
 */
public interface Namer {
    /**
     * Create and return a name from a full IRI. By default this is just the fragment (the part after the '#'
     * sign in an IRI).
     */
    default String fromIri(IRI iri) {
        return iri.getShortForm();      
    }
    /**
     * @see {{@link #fromIri(IRI)}
     */
    default String fromIri(String iriAsString) {
        return fromIri(IRI.create(iriAsString));
    }
    /**
     * Generate the name of a MM entity from the IRI of an OWL individual
     */
    default String individualEntityName(IRI individualIri) {
        return "e" + fromIri(individualIri);
    }
    /**
     * Generate the name of a MM entity type from the IRI of an OWL class
     */
    default String classEntityTypeName(IRI classIri) {
        return "t" + fromIri(classIri);
    }
    /**
     * Generate the name of a MM relation type from the IRI of an OWL object property
     */
    default String objectPropertyName(IRI propIri) {
        return "op-" + fromIri(propIri);
    }
    /**
     * Make a name/id for the Mindmaps RelationType representing
     * a relation b/w an entity (OWL individual) and its resource (the OWL data property)
     */
    default String resourceRelation(IRI dataPropertyIRI) {
        return "has-" + dataPropertyIRI.getShortForm();
    }
    /**
     * Make a name for the role type corresponding to the object (i.e. range) of an OWL object
     * property.
     *  
     * @param relationId The id of the Mindmaps RelationType.
     */
    default String objectRole(String relationId) {
        return OwlModel.OBJECT.owlname() + "-" + relationId;
    }
    /**
     * Make a name for the role type corresponding to the subject (i.e. domain) of an OWL object
     * property.
     *  
     * @param relationId The id of the Mindmaps RelationType.
     */
    default String subjectRole(String relationId) {
        return OwlModel.SUBJECT.owlname() + "-" + relationId;
    }
    /**
     * The name of the entity role type in an entity-role relation representing an OWL data property
     */
    default String entityRole(String resourceId) {
        return "has-" + resourceId + "-owner";
    }
    /**
     * Make a name for a resource role player representing the value of an OWL data property.
     */
    default String resourceRole(String resourceId) {
        return "has-" + resourceId + "-value";
    }
    /**
     * Make an identifier for a resource of a given type to be associated with a given entity.
     */
    default String resourceId(Entity entity, ResourceType resourceType) {
        return "resource-" + resourceType.getId() + "-" + entity.getId();
    }   
}