org.semanticweb.elk.reasoner.completeness.OccurrencesInClassExpressionQuery Maven / Gradle / Ivy

Go to download
package org.semanticweb.elk.reasoner.completeness;

import java.util.EnumSet;
import java.util.Set;

/*-
 * #%L
 * ELK Reasoner Core
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2018 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%
 */

import org.semanticweb.elk.owl.interfaces.ElkClassExpression;
import org.slf4j.Logger;

/**
 * An {@link OccurrenceManager} that provides information about occurrences of
 * {@link Feature}s in a given {@link ElkClassExpression} query.
 * 
 * @author Yevgeny Kazakov
 */
public class OccurrencesInClassExpressionQuery implements OccurrenceManager {

	private final ElkClassExpression query_;

	private final OccurrenceCounter occurrenceCounter_;

	private Set reportedOccurrences_ = EnumSet.noneOf(Feature.class);

	public OccurrencesInClassExpressionQuery(ElkClassExpression query,
			OccurrenceCounter occurrenceCounter) {
		this.query_ = query;
		this.occurrenceCounter_ = occurrenceCounter;
	}

	/**
	 * @return the {@link ElkClassExpression} query for which the information
	 *         about occurrences of {@link Feature}s is maintained
	 */
	ElkClassExpression getQuery() {
		return query_;
	}

	@Override
	public int getOccurrenceCount(Feature occurrence) {
		return occurrenceCounter_.getOccurrenceCount(occurrence);
	}

	@Override
	public void logOccurrences(Feature occurrence, Logger logger) {
		int count = getOccurrenceCount(occurrence);
		String occurrences = count == 1 ? "occurrence" : "occurrences";
		logger.info("{} {} of {} found in the queried class expression {}",
				count, occurrences, occurrence.getConstructor(), query_);
		reportedOccurrences_.add(occurrence);
	}

	@Override
	public boolean hasNewOccurrencesOf(Feature occurrence) {
		return !reportedOccurrences_.contains(occurrence)
				&& getOccurrenceCount(occurrence) > 0;
	}

}