Node

java.lang.Object
- network.node.Node

```
public class Node
extends java.lang.Object
```
Node is the class representing a vertex or node in the graph/network. Creating a node should happen statically using the method 'createNode', as the same node can be part of different networks for performance reasons. The class NodeCollection is responsible for keeping track of all the nodes. Nodes should have an unique name. Each node keeps track of it's incoming and outgoing links. It also keeps track of it's bidirectional links and unidirectional links separately for performance reasons.

Since:

0.0

Version:

1.0

Author:

Joeri Ruyssinck (joeri.ruysssinck@intec.ugent.be)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIncomingLink(Network net, Node node)` Adds an incoming link to this node coming from another node a.
`void`	`addOutGoingLink(Network net, Node node)` Adds an outgoing link to this node coming from another node a.
`void`	`clear()` Resets this node completely for all networks, removing all links
`void`	`clearNetwork(Network network)` Removes all links of this node in a given network, use with caution as the network representation can become inconsistent.
`static Node`	`createNode(java.lang.String name)` Method responsible for creating a node.
`boolean`	`equals(java.lang.Object a)` Overrides equals method, two nodes should be identical if their name is the same
`java.util.ArrayList<Node>`	`getBiDirectionalLinks(Network network)` Returns list of nodes connected by a birectional link in a given network context
`java.util.ArrayList<Node>`	`getIncomingLinks(Network net)` Returns list of nodes connected by an incoming link in a given network context
`java.lang.String`	`getName()` Getter for name of node
`java.util.ArrayList<Node>`	`getOutGoingLinks(Network net)` Returns list of nodes connected by an outgoing link in a given network context
`java.util.HashSet<Node>`	`getUnidirectedLinks(Network net)` Returns list of nodes connected by any type of link in a given network context
`int`	`hashCode()` Overrides hashcode to be represented by the name of the node since this is unique
`void`	`removeIncomingLink(Network net, Node node)` Removes an incoming link to this node coming from another node a.
`void`	`removeOutGoingLink(Network net, Node node)` Removes an outgoing link to this node coming from another node a.
`void`	`resetNodeConnectivity(Network network)` Similar to 'clearNetwork' this method resets a given network context.
`void`	`setName(java.lang.String name)` Setter for name of node
`java.lang.String`	`toString()` Overrides to String method, simple prints the name of node

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

- Method Detail
  - createNode
```
public static Node createNode(java.lang.String name)
```
    Method responsible for creating a node. It will first poll the NodeCollection to check if the node exists, else it will create a new node and register with the collection.
    
    Parameters:
    
    name - name of the node to be created
    
    Returns:
    
    a node with that specific unique name
  - addIncomingLink
```
public void addIncomingLink(Network net,
                            Node node)
```
    Adds an incoming link to this node coming from another node a.
    
    Parameters:
    
    net - network context of the link
    
    node - node to be connected by the link
  - addOutGoingLink
```
public void addOutGoingLink(Network net,
                            Node node)
```
    Adds an outgoing link to this node coming from another node a.
    
    Parameters:
    
    net - network context of the link
    
    node - node to be connected by the link
  - removeIncomingLink
```
public void removeIncomingLink(Network net,
                               Node node)
```
    Removes an incoming link to this node coming from another node a.
    
    Parameters:
    
    net - network context of the link
    
    node - node to removed
  - removeOutGoingLink
```
public void removeOutGoingLink(Network net,
                               Node node)
```
    Removes an outgoing link to this node coming from another node a.
    
    Parameters:
    
    net - network context of the link
    
    node - node to removed
  - getBiDirectionalLinks
```
public java.util.ArrayList<Node> getBiDirectionalLinks(Network network)
```
    Returns list of nodes connected by a birectional link in a given network context
    
    Parameters:
    
    net - network context of the link
    
    Returns:
    
    list of nodes connected by bidirectional link
  - getIncomingLinks
```
public java.util.ArrayList<Node> getIncomingLinks(Network net)
```
    Returns list of nodes connected by an incoming link in a given network context
    
    Parameters:
    
    net - network context of the link
    
    Returns:
    
    list of nodes connected by incoming link
  - getOutGoingLinks
```
public java.util.ArrayList<Node> getOutGoingLinks(Network net)
```
    Returns list of nodes connected by an outgoing link in a given network context
    
    Parameters:
    
    net - network context of the link
    
    Returns:
    
    list of nodes connected by outgoing link
  - getUnidirectedLinks
```
public java.util.HashSet<Node> getUnidirectedLinks(Network net)
```
    Returns list of nodes connected by any type of link in a given network context
    
    Parameters:
    
    net - network context of the link
    
    Returns:
    
    list of nodes connected by link
  - getName
```
public java.lang.String getName()
```
    Getter for name of node
    
    Returns:
    
    node's name
  - setName
```
public void setName(java.lang.String name)
```
    Setter for name of node
    
    Parameters:
    
    node's - name
  - equals
```
public boolean equals(java.lang.Object a)
```
    Overrides equals method, two nodes should be identical if their name is the same
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    any - object to compare to
  - toString
```
public java.lang.String toString()
```
    Overrides to String method, simple prints the name of node
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    toString representation of the Node
  - hashCode
```
public int hashCode()
```
    Overrides hashcode to be represented by the name of the node since this is unique
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hashcode representation of this object
  - clear
```
public void clear()
```
    Resets this node completely for all networks, removing all links
  - clearNetwork
```
public void clearNetwork(Network network)
```
    Removes all links of this node in a given network, use with caution as the network representation can become inconsistent. In general, this method should only be invoked if a given network should be removed.
    
    Parameters:
    
    the - network context to be removed
  - resetNodeConnectivity
```
public void resetNodeConnectivity(Network network)
```
    Similar to 'clearNetwork' this method resets a given network context. In contrast, a ready to use empty network context is set-up. ArrayList is re-used if existed to save new object creation time.
    
    Parameters:
    
    the - network context to be reset

Class Node

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createNode

addIncomingLink

addOutGoingLink

removeIncomingLink

removeOutGoingLink

getBiDirectionalLinks

getIncomingLinks

getOutGoingLinks

getUnidirectedLinks

getName

setName

equals

toString

hashCode

clear

clearNetwork

resetNodeConnectivity