julianmendez / jcel

 *

 * Copyright (C) 2009-2017 Julian Mendez

 *

 *

 * This file is part of jcel.

 *

 *

 * The contents of this file are subject to the GNU Lesser General Public License

 * version 3

 *

 *

 * This program is free software: you can redistribute it and/or modify

 * it under the terms of the GNU Lesser General Public License as published by

 * the Free Software Foundation, either version 3 of the License, or

 * (at your option) any later version.

 *

 * This program 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 Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public License

 * along with this program.  If not, see <http://www.gnu.org/licenses/>.

 *

 *

 * Alternatively, the contents of this file may be used under the terms

 * of the Apache License, Version 2.0, in which case the

 * provisions of the Apache License, Version 2.0 are applicable instead of those

 * above.

 *

 *

 * 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.

 *

 */

package de.tudresden.inf.lat.jcel.core.algorithm.rulebased;

import java.io.BufferedWriter;

import java.io.IOException;

import java.io.Writer;

import java.util.Collection;

import java.util.Collections;

import java.util.HashMap;

import java.util.HashSet;

import java.util.NoSuchElementException;

import java.util.Objects;

import java.util.Optional;

import java.util.Set;

import java.util.TreeSet;

import de.tudresden.inf.lat.jcel.core.completion.common.ClassifierStatus;

import de.tudresden.inf.lat.jcel.core.completion.common.REntry;

import de.tudresden.inf.lat.jcel.core.completion.common.SEntry;

import de.tudresden.inf.lat.jcel.core.graph.IntegerRelationMapImpl;

import de.tudresden.inf.lat.jcel.core.graph.IntegerSubsumerBidirectionalGraphImpl;

import de.tudresden.inf.lat.jcel.core.graph.IntegerSubsumerGraphImpl;

import de.tudresden.inf.lat.jcel.core.graph.VNode;

import de.tudresden.inf.lat.jcel.core.graph.VNodeImpl;

import de.tudresden.inf.lat.jcel.coreontology.axiom.ExtendedOntology;

import de.tudresden.inf.lat.jcel.coreontology.axiom.RI2Axiom;

import de.tudresden.inf.lat.jcel.coreontology.datatype.IntegerEntityManager;

import de.tudresden.inf.lat.jcel.coreontology.datatype.IntegerEntityType;

import de.tudresden.inf.lat.util.map.OptMap;

import de.tudresden.inf.lat.util.map.OptMapImpl;

/**

 * An object of this class keeps the status of the classifier.

 * 

 * @author Julian Mendez

 */

public class ClassifierStatusImpl implements ClassifierStatus {

	private static final String COMMA_SEPARATOR = ",";

	private static final int bottomClassId = IntegerEntityManager.bottomClassId;

	private static final int bottomObjectPropertyId = IntegerEntityManager.bottomObjectPropertyId;

	private static final int topClassId = IntegerEntityManager.topClassId;

	private static final int topObjectPropertyId = IntegerEntityManager.topObjectPropertyId;

	private IntegerSubsumerGraphImpl classGraph = null;

	private final OptMap<Integer, Set<Integer>> cognateFunctPropMap = new OptMapImpl<>(new HashMap<>());

	private final ExtendedOntology extendedOntology;

	private IntegerEntityManager entityManager = null;

	private final OptMap<VNodeImpl, Integer> invNodeSet = new OptMapImpl<>(new HashMap<>());

	private final Object monitorClassGraph = new Object();

	private final Object monitorRelationSet = new Object();

	private final Object monitorSetQsubR = new Object();

	private final Object monitorSetQsubS = new Object();

	private final OptMap<Integer, VNodeImpl> nodeSet = new OptMapImpl<>(new HashMap<>());

	private IntegerSubsumerBidirectionalGraphImpl objectPropertyGraph = null;

	private IntegerRelationMapImpl relationSet = null;

	private final Set<REntry> setQsubR = new TreeSet<>();

	private final Set<SEntry> setQsubS = new TreeSet<>();

	/**

	 * Constructs a new classifier status.

	 * 

	 * @param generator

	 *            identifier generator

	 * @param ontology

	 *            extended ontology

	 */

	public ClassifierStatusImpl(IntegerEntityManager generator, ExtendedOntology ontology) {

		Objects.requireNonNull(generator);

		Objects.requireNonNull(ontology);

		this.entityManager = generator;

		this.extendedOntology = ontology;

		createClassGraph();

		createObjectPropertyGraph();

		createRelationSet();

		createSetOfNodes();

		createMapOfObjectPropertiesWithFunctionalAncestor();

	}

	@Override

