org.semanticweb.elk.reasoner.saturation.SaturationStateWriter 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
The core ELK Reasoner package
The newest version!
/**
 * 
 */
package org.semanticweb.elk.reasoner.saturation;

/*
 * #%L
 * ELK Reasoner
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2015 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.reasoner.indexing.model.IndexedContextRoot;
import org.semanticweb.elk.reasoner.saturation.conclusions.model.ClassConclusion;
import org.semanticweb.elk.reasoner.saturation.context.Context;
import org.semanticweb.elk.reasoner.saturation.rules.ClassInferenceProducer;

/**
 * An object that can modify the respective {@link SaturationState}.
 * 
 * @author Pavel Klinov
 * 
 *         [email protected]
 * 
 * @author "Yevgeny Kazakov"
 * 
 * @param 
 *            the type of contexts managed by this
 *            {@link SaturationStateWriter}
 */
public interface SaturationStateWriter
		extends ClassInferenceProducer {

	/**
	 * @return the {@link SaturationState} modified by this
	 *         {@link SaturationStateWriter}
	 */
	public SaturationState getSaturationState();

	/**
	 * Removes and returns the next active {@link Context} of the
	 * {@link SaturationState}, i.e., the one which has at least one unprocessed
	 * {@link ClassConclusion}
	 * 
	 * @return the next {@link Context} of the {@link SaturationState} with
	 *         unprocessed {@link ClassConclusion} if there exists one, or
	 *         {@code null} if not
	 * 
	 * @see Context#takeToDo()
	 */
	public Context pollForActiveContext();

	public boolean addConclusion(ClassConclusion conclusion);

	public boolean removeConclusion(ClassConclusion conclusion);
	
	/**
	 * Removes all assignments of {@link Context}s to {@link IndexedContextRoot}
	 * s of this {@link SaturationState}. After that,
	 * {@link SaturationState#getContexts()} should be empty.
	 */
	public void resetContexts();

}