org.semanticweb.elk.reasoner.taxonomy.impl.AbstractUpdateableGenericInstanceTaxonomy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elk-reasoner Show documentation
Show all versions of elk-reasoner Show documentation
The core ELK Reasoner package
/*
* #%L
* ELK Reasoner
* $Id:$
* $HeadURL:$
* %%
* Copyright (C) 2011 - 2016 Department of Computer Science, University of Oxford
* %%
* 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%
*/
package org.semanticweb.elk.reasoner.taxonomy.impl;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import org.semanticweb.elk.owl.interfaces.ElkEntity;
import org.semanticweb.elk.reasoner.taxonomy.hashing.InstanceTaxonomyEqualator;
import org.semanticweb.elk.reasoner.taxonomy.hashing.InstanceTaxonomyHasher;
import org.semanticweb.elk.reasoner.taxonomy.model.ComparatorKeyProvider;
import org.semanticweb.elk.reasoner.taxonomy.model.GenericInstanceNode;
import org.semanticweb.elk.reasoner.taxonomy.model.GenericTypeNode;
import org.semanticweb.elk.reasoner.taxonomy.model.InstanceNode;
import org.semanticweb.elk.reasoner.taxonomy.model.InstanceTaxonomy;
import org.semanticweb.elk.reasoner.taxonomy.model.NodeFactory;
import org.semanticweb.elk.reasoner.taxonomy.model.NodeStore;
import org.semanticweb.elk.reasoner.taxonomy.model.Taxonomy;
import org.semanticweb.elk.reasoner.taxonomy.model.TaxonomyNodeFactory;
import org.semanticweb.elk.reasoner.taxonomy.model.TypeNode;
import org.semanticweb.elk.reasoner.taxonomy.model.UpdateableInstanceTaxonomy;
import org.semanticweb.elk.util.collections.LazySetUnion;
/**
* A generic implementation of instance taxonomy that extends an implementation
* of class taxonomy.
*
* @author Peter Skocovsky
*
* @param
* The type of members of the type nodes in this taxonomy.
* @param
* The type of members of the instance nodes in this taxonomy.
* @param
* The immutable type of type nodes in this taxonomy.
* @param
* The immutable type of instance nodes in this taxonomy.
* @param
* The mutable type of type nodes in this taxonomy.
* @param
* The mutable type of instance nodes in this taxonomy.
*/
public abstract class AbstractUpdateableGenericInstanceTaxonomy, IN extends GenericInstanceNode, UTN extends UpdateableTaxonomyTypeNode, UIN extends UpdateableInstanceNode>
extends AbstractUpdateableGenericTaxonomy
implements UpdateableInstanceTaxonomy {
/** Factory that creates instance nodes. */
private final NodeFactory instanceNodeFactory_;
/** The store containing instance nodes of this taxonomy. */
protected final UpdateableNodeStore instanceNodeStore_;
/** The listeners notified about the changes to instance taxonomy. */
protected final List> instanceListeners_;
/**
* Constructor.
*
* @param typeNodeStore
* Node store for the type nodes.
* @param typeNodeFactory
* Factory that creates type nodes.
* @param instanceNodeStore
* Node store for the instance nodes.
* @param instanceNodeFactory
* Factory that creates instance nodes.
* @param topMember
* The canonical member of the top node.
*/
public AbstractUpdateableGenericInstanceTaxonomy(
final UpdateableNodeStore typeNodeStore,
final TaxonomyNodeFactory> typeNodeFactory,
final UpdateableNodeStore instanceNodeStore,
final TaxonomyNodeFactory> instanceNodeFactory,
final T topMember) {
super(typeNodeStore, typeNodeFactory, topMember);
this.instanceNodeStore_ = instanceNodeStore;
this.instanceNodeFactory_ = new NodeFactory() {
@Override
public UIN createNode(final Iterable members,
final int size) {
return instanceNodeFactory.createNode(members, size,
AbstractUpdateableGenericInstanceTaxonomy.this);
}
};
this.instanceListeners_ = new ArrayList>();
}
@Override
public ComparatorKeyProvider getInstanceKeyProvider() {
return instanceNodeStore_.getKeyProvider();
}
@Override
public InstanceNode getInstanceNode(final I elkEntity) {
return instanceNodeStore_.getNode(elkEntity);
}
@Override
public Set> getInstanceNodes() {
return instanceNodeStore_.getNodes();
}
@Override
public TypeNode getNode(final T elkEntity) {
TypeNode result = nodeStore_.getNode(elkEntity);
if (result == null && getBottomNode().contains(elkEntity)) {
result = getBottomNode();
}
return result;
}
@Override
public Set> getNodes() {
return new LazySetUnion>(nodeStore_.getNodes(),
Collections.singleton(getBottomNode()));
}
@Override
public abstract TN getBottomNode();
@Override
public InstanceNode getCreateInstanceNode(
final Collection instances) {
return instanceNodeStore_.getCreateNode(instances, instances.size(),
instanceNodeFactory_);
}
@Override
public boolean setCreateDirectTypes(final InstanceNode instanceNode,
final Iterable> typeSets) {
final UIN node = toInternalInstanceNode(instanceNode);
boolean isTypeSetsEmpty = true;
for (final Collection superMembers : typeSets) {
final UTN superNode = getCreateNode(superMembers);
isTypeSetsEmpty = false;
addDirectType(superNode, node);
}
if (node.trySetAllParentsAssigned(true)) {
if (!isTypeSetsEmpty) {
fireDirectTypeAssignment(instanceNode,
instanceNode.getDirectTypeNodes());
}
return true;
}
// else
return false;
}
private void addDirectType(final UTN typeNode, final UIN instanceNode) {
instanceNode.addDirectTypeNode(typeNode);
typeNode.addDirectInstanceNode(instanceNode);
}
@Override
public boolean removeDirectTypes(final InstanceNode instanceNode) {
final UIN node = toInternalInstanceNode(instanceNode);
if (!node.trySetAllParentsAssigned(false)) {
return false;
}
final List directTypes = new ArrayList();
synchronized (node) {
directTypes.addAll(node.getDirectNonBottomTypeNodes());
for (final UTN typeNode : directTypes) {
node.removeDirectTypeNode(typeNode);
}
}
// detaching the removed instance node from all its direct types
for (final UTN typeNode : directTypes) {
synchronized (typeNode) {
typeNode.removeDirectInstanceNode(node);
}
}
fireDirectTypeRemoval(instanceNode, directTypes);
return true;
}
@Override
public boolean removeInstanceNode(final I instance) {
return instanceNodeStore_.removeNode(instance);
}
@SuppressWarnings("unchecked")
protected UIN toInternalInstanceNode(final InstanceNode node) {
if (node.getTaxonomy() != this) {
throw new IllegalArgumentException(
"The sub-node must belong to this taxonomy: " + node);
}
// By construction, if the node is in this taxonomy, it is of type N.
try {
return (UIN) node;
} catch (final ClassCastException e) {
throw new IllegalArgumentException(
"The sub-node must belong to this taxonomy: " + node);
}
}
@Override
public int hashCode() {
return InstanceTaxonomyHasher.hash(this);
}
@SuppressWarnings("unchecked")
@Override
public boolean equals(final Object obj) {
if (!(obj instanceof Taxonomy)) {
return false;
}
try {
return InstanceTaxonomyEqualator.equals(this, (Taxonomy) obj);
} catch (ClassCastException e) {
return false;
}
}
@Override
public boolean addInstanceListener(final NodeStore.Listener listener) {
return instanceNodeStore_.addListener(listener);
}
@Override
public boolean removeInstanceListener(
final NodeStore.Listener listener) {
return instanceNodeStore_.removeListener(listener);
}
@Override
public boolean addInstanceListener(
final InstanceTaxonomy.Listener listener) {
return instanceListeners_.add(listener);
}
@Override
public boolean removeInstanceListener(
final InstanceTaxonomy.Listener listener) {
return instanceListeners_.remove(listener);
}
protected void fireDirectTypeAssignment(
final InstanceNode instanceNode,
final Collection> typeNodes) {
for (final InstanceTaxonomy.Listener listener : instanceListeners_) {
listener.directTypeNodesAppeared(instanceNode);
for (final TypeNode typeNode : typeNodes) {
listener.directInstanceNodesAppeared(typeNode);
}
}
}
protected void fireDirectTypeRemoval(final InstanceNode instanceNode,
final Collection> typeNodes) {
for (final InstanceTaxonomy.Listener listener : instanceListeners_) {
listener.directTypeNodesDisappeared(instanceNode);
for (final TypeNode typeNode : typeNodes) {
listener.directInstanceNodesDisappeared(typeNode);
}
}
}
}