	public boolean addNewREntry(int propertyId, int leftClassId, int rightClassId) {

		boolean ret = false;

		synchronized (this.monitorSetQsubR) {

			ret = this.setQsubR.add(new REntryImpl(propertyId, leftClassId, rightClassId));

		}

		return ret;

	}

	@Override

	public boolean addNewSEntry(int subClassId, int superClassId) {

		boolean ret = false;

		synchronized (this.monitorSetQsubS) {

			ret = this.setQsubS.add(new SEntryImpl(subClassId, superClassId));

		}

		return ret;

	}

	/**

	 * Adds a new triplet to the set R.

	 * 

	 * @param property

	 *            property

	 * @param leftClass

	 *            left class

	 * @param rightClass

	 *            right class

	 * @return <code>true</code> if the triplet was effectively added,

	 *         <code>false</code> otherwise

	 */

	public boolean addToR(int property, int leftClass, int rightClass) {

		boolean ret = false;

		synchronized (this.monitorRelationSet) {

			ret = this.relationSet.add(property, leftClass, rightClass);

		}

		return ret;

	}

	/**

	 * Adds a new pair to the set S.

	 * 

	 * @param subClass

	 *            sub class

	 * @param superClass

	 *            super class

	 * @return <code>true</code> if the pair was effectively added,

	 *         <code>false</code> otherwise

	 */

	public boolean addToS(int subClass, int superClass) {

		boolean ret = false;

		synchronized (this.monitorClassGraph) {

			ret = this.classGraph.addAncestor(subClass, superClass);

		}

		return ret;

	}

	@Override

	public boolean contains(VNode node) {

		Objects.requireNonNull(node);

		boolean ret = false;

		if (node instanceof VNodeImpl) {

			ret = this.invNodeSet.get((VNodeImpl) node).isPresent();

		}

		return ret;

	}

	private void createClassGraph() {

		synchronized (this.monitorClassGraph) {

			this.classGraph = new IntegerSubsumerGraphImpl(bottomClassId, topClassId);

		}

		this.nodeSet.clear();

		this.invNodeSet.clear();

		getExtendedOntology().getClassSet().forEach(elem -> {

			VNodeImpl node = new VNodeImpl(elem);

			this.nodeSet.put(elem, node);

			this.invNodeSet.put(node, elem);

		});

	}

	private void createMapOfObjectPropertiesWithFunctionalAncestor() {

		this.extendedOntology.getFunctionalObjectProperties().forEach(s -> {

			Collection<Integer> cognates = getSubObjectProperties(s);

			cognates.forEach(r -> {

				Optional<Set<Integer>> optCurrentSet = this.cognateFunctPropMap.get(r);

				if (!optCurrentSet.isPresent()) {

					optCurrentSet = Optional.of(new HashSet<>());

					this.cognateFunctPropMap.put(r, optCurrentSet.get());

				}

				optCurrentSet.get().addAll(cognates);

			});

		});

	}

	private void createObjectPropertyGraph() {

		this.objectPropertyGraph = new IntegerSubsumerBidirectionalGraphImpl(bottomObjectPropertyId,

				topObjectPropertyId);

		this.extendedOntology.getObjectPropertySet().forEach(index -> {

			this.objectPropertyGraph.addAncestor(index, topObjectPropertyId);

			int inverseProp = this.entityManager.createOrGetInverseObjectPropertyOf(index);

			this.objectPropertyGraph.addAncestor(inverseProp, topObjectPropertyId);

		});

		this.extendedOntology.getObjectPropertySet().forEach(property -> {

			Set<RI2Axiom> axiomSet = this.extendedOntology.getRI2rAxioms(property);

			axiomSet.forEach(

					axiom -> this.objectPropertyGraph.addAncestor(axiom.getSubProperty(), axiom.getSuperProperty()));

		});

		makeTransitiveClosure(this.objectPropertyGraph);

	}

	@Override

	public int createOrGetNodeId(VNode node) {

		Objects.requireNonNull(node);

		Optional<Integer> optNodeId = Optional.empty();

		if (node instanceof VNodeImpl) {

			optNodeId = this.invNodeSet.get((VNodeImpl) node);

		}

		if (!optNodeId.isPresent()) {

			optNodeId = Optional.of(node.getClassId());

			if (!node.isEmpty()) {

				optNodeId = Optional.of(getIdGenerator().createAnonymousEntity(IntegerEntityType.CLASS, true));

				VNodeImpl newNode = new VNodeImpl(node.getClassId());

				newNode.addExistentialsOf(node);

				this.nodeSet.put(optNodeId.get(), newNode);

				this.invNodeSet.put(newNode, optNodeId.get());

			}

		}

		return optNodeId.get();

	}

