org.semanticweb.elk.reasoner.taxonomy.model.NodeStore Maven / Gradle / Ivy
Show all versions of elk-reasoner Show documentation
/*
* #%L
* elk-reasoner
*
* $Id$
* $HeadURL$
* %%
* Copyright (C) 2011 Oxford University Computing Laboratory
* %%
* 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.model;
import java.util.Set;
import org.semanticweb.elk.owl.interfaces.ElkEntity;
/**
* An immutable storage of nodes.
*
* The way members of each node are hashed and compared is controlled by
* {@link ComparatorKeyProvider} that is returned by {@link #getKeyProvider()}.
* For more information see {@link Node}.
*
* @author Peter Skocovsky
*
* @param
* The type of members of nodes in this store.
* @param
* The type of nodes in this store.
*/
public interface NodeStore> {
/**
* Returns the {@link ComparatorKeyProvider} that provides a key for each
* node member. These keys are used to compute hash codes and to compare the
* members.
*
* @return the {@link ComparatorKeyProvider} that provides a key for each
* node member.
*/
public ComparatorKeyProvider getKeyProvider();
/**
* Returns the {@link TaxonomyNode} containing the given {@link ElkEntity}
* as a member or {@code null} if the input does not occur in the taxonomy.
*
* @param member
* node member for which to return the {@link TaxonomyNode}
*
* @return the {@link TaxonomyNode} for the specified input
* {@link ElkEntity}
*/
public N getNode(T member);
/**
* Obtain an unmodifiable Set of all nodes in this taxonomy.
*
* @return an unmodifiable Collection
*/
public Set getNodes();
/**
* Registers the given {@link Listener} with this node store.
*
* @param listener
* The listener that should be registered.
* @return {@code true} if the operation was successful and {@code false}
* otherwise; if {@code false} is return, the listener was not
* registered
*/
boolean addListener(Listener listener);
/**
* Removes a given {@link Listener} from this node store.
*
* @param listener
* The listener that should be removed.
* @return {@code true} if the operation was successful and {@code false}
* otherwise; if {@code false} is return, the listener was not
* removed
*/
boolean removeListener(Listener listener);
/**
* Instances of this interface registered by
* {@link NodeStore#addListener(Listener)} will be notified about changes to
* the node store.
*
* @author Peter Skocovsky
*
* @param
* The type of members of the nodes in the node store for which
* this listener is registered.
*/
interface Listener {
/**
* Called just after the value returned from
* {@link NodeStore#getNode(Object)} for member changes to
* non-null.
*
* @param member
* The member that appeared.
* @param node
* The node in which the member appeared.
*/
void memberForNodeAppeared(T member, Node node);
/**
* Called just after the value returned from
* {@link NodeStore#getNode(Object)} for member changes to
* null.
*
* @param member
* The member that appeared.
* @param node
* The node in which the member appeared.
*/
void memberForNodeDisappeared(T member, Node node);
}
}