berack96.lib.graph

Class Vertex<V>

java.lang.Object

berack96.lib.graph.Vertex<V>

Type Parameters:

V - the vertex

public class Vertex<V>
extends java.lang.Object

Class used for represent a vertex of the graph.
The vertex contained is linked with the graph, so if any changes are made to it, then they will be reflected here.

Author:

Berack96

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REMOVED

Constructor Summary

Constructors

Constructor and Description
Vertex(Graph<V,?> graph, V vertex) Get a Vertex linked with the graph

Method Summary

Modifier and Type	Method and Description
void	addChild(V child, java.lang.Number weight) Add a child to this vertex. The added child must be in the graph or it will return an exception.
void	addIfAbsent() Add the vertex to the graph only if it's not already in the graph.
boolean	equals(java.lang.Object obj)
java.util.Collection<V>	getAncestors() Get all the vertex ancestor of this vertex. The ancestors are all the vertices that have as destination this vertex.
java.util.Collection<Vertex<V>>	getAncestorsAsVertex() Get all the ancestors of this vertex like getAncestors(), but as Vertex. In this way they are linked to the graph as this one. This method allocate a new object for each vertex, so it is more heavy.
java.util.Collection<V>	getChildren() Get all the vertex children of the current vertex
java.util.Collection<Vertex<V>>	getChildrenAsVertex() Get all the children of this vertex like getChildren(), but as Vertex. In this way they are linked to the graph as this one. * This method allocate a new object for each vertex, so it is more heavy.
java.util.Collection<Edge<V,java.lang.Number>>	getEdgesIn() Get all the edge that goes INTO this vertex
java.util.Collection<Edge<V,java.lang.Number>>	getEdgesOut() Get all the edge that goes OUT of this vertex
java.util.Collection<java.lang.Object>	getMarks() Get all the marks that are associated with this vertex
V	getValue() Get the vertex
int	hashCode()
boolean	isStillContained() This call tell if the current vertex is still contained in the graph linked. While this function return false all the other methods will throw an exception.
void	mark(java.lang.Object mark) Mark the vertex with the associated string
void	remove() Remove the vertex from the graph. After this call all the other methods will throw an exception
void	removeChild(V child) Removes a child of this vertex.
java.lang.String	toString()
void	unMark() Remove all the marker from the vertex
void	unMark(java.lang.Object mark) Remove the specified mark from this vertex
VisitInfo<V>	visit(VisitStrategy strategy, java.util.function.Consumer<V> visit) Visit the graph from this current vertex with the strategy assigned

Methods inherited from class java.lang.Object

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

Field Detail

REMOVED

public static final java.lang.String REMOVED

See Also:

Constant Field Values

Constructor Detail

Vertex

public Vertex(Graph<V,?> graph,
              V vertex)
       throws java.lang.NullPointerException

Get a Vertex linked with the graph

Parameters:

graph - the graph of the vertex

vertex - the vertex

Throws:

java.lang.NullPointerException - if one of the param is null

Method Detail

getValue

public V getValue()

Get the vertex

Returns:

the vertex

mark

public void mark(java.lang.Object mark)
          throws java.lang.NullPointerException,
                 java.lang.UnsupportedOperationException

Mark the vertex with the associated string

Parameters:

mark - the marker

Throws:

java.lang.NullPointerException - if the marker is null

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

unMark

public void unMark(java.lang.Object mark)
            throws java.lang.UnsupportedOperationException

Remove the specified mark from this vertex

Parameters:

mark - the marker

Throws:

java.lang.NullPointerException - if the mark is null

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

unMark

public void unMark()
            throws java.lang.UnsupportedOperationException

Remove all the marker from the vertex

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

getMarks

public java.util.Collection<java.lang.Object> getMarks()
                                                throws java.lang.UnsupportedOperationException

Get all the marks that are associated with this vertex

Returns:

a set of marks

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

getChildren

public java.util.Collection<V> getChildren()
                                    throws java.lang.UnsupportedOperationException

Get all the vertex children of the current vertex

Returns:

all the children

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

getChildrenAsVertex

public java.util.Collection<Vertex<V>> getChildrenAsVertex()
                                                    throws java.lang.UnsupportedOperationException

Get all the children of this vertex like getChildren(), but as Vertex.
In this way they are linked to the graph as this one.
* This method allocate a new object for each vertex, so it is more heavy.

Returns:

a collection of vertices that are children of the current one

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

getAncestors

public java.util.Collection<V> getAncestors()
                                     throws java.lang.UnsupportedOperationException

Get all the vertex ancestor of this vertex.
The ancestors are all the vertices that have as destination this vertex.

Returns:

a collection of vertices

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

getAncestorsAsVertex

public java.util.Collection<Vertex<V>> getAncestorsAsVertex()
                                                     throws java.lang.UnsupportedOperationException

Get all the ancestors of this vertex like getAncestors(), but as Vertex.
In this way they are linked to the graph as this one.
This method allocate a new object for each vertex, so it is more heavy.

Returns:

a collection of vertices that are children of the current one

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

getEdgesOut

public java.util.Collection<Edge<V,java.lang.Number>> getEdgesOut()
                                                           throws java.lang.UnsupportedOperationException

Get all the edge that goes OUT of this vertex

Returns:

a collection of edges with source this one

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

getEdgesIn

public java.util.Collection<Edge<V,java.lang.Number>> getEdgesIn()
                                                          throws java.lang.UnsupportedOperationException

Get all the edge that goes INTO this vertex

Returns:

a collection of edges with destination this one

Throws:

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

addChild

public void addChild(V child,
                     java.lang.Number weight)
              throws java.lang.NullPointerException,
                     java.lang.IllegalArgumentException,
                     java.lang.UnsupportedOperationException

Add a child to this vertex.
The added child must be in the graph or it will return an exception.

Parameters:

child - the destination vertex of this edge

weight - the weight of the edge

Throws:

java.lang.NullPointerException - if the param is null

java.lang.IllegalArgumentException - if the child vertex is not contained in the graph

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

removeChild

public void removeChild(V child)
                 throws java.lang.NullPointerException,
                        java.lang.IllegalArgumentException,
                        java.lang.UnsupportedOperationException

Removes a child of this vertex. If the vertex passed as param is not a child, then this call does nothing.

Parameters:

child - the child of the current vertex

Throws:

java.lang.NullPointerException - if the param is null

java.lang.IllegalArgumentException - if the child vertex is not contained in the graph

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

isStillContained

public boolean isStillContained()

This call tell if the current vertex is still contained in the graph linked.
While this function return false all the other methods will throw an exception.

Returns:

true if it is, false otherwise

addIfAbsent

public void addIfAbsent()

Add the vertex to the graph only if it's not already in the graph.

remove

public void remove()

Remove the vertex from the graph.
After this call all the other methods will throw an exception

visit

public VisitInfo<V> visit(VisitStrategy strategy,
                          java.util.function.Consumer<V> visit)
                   throws java.lang.NullPointerException,
                          java.lang.UnsupportedOperationException

Visit the graph from this current vertex with the strategy assigned

Parameters:

strategy - the strategy of the visit

visit - the function to apply at each vertex (can be null)

Returns:

an info of the visit if supported by the strategy

Throws:

java.lang.NullPointerException - if the strategy is null

java.lang.UnsupportedOperationException - if the vertex is not in the graph anymore

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object