	private void createRelationSet() {

		Collection<Integer> collection = getObjectPropertyGraph().getElements();

		synchronized (this.monitorRelationSet) {

			this.relationSet = new IntegerRelationMapImpl();

			collection.forEach(index -> this.relationSet.add(index));

		}

	}

	private void createSetOfNodes() {

		getExtendedOntology().getClassSet().forEach(classId -> createOrGetNodeId(new VNodeImpl(classId)));

	}

	/**

	 * Deletes the class graph.

	 */

	protected void deleteClassGraph() {

		synchronized (this.monitorClassGraph) {

			this.classGraph = null;

		}

	}

	/**

	 * Deletes the object property graph.

	 */

	protected void deleteObjectPropertyGraph() {

		this.objectPropertyGraph = null;

	}

	/**

	 * Returns the class graph.

	 * 

	 * @return the class graph

	 */

	protected IntegerSubsumerGraphImpl getClassGraph() {

		return this.classGraph;

	}

	@Override

	public Object getClassGraphMonitor() {

		return this.monitorClassGraph;

	}

	/**

	 * Returns the number of nodes in the relation set.

	 * 

	 * @return the number of nodes in the relation set

	 */

	public long getDeepSizeOfR() {

		long ret;

		synchronized (this.monitorRelationSet) {

			ret = this.relationSet.getDeepSize();

		}

		return ret;

	}

	/**

	 * Returns the number of nodes in the subsumer set.

	 * 

	 * @return the number of nodes in the subsumer set

	 */

	public long getDeepSizeOfS() {

		long ret;

		synchronized (this.monitorClassGraph) {

			ret = this.classGraph.getDeepSize();

		}

		return ret;

	}

	/**

	 * Returns the number of elements in the node set.

	 * 

	 * @return the number of elements in the node set

	 */

	public long getDeepSizeOfV() {

		return this.nodeSet.keySet().stream().map(nodeId -> this.nodeSet.get(nodeId).get().getDeepSize()).reduce(0L,

				(accum, elem) -> (accum + elem));

	}

	@Override

	public ExtendedOntology getExtendedOntology() {

		return this.extendedOntology;

	}

	@Override

	public Collection<Integer> getFirstBySecond(int propertyId, int classId) {

		Collection<Integer> ret = new TreeSet<>();

		synchronized (this.monitorRelationSet) {

			ret.addAll(this.relationSet.getBySecond(propertyId, classId));

		}

		return ret;

	}

	/**

	 * Returns the identifier generator.

	 * 

	 * @return the identifier generator

	 */

	protected IntegerEntityManager getIdGenerator() {

		return this.entityManager;

	}

	@Override

	public int getInverseObjectPropertyOf(int propertyId) {

		return this.entityManager.createOrGetInverseObjectPropertyOf(propertyId);

	}

	@Override

	public Optional<VNode> getNode(int nodeId) {

		Optional<VNodeImpl> node = this.nodeSet.get(nodeId);

		Optional<VNode> ret = Optional.empty();

		if (node.isPresent()) {

			ret = Optional.of(node.get());

		}

		return ret;

	}

	/**

	 * Returns the number of R-entries to be processed.

	 * 

	 * @return the number of R-entries to be processed

	 */

	public int getNumberOfREntries() {

		int ret = 0;

		synchronized (this.monitorSetQsubR) {

			ret = this.setQsubR.size();

		}

		return ret;

	}

	/**

	 * Returns the number of S-entries to be processed.

	 * 

	 * @return the number of S-entries to be processed

	 */

	public int getNumberOfSEntries() {

		int ret = 0;

		synchronized (this.monitorSetQsubS) {

			ret = this.setQsubS.size();

		}

		return ret;

	}

	@Override

	public Collection<Integer> getObjectPropertiesByFirst(int cA) {

		Collection<Integer> ret = new TreeSet<>();

		synchronized (this.monitorRelationSet) {

			ret.addAll(this.relationSet.getRelationsByFirst(cA));

		}

		return ret;

	}

	@Override

	public Collection<Integer> getObjectPropertiesBySecond(int cA) {

		Collection<Integer> ret = new TreeSet<>();

		synchronized (this.monitorRelationSet) {

			ret.addAll(this.relationSet.getRelationsBySecond(cA));

		}

		return ret;

	}

	@Override

	public Set<Integer> getObjectPropertiesWithFunctionalAncestor(int objectProperty) {

		Optional<Set<Integer>> optSet = this.cognateFunctPropMap.get(objectProperty);

		if (!optSet.isPresent()) {

			optSet = Optional.of(Collections.emptySet());

		} else {

			optSet = Optional.of(Collections.unmodifiableSet(optSet.get()));

		}

		return optSet.get();

	}

