DefaultNode (OWLAPI :: Distribution 4.5.5 API)

java.lang.Object
- org.semanticweb.owlapi.reasoner.impl.DefaultNode<E>

Type Parameters:

E - the type of entities in the node

All Implemented Interfaces:

Iterable<E>, Node<E>

Direct Known Subclasses:

OWLClassNode, OWLDataPropertyNode, OWLDatatypeNode, OWLNamedIndividualNode, OWLObjectPropertyNode
```
public abstract class DefaultNode<E extends OWLObject>
extends Object
implements Node<E>
```
Since:

3.0.0

Author:

Matthew Horridge, The University of Manchester, Information Management Group

Constructor Summary

Constructors
Constructor Description

DefaultNode(E entity)

DefaultNode(Set<E> entities)

Constructors
Constructor	Description
`DefaultNode(E entity)`
`DefaultNode(Set<E> entities)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(E entity)`
`boolean`	`contains(E entity)`	Determines if this node contains the specified entity.
`boolean`	`equals(Object obj)`
`Set<E>`	`getEntities()`	Gets the entities contained in this node.
`Set<E>`	`getEntitiesMinus(E e)`	Gets the entities contained in this node minus the specified entitie `e`.
`Set<E>`	`getEntitiesMinusBottom()`	Gets the entities contained in this node minus the bottom entity.
`Set<E>`	`getEntitiesMinusTop()`	Gets the entities contained in this node minus the top entity.
`E`	`getRepresentativeElement()`	Gets one of the entities contained in this entity set.
`int`	`getSize()`	Gets the number of entities contained in this `Node`.
`int`	`hashCode()`
`boolean`	`isBottomNode()`	Determines if this node represents the bottom node (in a hierarchy).
`boolean`	`isSingleton()`	Determines if this `Node` contains just one entity.
`boolean`	`isTopNode()`	Determines if this node represents the top node (in a hierarchy).
`Iterator<E>`	`iterator()`
`String`	`toString()`

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DefaultNode
```
public DefaultNode(@Nonnull
                   E entity)
```
    Parameters:
    
    entity - the entity to add
  - DefaultNode
```
public DefaultNode(@Nonnull
                   Set<E> entities)
```
    Parameters:
    
    entities - the set of entities to add
- Method Detail
  - add
```
public void add(E entity)
```
    Parameters:
    
    entity - entity to be added
  - isTopNode
```
public boolean isTopNode()
```
    Description copied from interface: Node
    
    Determines if this node represents the top node (in a hierarchy). For a named class node, the top node is the node that contains owl:Thing. For an object property node, the top node is the node that contains owl:topObjectProperty. For a data property node, the top node is the node that contains owl:topDataProperty
    
    Specified by:
    
    isTopNode in interface Node<E extends OWLObject>
    
    Returns:
    
    true if this node is an OWLClass node and it contains owl:Thing.
    true if this node is an OWLObjectProperty node and it contains owl:topObjectProperty.
    true if this node is an OWLDataProperty node and it contains owl:topDataProperty.
    false if none of the above.
  - isBottomNode
```
public boolean isBottomNode()
```
    Description copied from interface: Node
    
    Determines if this node represents the bottom node (in a hierarchy). For a named class node, the bottom node is the node that contains owl:Nothing. For an object property node, the bottom node is the node that contains owl:bottomObjectProperty. For a data property node, the bottom node is the node that contains owl:bottomDataProperty
    
    Specified by:
    
    isBottomNode in interface Node<E extends OWLObject>
    
    Returns:
    
    true if this node is an OWLClass node and it contains owl:Nothing.
    true if this node is an OWLObjectProperty node and it contains owl:bottomObjectProperty.
    true if this node is an OWLDataProperty node and it contains owl:bottomDataProperty.
    false if none of the above.
  - getEntities
