org.protege.owl.codegeneration.property.JavaPropertyDeclaration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of code-generation Show documentation

Generate Java code from an OWL ontology in the Protege Desktop editing environment.

The newest version!

package org.protege.owl.codegeneration.property;

import java.util.Map;

import org.protege.owl.codegeneration.SubstitutionVariable;
import org.semanticweb.owlapi.model.OWLClass;
import org.semanticweb.owlapi.model.OWLEntity;

/**
 * This class is a representation of the interface and implementation methods that will be 
 * generated for a particular property.  The reason that it became necessary to write this class is
 * that there appears to be a fundamental conflict between OWL ontologies and the generated java code.
 * In the java code if
 * 
 *  A class or interface X has a method m,
 * 
 A class or interface Y extends/implements the class X
 * 
 * then it must be true that the class or interface Y has a method that specializes the method m.
 * 
 * Most of the obvious ways of determining the way that the declarations for a java class corresponding to an
 * OWL class do not satisfy this criterion.  For example, one might think that a java interface corresponding to an
 * OWL class, A, should have methods corresponding to any property that has A as a domain.  Unfortunately this 
 * definition can violate the requirements above.  In addition the java notion of specializes does not always correspond
 * to the natural ways of specializing that would come from an OWL ontology.
 * 
 * @author tredmond
 *
 */
public interface JavaPropertyDeclaration {

	OWLEntity getOwlProperty();
	
	JavaPropertyDeclaration specializeTo(OWLClass subclass);
	
	void configureSubstitutions(Map substitutions);	
}