it.unimi.dico.islab.idbs2.cloud

Class Cloud

java.lang.Object

it.unimi.dico.islab.idbs2.cloud.Cloud

public class Cloud
extends Object

Main class of the cloud framework, representation of a cloud graph. A cloud is formally a couple <N,E> where N is a set of nodes (each of them represented by the class CloudNode) and E is a set of edges (each of them represented by the class CloudEdge).

Author:

Vegeziel

See Also:

CloudEdge, CloudNode

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	EDGE_DEFAULT_WEIGHT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cloud()
	Cloud(boolean isDirect) Only public constructor to generate a new Cloud object.

Method Summary

Methods

Modifier and Type	Method and Description
CloudEdge	addEdge(CloudNode source, CloudNode target) This method has the same behavior of addEdge(CloudNode, CloudNode, double) omitting the weight parameter and using the default EDGE_DEFAULT_WEIGHT instead.
CloudEdge	addEdge(CloudNode source, CloudNode target, double weight) Generates a new edge between two nodes owned by this cloud.
CloudNode	addNode() Generate and add a new node to this Cloud.
CloudEdge	getEdge(CloudNode source, CloudNode target) Grants a quick access (indexed) to the edges map.
Set<CloudEdge>	getEdges() Get the set of all edges associated with this cloud.
Set<CloudEdge>	getEdges(CloudNode source) Grants a quick access (indexed) to the edges map to retrieve all the edges having source as source node.
Integer	getId() Get the id of the corresponding database persisted object.
Set<CloudNode>	getNodes() Get the set of all nodes associated with this cloud
String	getTargetEntity() Getter for the target entity string representing the focus topic of this cloud.
boolean	isDirect() Getter for the isDirect property of this class.
void	removeAllNodes() Removes all the nodes contained by the current Cloud.
Boolean	removeEdge(CloudEdge edge)
Boolean	removeEdge(CloudNode source, CloudNode target) Removes the edge between source node and target node.
void	removeEdges() Removes all the edges contained by the current inCloud.
boolean	removeNode(CloudNode node) Removes the node passed as argument.
boolean	removeNode(Integer id) Removes the node represented by id.
void	removeNodes() Removes all the nodes contained by the current inCloud.
protected void	setEdges(Set<CloudEdge> edges)
void	setTargetEntity(String targetEntity) Setter for the target entity string reprenting the focus topic of this cloud.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EDGE_DEFAULT_WEIGHT

public static final Integer EDGE_DEFAULT_WEIGHT

Constructor Detail

Cloud

protected Cloud()

Cloud

public Cloud(boolean isDirect)

Only public constructor to generate a new Cloud object.

Parameters:

isDirect - defines if the representation of this cloud structure should be a

• true: directed
• false: undirected

graph.
N.B.: Using a direct or undirected Cloud structure changes the behavior of this class on edges management.

Method Detail

addNode

public CloudNode addNode()

Generate and add a new node to this Cloud.

Returns:

the generated node, already connected with this cloud.

removeNode

public boolean removeNode(Integer id)

Removes the node represented by id.

Parameters:

id - identifier of the node to be removed

Returns:

• true: if the node was present and has been removed
• false: if there were no node with id as identifier.

removeNode

public boolean removeNode(CloudNode node)

Removes the node passed as argument.

Parameters:

node - the node to be removed

Returns:

• true: if the node was present and has been removed
• false: if there were no node with id as identifier.

removeAllNodes

public void removeAllNodes()

Removes all the nodes contained by the current Cloud.

addEdge

public CloudEdge addEdge(CloudNode source,
                CloudNode target,
                double weight)

Generates a new edge between two nodes owned by this cloud.

If the current cloud is directed, parameters source and target represent the direction of the edge (as suggested by parameter names). Otherwise it is implicitly created a symmetric connection between the two given nodes.

N.B.: Reflexive edges are discarded by default without any error or warning massage.

Parameters:

source - Source node of the directed edge

target - Target node of the directed edge

weight - Weight of the edge

Returns:

the new created edge

See Also:

Cloud(boolean)

addEdge

public CloudEdge addEdge(CloudNode source,
                CloudNode target)

This method has the same behavior of addEdge(CloudNode, CloudNode, double) omitting the weight parameter and using the default EDGE_DEFAULT_WEIGHT instead.

Parameters:

source - node of the directed edge

target - Target node of the directed edge

Returns:

the new created edge

See Also:

addEdge(CloudNode, CloudNode, double)

getEdge

public CloudEdge getEdge(CloudNode source,
                CloudNode target)

Grants a quick access (indexed) to the edges map.

Parameters:

source - the source node of the required edge.

target - the target node of the required edge.

Returns:

the edge source->target if such an edge exists, null otherwise. In case of indirect Cloud, also the edge target->source could be returned.

getEdges

public Set<CloudEdge> getEdges(CloudNode source)

Grants a quick access (indexed) to the edges map to retrieve all the edges having source as source node.

Parameters:

source - the starting node of the required edges

Returns:

all the edges having source as source node (in case of indirect cloud, also the edges having source as target node are returned) or the empty set if source is disconnected.

removeEdge

public Boolean removeEdge(CloudNode source,
                 CloudNode target)

Removes the edge between source node and target node.

Parameters:

source - The source node of the edge to be removed.

target - The target node of the edge to be removed.

Returns:

• true: if the edge source->target exists and has been removed correctly
• false: if the edge source->target has not been found.

removeEdge

public Boolean removeEdge(CloudEdge edge)

removeEdges

public void removeEdges()

Removes all the edges contained by the current inCloud.

removeNodes

public void removeNodes()

Removes all the nodes contained by the current inCloud.

getId

public Integer getId()

Get the id of the corresponding database persisted object.

Returns:

the identifier (primary key) of the corresponding row on the relational Hibernate-mapped relational database.

getNodes

public Set<CloudNode> getNodes()

Get the set of all nodes associated with this cloud

Returns:

a set of all nodes in this cloud instance.

getTargetEntity

public String getTargetEntity()

Getter for the target entity string representing the focus topic of this cloud.

Returns:

the target entity string

setTargetEntity

public void setTargetEntity(String targetEntity)

Setter for the target entity string reprenting the focus topic of this cloud.

Parameters:

targetEntity - the target entity string

isDirect

public boolean isDirect()

Getter for the isDirect property of this class.

Returns:

• true: if this cloud is represented by a directed graph
• false: if this cloud is represented by an undirected graph

getEdges

public Set<CloudEdge> getEdges()

Get the set of all edges associated with this cloud.

N.B.:If the cloud is indirect, an edge A->B represents also the edge B->A

Returns:

the set of all edges associated with this cloud instance.

setEdges

protected void setEdges(Set<CloudEdge> edges)