org.protege.owl.codegeneration.property.JavaObjectPropertyDeclaration 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 static org.protege.owl.codegeneration.SubstitutionVariable.PROPERTY_RANGE;
import static org.protege.owl.codegeneration.SubstitutionVariable.PROPERTY_RANGE_IMPLEMENTATION;

import java.util.Map;

import org.protege.owl.codegeneration.Constants;
import org.protege.owl.codegeneration.SubstitutionVariable;
import org.protege.owl.codegeneration.inference.CodeGenerationInference;
import org.protege.owl.codegeneration.names.CodeGenerationNames;
import org.semanticweb.owlapi.model.OWLClass;
import org.semanticweb.owlapi.model.OWLObjectProperty;

/**
 * This class represents the following java methods that are associated with an OWL object property:
 *  *     Collection get${OwlProperty}();
 *     boolean has${OwlProperty}();
 *     void add${OwlProperty}(${propertyRange} new${OwlProperty});
 *     void remove${OwlProperty}(${propertyRange} old${OwlProperty});
 * 
 * Note that these methods do not get specialized as we move to subclasses.
 * 
 * @author tredmond
 */
public class JavaObjectPropertyDeclaration implements JavaPropertyDeclaration {
	private CodeGenerationInference inference;
	private CodeGenerationNames names;
	private OWLObjectProperty property;
	
	public JavaObjectPropertyDeclaration(CodeGenerationInference inference, CodeGenerationNames names, 
			                              OWLObjectProperty property) {
		this.inference = inference;
		this.names     = names;
		this.property  = property;
	}
	
	public OWLObjectProperty getOwlProperty() {
		return property;
	}

	public JavaPropertyDeclaration specializeTo(OWLClass subclass) {
		return this; // no specialization is done...
	}

	public void configureSubstitutions(Map substitutions) {
        substitutions.put(PROPERTY_RANGE_IMPLEMENTATION, getObjectPropertyRange(false));
        substitutions.put(PROPERTY_RANGE, getObjectPropertyRange(true));
	}

	private String getObjectPropertyRange(boolean isInterface) {
		OWLClass range = inference.getRange(property);
		if (range == null || !inference.getOwlClasses().contains(range)) {
			return isInterface ? Constants.UKNOWN_CODE_GENERATED_INTERFACE : Constants.ABSTRACT_CODE_GENERATOR_INDIVIDUAL_CLASS;
		}
		return isInterface ? names.getInterfaceName(range) : names.getImplementationName(range);
	}
}