org.thegalactic.dgraph

Class Node<N>

java.lang.Object

org.thegalactic.dgraph.Node<N>

Type Parameters:

N - the content type

All Implemented Interfaces:

Cloneable, Comparable<Node<N>>

Direct Known Subclasses:

Concept

public class Node<N>
extends Object
implements Comparable<Node<N>>, Cloneable

This class gives a standard representation for a node of a graph.

A node is composed of a content and an automatically computed and unique index.

This class implements the Comparable interface aiming at sorting nodes by providing the compareTo(org.thegalactic.dgraph.Node) method that compares the node with those in parameter by comparing their indexes.

Since nodes are comparable, they can be stored in a sorted collection, and in particular in a sorted set where set operations are provided.

Constructor Summary

Constructors

Constructor and Description
Node() Constructs a new node with a null content.
Node(N content) Constructs a new node containing the specified content.

Method Summary

Modifier and Type	Method and Description
Node	clone() Returns a clone of this node.
int	compareTo(Node node) Compares this node with those in parameter, based on their identifiers.
boolean	equals(Object object) Compares this node with the specified one.
N	getContent() Get the content.
int	getIdentifier() Get the identifier.
boolean	hasContent() Test if this node has a content.
int	hashCode() Compute the hash code.
Node	setContent(N content) Set the content.
String	toString() Returns a string representation of this node without spaces.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Node

public Node(N content)

Constructs a new node containing the specified content.

Identifier of this node is initalized with the count variable which is the incremented.

Parameters:

content - Content for this node

Node

public Node()

Constructs a new node with a null content.

Identifier of this node is initalized with the count variable which is the incremented.

Method Detail

getIdentifier

public final int getIdentifier()

Get the identifier.

Returns:

the node identifier

getContent

public final N getContent()

Get the content.

Returns:

the node content

setContent

public final Node setContent(N content)

Set the content.

Parameters:

content - Content for this node

Returns:

this for chaining

hasContent

public final boolean hasContent()

Test if this node has a content.

Returns:

true if this node has a content

toString

public String toString()

Returns a string representation of this node without spaces.

Overrides:

toString in class Object

Returns:

the string representation

clone

public Node clone()
           throws CloneNotSupportedException

Returns a clone of this node.

Overrides:

clone in class Object

Returns:

a clone of this node

Throws:

CloneNotSupportedException

equals

public boolean equals(Object object)

Compares this node with the specified one.

Overrides:

equals in class Object

Parameters:

object - The object to be tested with

Returns:

true or false as this node is equal to the specified object.

hashCode

public int hashCode()

Compute the hash code.

Overrides:

hashCode in class Object

Returns:

an integer representing the object

compareTo

public final int compareTo(Node node)

Compares this node with those in parameter, based on their identifiers.

The result is zero if the identifiers are equal; positive if this node’s identifier is greater, and negative otherwise. This comparison method is needed to define a natural ordering. It allows to use objects of this class in a sorted collection.

Specified by:

compareTo in interface Comparable<Node<N>>

Parameters:

node - the specified element to be compared with this node

Returns:

a negative integer, zero, or a positive integer as this node is less than, equal to, or greater than the specified object.