io.konig.core.showl.ShowlClass Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of konig-core Show documentation
A library for core classes (Graph, Vertex, Edge, etc.)
There is a newer version: 2.11.0
package io.konig.core.showl;

/*
 * #%L
 * Konig Core
 * %%
 * Copyright (C) 2015 - 2018 Gregory McFall
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */


import java.util.HashSet;
import java.util.Set;

import org.openrdf.model.URI;
import org.openrdf.model.Value;

import io.konig.core.Graph;
import io.konig.core.OwlReasoner;
import io.konig.core.Vertex;
import io.konig.core.util.IriTemplate;
import io.konig.core.vocab.Konig;

/**
 * 
 * An OWL Class structure with relationships to (a) Properties that reference the class in the domain or range,
 * (b) superclasses, (c) NodeShapes that have the class as its targetClass.
 * 
 * This is the primary vehicle through which one discovers mappings between properties.
 * 
 */
public class ShowlClass {
	
	private URI owlClassId;
	
	private Set domainOf = new HashSet<>();
	private Set rangeOf = new HashSet<>();
	private Set superClasses = null;
	private IriTemplate iriTemplate;
	private Set targetClassOf = new HashSet<>();
	private OwlReasoner reasoner;
	
	public ShowlClass(OwlReasoner reasoner, URI owlClassId) {
		this.reasoner = reasoner;
		this.owlClassId = owlClassId;
	}

	public URI getId() {
		return owlClassId;
	}
	
	public boolean isSubClassOf(ShowlClass other) {
		return reasoner.isSubClassOf(owlClassId, other.getId());
	}
	
	
	public void addSuperClass(ShowlClass superclass) {
		if (superClasses == null) {
			superClasses = new HashSet<>();
		}
		superClasses.add(superclass);
	}
	
	public Set getSuperClasses() {
		return superClasses;
	}

	public String toString() {
		return "ShowlClass[" + owlClassId.getLocalName() + "]";
	}
	
	public Set getRangeOf() {
		return rangeOf;
	}
	
	public void addRangeOf(ShowlProperty p) {
		rangeOf.add(p);
	}
	
	public Set getDomainOf() {
		return domainOf;
	}
	
	public void addDomainOf(ShowlProperty p) {
		domainOf.add(p);
	}
	
	public void addTargetClassOf(ShowlNodeShape nodeShape) {
		targetClassOf.add(nodeShape);
	}

	public Set getTargetClassOf() {
		return targetClassOf;
	}

	public IriTemplate getIriTemplate() {
		
		if (iriTemplate == null) {
			Graph graph = reasoner.getGraph();
			Vertex v = graph.getVertex(owlClassId);
			if (v != null) {
				Value value = v.getValue(Konig.iriTemplate);
				if (value != null) {
					iriTemplate = new IriTemplate(value.stringValue());
				}
			}
		}
		
		return iriTemplate;
	}
	
	@Override
	public int hashCode() {
		return owlClassId.hashCode();
	}
	
	@Override
	public boolean equals(Object other) {
		if (other instanceof ShowlClass) {
			ShowlClass peer = (ShowlClass) other;
			return owlClassId.equals(peer.getId());
		}
		return false;
	}

	public boolean isEnum(OwlReasoner owlReasoner) {
		return owlReasoner.isEnumerationClass(getId());
	}
}