```
@Nonnull
public Set<E> getEntities()
```
    Description copied from interface: Node
    
    Gets the entities contained in this node. The entities are equivalent to each other.
    
    Specified by:
    
    getEntities in interface Node<E extends OWLObject>
    
    Returns:
    
    The set of entities contained in this Node.
  - getSize
```
public int getSize()
```
    Description copied from interface: Node
    
    Gets the number of entities contained in this Node.
    
    Specified by:
    
    getSize in interface Node<E extends OWLObject>
    
    Returns:
    
    The number of entities contained in this node.
  - contains
```
public boolean contains(E entity)
```
    Description copied from interface: Node
    
    Determines if this node contains the specified entity.
    
    Specified by:
    
    contains in interface Node<E extends OWLObject>
    
    Parameters:
    
    entity - The entity to check for
    
    Returns:
    
    true if this node contains entity, or false if this node does not contain entity
  - getEntitiesMinus
```
@Nonnull
public Set<E> getEntitiesMinus(E e)
```
    Description copied from interface: Node
    
    Gets the entities contained in this node minus the specified entitie e. This essentially returns the entities that are returned by Node.getEntities() minus the specified entity e
    
    Specified by:
    
    getEntitiesMinus in interface Node<E extends OWLObject>
    
    Parameters:
    
    e - The entity that, is contained within this node, but should not be included in the return set.
    
    Returns:
    
    The set of entities that are contained in this node minus the specified entity, e. If e is not contained within this node then the full set of entities returned is the same as that returned by Node.getEntities()
  - getEntitiesMinusTop
```
@Nonnull
public Set<E> getEntitiesMinusTop()
```
    Description copied from interface: Node
    
    Gets the entities contained in this node minus the top entity. For a node of named classes the top entity is owl:Thing. For a node of object properties the top entity is owl:topObjectProperty. For a node of data properties the top entity is owl:topDataProperty
    
    Specified by:
    
    getEntitiesMinusTop in interface Node<E extends OWLObject>
    
    Returns:
    
    The set of entities contained within this node minus the top entity. If this node does not contain the top entity then the set of entities returned is the same as that returned by Node.getEntities().
  - getEntitiesMinusBottom
```
@Nonnull
public Set<E> getEntitiesMinusBottom()
```
    Description copied from interface: Node
    
    Gets the entities contained in this node minus the bottom entity. For a node of named classes the bottom entity is owl:Nothing. For a node of object properties the bottom entity is owl:bottomObjectProperty. For a node of data properties the bottom entity is owl:bottomDataProperty
    
    Specified by:
    
    getEntitiesMinusBottom in interface Node<E extends OWLObject>
    
    Returns:
    
    The set of entities contained within this node minus the bottom entity. If this node does not contain the bottom entity then the set of entities returned is the same as that returned by Node.getEntities().
  - isSingleton
```
public boolean isSingleton()
```
    Description copied from interface: Node
    
    Determines if this Node contains just one entity.
    
    Specified by:
    
    isSingleton in interface Node<E extends OWLObject>
    
    Returns:
    
    true if this Node contains just one entity, otherwise false
  - getRepresentativeElement
```
@Nonnull
public E getRepresentativeElement()
```
    Description copied from interface: Node
    
    Gets one of the entities contained in this entity set. If this is a singleton set it will be the one and only entity.
    
    Specified by:
    
    getRepresentativeElement in interface Node<E extends OWLObject>
    
    Returns:
    
    An entity from the set of entities contained within this node
  - iterator
```
@Nonnull
public Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface Iterable<E extends OWLObject>
  - toString
```
@Nonnull
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class DefaultNode<E extends OWLObject>

Constructor Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Methods inherited from class java.lang.Object

Constructor Detail

DefaultNode

DefaultNode

Method Detail

add

isTopNode

isBottomNode

getEntities

getSize

contains

getEntitiesMinus

getEntitiesMinusTop

getEntitiesMinusBottom

isSingleton

getRepresentativeElement

iterator

toString

equals

hashCode