org.semanticweb.owlapi.reasoner

Interface NodeSet<E extends OWLObject>

Type Parameters:

E - the type of elements in the node set

All Superinterfaces:

Iterable<Node<E>>

public interface NodeSet<E extends OWLObject>
extends Iterable<Node<E>>

Author: Matthew Horridge
The University of Manchester
Information Management Group
Date: 01-Aug-2009

A set of Nodes.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsEntity(E e) A convenience method that determines if this NodeSet contains a specific entity.
Set<E>	getFlattened() A convenience method that gets all of the entities contained in the Nodes in this NodeSet.
Set<Node<E>>	getNodes() Gets the Nodes contained in this NodeSet
boolean	isBottomSingleton() Determies if this NodeSet is a singleton that only contains the bottom node (in a hierarchy).
boolean	isEmpty()
boolean	isSingleton() Determines if this NodeSet is a singleton.
boolean	isTopSingleton() Determines if this NodeSet is a singleton node that only contains the top node (in a hierarchy).

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getFlattened

Set<E> getFlattened()

A convenience method that gets all of the entities contained in the Nodes in this NodeSet.

Returns:

The union of the entities contained in the Nodes in this NodeSet.

isEmpty

boolean isEmpty()

Returns:

true if the node set is empty

containsEntity

boolean containsEntity(E e)

A convenience method that determines if this NodeSet contains a specific entity.

Parameters:

e - The entity to test for

Returns:

true if this NodeSet contains a Node that contains the entity, e, and false if this NodeSet does not contain a Node that contains the entity, e.

isSingleton

boolean isSingleton()

Determines if this NodeSet is a singleton. A NodeSet is a singleton if it contains only one Node.

Returns:

true if this NodeSet is a singleton, otherwise false.

isTopSingleton

boolean isTopSingleton()

Determines if this NodeSet is a singleton node that only contains the top node (in a hierarchy).

Returns:

true if this NodeSet is a singleton that contains only the top node, and false otherwise.

See Also:

Node#isTopNode()}

isBottomSingleton

boolean isBottomSingleton()

Determies if this NodeSet is a singleton that only contains the bottom node (in a hierarchy).

Returns:

true if this NodeSet is a singleton that only contains a node that is the bottom node, otherwise false

See Also:

Node#isBottomNode()}

getNodes

Set<Node<E>> getNodes()

Gets the Nodes contained in this NodeSet

Returns:

The set of Nodes contained in this NodeSet. Note that this set will be an unmodifiable set.