	/**

	 * Returns the object property graph.

	 * 

	 * @return the object property graph

	 */

	protected IntegerSubsumerBidirectionalGraphImpl getObjectPropertyGraph() {

		return this.objectPropertyGraph;

	}

	/**

	 * Returns the set of relations.

	 * 

	 * @return the set of relations

	 */

	protected IntegerRelationMapImpl getRelationSet() {

		return this.relationSet;

	}

	@Override

	public Object getRelationSetMonitor() {

		return this.monitorRelationSet;

	}

	@Override

	public Collection<Integer> getSecondByFirst(int propertyId, int classId) {

		Collection<Integer> ret = new TreeSet<>();

		synchronized (this.monitorRelationSet) {

			ret.addAll(this.relationSet.getByFirst(propertyId, classId));

		}

		return ret;

	}

	/**

	 * Returns the number of nodes.

	 * 

	 * @return the number of nodes

	 */

	public long getSizeOfV() {

		return this.nodeSet.size();

	}

	@Override

	public Collection<Integer> getSubObjectProperties(int objectProperty) {

		return Collections.unmodifiableCollection(this.objectPropertyGraph.getSubsumees(objectProperty));

	}

	@Override

	public Collection<Integer> getSubsumers(int classId) {

		Collection<Integer> ret = null;

		synchronized (this.monitorClassGraph) {

			ret = this.classGraph.getSubsumers(classId);

		}

		return ret;

	}

	@Override

	public Collection<Integer> getSuperObjectProperties(int objectProperty) {

		return Collections.unmodifiableCollection(this.objectPropertyGraph.getSubsumers(objectProperty));

	}

	private void makeTransitiveClosure(IntegerSubsumerBidirectionalGraphImpl graph) {

		boolean hasChanged = true;

		while (hasChanged) {

			hasChanged = false;

			for (int elem : graph.getElements()) {

				Collection<Integer> subsumerSet = graph.getSubsumers(elem);

				Set<Integer> allSubsumers = new HashSet<>();

				allSubsumers.add(elem);

				subsumerSet.forEach(otherElem -> {

					allSubsumers.addAll(graph.getSubsumers(otherElem));

				});

				allSubsumers.removeAll(subsumerSet);

				if (!allSubsumers.isEmpty()) {

					hasChanged = true;

					allSubsumers.forEach(subsumer -> {

						graph.addAncestor(elem, subsumer);

					});

				}

			}

		}

	}

	/**

	 * Returns the next R-entry and removes it from the set to be processed.

	 * 

	 * @return the next R-entry and removes it from the set to be processed

	 * 

	 * @throws NoSuchElementException

	 *             if the set of R-entries is empty

	 */

	public REntry removeNextREntry() {

		REntry ret = null;

		synchronized (this.monitorSetQsubR) {

			if (this.setQsubR.isEmpty()) {

				throw new NoSuchElementException();

			}

			ret = this.setQsubR.iterator().next();

			this.setQsubR.remove(ret);

		}

		return ret;

	}

	/**

	 * Returns the next S-entry and removes it from the set to be processed.

	 * 

	 * @return the next S-entry and removes it from the set to be processed

	 * @throws NoSuchElementException

	 *             if the set of S-entries is empty

	 */

	public void outputSetS(Writer output) throws IOException {

		BufferedWriter writer = new BufferedWriter(output);

		Collection<Integer> concepts = this.classGraph.getElements();

		for (Integer concept : concepts) {

			Collection<Integer> subsumers = this.classGraph.getSubsumers(concept);

			for (Integer subsumer : subsumers) {

				writer.write(this.entityManager.getName(concept));

				writer.write(COMMA_SEPARATOR);

				writer.write(this.entityManager.getName(subsumer));

				writer.newLine();

			}

		}

		writer.flush();

	}

	public void outputSetR(Writer output) throws IOException {

		BufferedWriter writer = new BufferedWriter(output);

		Collection<Integer> concepts = this.classGraph.getElements();

		for (Integer concept : concepts) {

			Collection<Integer> relations = this.relationSet.getRelationsByFirst(concept);

			for (Integer relation : relations) {

				Collection<Integer> otherConcepts = this.relationSet.getByFirst(relation, concept);

				for (Integer otherConcept : otherConcepts) {

					writer.write(this.entityManager.getName(concept));

					writer.write(COMMA_SEPARATOR);

					writer.write(this.entityManager.getName(relation));

					writer.write(COMMA_SEPARATOR);

					writer.write(this.entityManager.getName(otherConcept));

					writer.newLine();

				}

			}

		}

		writer.flush();

	}

}