org.semanticweb.elk.reasoner.taxonomy.impl.UpdateableNode Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * ELK Reasoner
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2012 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 org.semanticweb.elk.reasoner.taxonomy.model.Node;

/**
 * A node that can be modified.
 * 
 * @author Pavel Klinov
 *
 *         [email protected]
 * @author Peter Skocovsky
 *
 * @param 
 *            The type of the members of this node.
 */
public interface UpdateableNode extends Node {

	/**
	 * Atomically sets the allParentsAssigned flag of this node to the
	 * passed argument if the state is different. When the
	 * allParentsAssigned flag of a node is true it is
	 * certain that all parent nodes of this node are set and can be retrieved.
	 * 
	 * @param allParentsAssigned
	 *            How to set the flag.
	 * @return Whether the flag changed.
	 */
	boolean trySetAllParentsAssigned(boolean allParentsAssigned);

	/**
	 * Whether all parent nodes of this node were already assigned.
	 * 
	 * @return The allParentsAssigned flag.
	 */
	boolean areAllParentsAssigned();

	/**
	 * Replaces the members of this node with the specified members.
	 * 
	 * @param members
	 *            The new members of this node.
	 */
	void setMembers(Iterable members);

}