org.gephi.datalab.impl

Class GraphElementsControllerImpl

java.lang.Object

org.gephi.datalab.impl.GraphElementsControllerImpl

All Implemented Interfaces:

GraphElementsController

public class GraphElementsControllerImpl
extends Object
implements GraphElementsController

Implementation of the GraphElementsController interface declared in the Data Laboratory API

Author:

Eduardo Ramos

See Also:

GraphElementsController

Field Summary

Fields

Modifier and Type	Field and Description
private static float	DEFAULT_EDGE_WEIGHT
private static float	DEFAULT_NODE_SIZE

Constructor Summary

Constructors

Constructor and Description
GraphElementsControllerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areEdgesInGraph(org.gephi.graph.api.Edge[] edges) Checks if an array of edges are contained in the main view graph.
boolean	areNodesInGraph(org.gephi.graph.api.Node[] nodes) Checks if an array of nodes are contained in the main view graph.
private org.gephi.graph.api.Edge	buildEdge(org.gephi.graph.api.Graph graph, String id, org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed, Object typeLabel)
private org.gephi.graph.api.Node	buildNode(org.gephi.graph.api.Graph graph, String label)
private org.gephi.graph.api.Node	buildNode(org.gephi.graph.api.Graph graph, String label, String id)
private org.gephi.graph.api.Node	copyNode(org.gephi.graph.api.Node node, org.gephi.graph.api.Graph graph)
org.gephi.graph.api.Edge	createEdge(org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed) Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.
org.gephi.graph.api.Edge	createEdge(org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed, org.gephi.graph.api.Graph graph) Creates and edge between source and target node (if it does not already exist), directed or undirected.
org.gephi.graph.api.Edge	createEdge(org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed, Object typeLabel) Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.
org.gephi.graph.api.Edge	createEdge(org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed, Object typeLabel, org.gephi.graph.api.Graph graph) Creates and edge between source and target node (if it does not already exist), directed or undirected.
org.gephi.graph.api.Edge	createEdge(String id, org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed) Creates and edge between source and target node (if it does not already exist), directed or undirected.
org.gephi.graph.api.Edge	createEdge(String id, org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed, org.gephi.graph.api.Graph graph) Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.
org.gephi.graph.api.Edge	createEdge(String id, org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed, Object typeLabel) Creates and edge between source and target node (if it does not already exist), directed or undirected.
org.gephi.graph.api.Edge	createEdge(String id, org.gephi.graph.api.Node source, org.gephi.graph.api.Node target, boolean directed, Object typeLabel, org.gephi.graph.api.Graph graph) Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.
void	createEdges(org.gephi.graph.api.Node source, org.gephi.graph.api.Node[] allNodes, boolean directed) Tries to create edges between the source node and all other edges, directed or undirected.
org.gephi.graph.api.Node	createNode(String label) Creates a node with default id and the given label in the current graph.
org.gephi.graph.api.Node	createNode(String label, org.gephi.graph.api.Graph graph) Creates a node with default id and the given label.
org.gephi.graph.api.Node	createNode(String label, String id) Creates a node with the given id and label in the current graph.
org.gephi.graph.api.Node	createNode(String label, String id, org.gephi.graph.api.Graph graph) Creates a node with the given id and label.
void	deleteEdge(org.gephi.graph.api.Edge edge) Tries to delete an edge checking first if it is on the graph.
void	deleteEdges(org.gephi.graph.api.Edge[] edges) Tries to delete an array of edges checking first if they are on the graph.
void	deleteEdgesWithNodes(org.gephi.graph.api.Edge[] edges, boolean deleteSource, boolean deleteTarget) Tries to delete an array of edges checking first if they are on the graph and also deletes their source and target node if it is indicated.
void	deleteEdgeWithNodes(org.gephi.graph.api.Edge edge, boolean deleteSource, boolean deleteTarget) Tries to delete an edge checking first if it is on the graph and also deletes its source and target node if it is indicated.
void	deleteNode(org.gephi.graph.api.Node node) Tries to delete a node checking first if it is on the graph.
void	deleteNodes(org.gephi.graph.api.Node[] nodes) Tries to delete an array of nodes checking first if they are on the graph.
org.gephi.graph.api.Node	duplicateNode(org.gephi.graph.api.Node node) Duplicates a node if it is in the graph, and returns the new node.
void	duplicateNodes(org.gephi.graph.api.Node[] nodes) Tries to duplicate an array of nodes with the same behaviour as duplicateNode method.
private org.gephi.graph.api.Graph	getCurrentGraph() **********Private methods : ***********
int	getEdgesCount() Returns the number of edges in the graph.
org.gephi.graph.api.Edge[]	getNodeEdges(org.gephi.graph.api.Node node) Prepares and returns an array with the edges incident to the specified node.
org.gephi.graph.api.Node[]	getNodeNeighbours(org.gephi.graph.api.Node node) Prepares and returns an array with the neighbour nodes of the specified node.
int	getNodesCount() Returns the number of nodes in the graph.
boolean	isEdgeInGraph(org.gephi.graph.api.Edge edge) Checks if an edge is contained in the main view graph.
boolean	isNodeFixed(org.gephi.graph.api.Node node) Checks the fixed state of a node.
boolean	isNodeInGraph(org.gephi.graph.api.Node node) Checks if a node is contained in the main view graph.
org.gephi.graph.api.Node	mergeNodes(org.gephi.graph.api.Graph graph, org.gephi.graph.api.Node[] nodes, org.gephi.graph.api.Node selectedNode, org.gephi.graph.api.Column[] columns, AttributeRowsMergeStrategy[] mergeStrategies, boolean deleteMergedNodes) Merges 2 or more nodes into a new one node that has all the edges of the merged nodes.
private void	removeEdge(org.gephi.graph.api.Edge edge, org.gephi.graph.api.Graph graph)
private void	removeNode(org.gephi.graph.api.Node node, org.gephi.graph.api.Graph graph)
void	setNodeFixed(org.gephi.graph.api.Node node, boolean fixed) Sets the fixed state of a node to the indicated.
void	setNodesFixed(org.gephi.graph.api.Node[] nodes, boolean fixed) Sets the fixed state of an array of nodes to the indicated.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NODE_SIZE

private static final float DEFAULT_NODE_SIZE

See Also:

Constant Field Values

DEFAULT_EDGE_WEIGHT

private static final float DEFAULT_EDGE_WEIGHT

See Also:

Constant Field Values

Constructor Detail

GraphElementsControllerImpl

public GraphElementsControllerImpl()

Method Detail

createNode

public org.gephi.graph.api.Node createNode(String label)

Description copied from interface: GraphElementsController

Creates a node with default id and the given label in the current graph.

Specified by:

createNode in interface GraphElementsController

Parameters:

label - Label for the node

Returns:

The new created node

createNode

public org.gephi.graph.api.Node createNode(String label,
                                  org.gephi.graph.api.Graph graph)

Description copied from interface: GraphElementsController

Creates a node with default id and the given label.

Specified by:

createNode in interface GraphElementsController

Parameters:

label - Label for the node

graph - Graph to insert the node into

Returns:

The new created node

createNode

public org.gephi.graph.api.Node createNode(String label,
                                  String id)

Description copied from interface: GraphElementsController

Creates a node with the given id and label in the current graph.

If a node with that id already exists, no node will be created

Specified by:

createNode in interface GraphElementsController

Parameters:

label - Label for the node

id - Id for the node

Returns:

The new created node or null if a node with the given id already exists

createNode

public org.gephi.graph.api.Node createNode(String label,
                                  String id,
                                  org.gephi.graph.api.Graph graph)

Description copied from interface: GraphElementsController

Creates a node with the given id and label.

If a node with that id already exists, no node will be created

Specified by:

createNode in interface GraphElementsController

Parameters:

label - Label for the node

id - Id for the node

graph - Graph to insert the node into

Returns:

The new created node or null if a node with the given id already exists

duplicateNode

public org.gephi.graph.api.Node duplicateNode(org.gephi.graph.api.Node node)

Description copied from interface: GraphElementsController

Duplicates a node if it is in the graph, and returns the new node.

If the node has children, they are also copied as children of the new node.

Sets the same properties and attributes for the node as the original node: id, label and AttributeColumns with DATA AttributeOrigin. Does not copy AttributeColumns with COMPUTED AttributeOrigin.

Specified by:

duplicateNode in interface GraphElementsController

Parameters:

node - Node to copy

Returns:

New node

duplicateNodes

public void duplicateNodes(org.gephi.graph.api.Node[] nodes)

Description copied from interface: GraphElementsController

Tries to duplicate an array of nodes with the same behaviour as duplicateNode method.

Specified by:

duplicateNodes in interface GraphElementsController

Parameters:

nodes - Array of nodes to duplicate

createEdge

public org.gephi.graph.api.Edge createEdge(org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.

Specified by:

createEdge in interface GraphElementsController

Parameters:

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

Returns:

New edge if the edge was created succesfully, null otherwise

createEdge

public org.gephi.graph.api.Edge createEdge(org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed,
                                  org.gephi.graph.api.Graph graph)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected.

Specified by:

createEdge in interface GraphElementsController

Parameters:

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

graph - Graph to insert the node into

Returns:

New edge if the edge was created succesfully, null otherwise

createEdge

public org.gephi.graph.api.Edge createEdge(String id,
                                  org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected.

If a edge with the given id already exists, no edge will be created.

Specified by:

createEdge in interface GraphElementsController

Parameters:

id - Id for the new edge

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

Returns:

New edge if the edge was created succesfully, null otherwise

createEdge

public org.gephi.graph.api.Edge createEdge(org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed,
                                  Object typeLabel)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.

Specified by:

createEdge in interface GraphElementsController

Parameters:

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

typeLabel - Edge type label or null

Returns:

New edge if the edge was created succesfully, null otherwise

createEdge

public org.gephi.graph.api.Edge createEdge(org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed,
                                  Object typeLabel,
                                  org.gephi.graph.api.Graph graph)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected.

Specified by:

createEdge in interface GraphElementsController

Parameters:

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

typeLabel - Edge type label or null

graph - Graph to insert the node into

Returns:

New edge if the edge was created succesfully, null otherwise

createEdge

public org.gephi.graph.api.Edge createEdge(String id,
                                  org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed,
                                  Object typeLabel)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected.

If a edge with the given id already exists, no edge will be created.

Specified by:

createEdge in interface GraphElementsController

Parameters:

id - Id for the new edge

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

typeLabel - Edge type label or null

Returns:

New edge if the edge was created succesfully, null otherwise

createEdge

public org.gephi.graph.api.Edge createEdge(String id,
                                  org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed,
                                  org.gephi.graph.api.Graph graph)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.

If a edge with the given id already exists, no edge will be created.

Specified by:

createEdge in interface GraphElementsController

Parameters:

id - Id for the new edge

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

graph - Graph to insert the node into

Returns:

New edge if the edge was created succesfully, null otherwise

createEdge

public org.gephi.graph.api.Edge createEdge(String id,
                                  org.gephi.graph.api.Node source,
                                  org.gephi.graph.api.Node target,
                                  boolean directed,
                                  Object typeLabel,
                                  org.gephi.graph.api.Graph graph)

Description copied from interface: GraphElementsController

Creates and edge between source and target node (if it does not already exist), directed or undirected, in the current graph.

If a edge with the given id already exists, no edge will be created.

Specified by:

createEdge in interface GraphElementsController

Parameters:

id - Id for the new edge

source - Source node

target - Target node

directed - Indicates if the edge has to be directed

typeLabel - Edge type label or null

graph - Graph to insert the node into

Returns:

New edge if the edge was created succesfully, null otherwise

createEdges

public void createEdges(org.gephi.graph.api.Node source,
               org.gephi.graph.api.Node[] allNodes,
               boolean directed)

Description copied from interface: GraphElementsController

Tries to create edges between the source node and all other edges, directed or undirected.

An edge won't be created if it already exists or is a self-loop.

Specified by:

createEdges in interface GraphElementsController

Parameters:

source - Source node

allNodes - All edges

directed - Indicates if the edges have to be directed

deleteNode

public void deleteNode(org.gephi.graph.api.Node node)

Description copied from interface: GraphElementsController

Tries to delete a node checking first if it is on the graph.

Specified by:

deleteNode in interface GraphElementsController

Parameters:

node - Node to delete

deleteNodes

public void deleteNodes(org.gephi.graph.api.Node[] nodes)

Description copied from interface: GraphElementsController

Tries to delete an array of nodes checking first if they are on the graph.

Specified by:

deleteNodes in interface GraphElementsController

Parameters:

nodes - Array of nodes to delete

deleteEdge

public void deleteEdge(org.gephi.graph.api.Edge edge)

Description copied from interface: GraphElementsController

Tries to delete an edge checking first if it is on the graph.

Specified by:

deleteEdge in interface GraphElementsController

Parameters:

edge - Edge to delete

deleteEdges

public void deleteEdges(org.gephi.graph.api.Edge[] edges)

Description copied from interface: GraphElementsController

Tries to delete an array of edges checking first if they are on the graph.

Specified by:

deleteEdges in interface GraphElementsController

Parameters:

edges - Array of edges to delete

deleteEdgeWithNodes

public void deleteEdgeWithNodes(org.gephi.graph.api.Edge edge,
                       boolean deleteSource,
                       boolean deleteTarget)

Description copied from interface: GraphElementsController

Tries to delete an edge checking first if it is on the graph and also deletes its source and target node if it is indicated.

Specified by:

deleteEdgeWithNodes in interface GraphElementsController

Parameters:

edge - Edge to delete

deleteSource - Indicates if the source node has to be deleted

deleteTarget - Indicates if the target node has to be deleted

deleteEdgesWithNodes

public void deleteEdgesWithNodes(org.gephi.graph.api.Edge[] edges,
                        boolean deleteSource,
                        boolean deleteTarget)

Description copied from interface: GraphElementsController

Tries to delete an array of edges checking first if they are on the graph and also deletes their source and target node if it is indicated.

Specified by:

deleteEdgesWithNodes in interface GraphElementsController

Parameters:

edges - Array of edges to delete

deleteSource - Indicates if the source nodes have to be deleted

deleteTarget - Indicates if the target nodes have to be deleted

mergeNodes

public org.gephi.graph.api.Node mergeNodes(org.gephi.graph.api.Graph graph,
                                  org.gephi.graph.api.Node[] nodes,
                                  org.gephi.graph.api.Node selectedNode,
                                  org.gephi.graph.api.Column[] columns,
                                  AttributeRowsMergeStrategy[] mergeStrategies,
                                  boolean deleteMergedNodes)

Description copied from interface: GraphElementsController

Merges 2 or more nodes into a new one node that has all the edges of the merged nodes. An AttributeRowsMergeStrategy must be provided for each column of the nodes.

Specified by:

mergeNodes in interface GraphElementsController

Parameters:

graph - Graph that contains the nodes

nodes - Nodes to merge (at least 1)

selectedNode - Main selected node of the nodes to merge (or null to use first node)

columns - Columns to apply a merge strategy in each row

mergeStrategies - Strategies to merge rows of each column in columns

deleteMergedNodes - Indicates if merged nodes should be deleted

Returns:

New resulting node

setNodeFixed

public void setNodeFixed(org.gephi.graph.api.Node node,
                boolean fixed)

Description copied from interface: GraphElementsController

Sets the fixed state of a node to the indicated.

Specified by:

setNodeFixed in interface GraphElementsController

Parameters:

node - Node to set fixed state

fixed - Fixed state for the node

setNodesFixed

public void setNodesFixed(org.gephi.graph.api.Node[] nodes,
                 boolean fixed)

Description copied from interface: GraphElementsController

Sets the fixed state of an array of nodes to the indicated.

Specified by:

setNodesFixed in interface GraphElementsController

Parameters:

nodes - Array of nodes to set fixed state

fixed - Fixed state for the nodes

isNodeFixed

public boolean isNodeFixed(org.gephi.graph.api.Node node)

Description copied from interface: GraphElementsController

Checks the fixed state of a node.

Specified by:

isNodeFixed in interface GraphElementsController

Parameters:

node - Node to check

Returns:

Fixed state of the node

getNodeNeighbours

public org.gephi.graph.api.Node[] getNodeNeighbours(org.gephi.graph.api.Node node)

Description copied from interface: GraphElementsController

Prepares and returns an array with the neighbour nodes of the specified node.

Specified by:

getNodeNeighbours in interface GraphElementsController

Parameters:

node - Node to get neighbours

Returns:

Array of neighbour nodes

getNodeEdges

public org.gephi.graph.api.Edge[] getNodeEdges(org.gephi.graph.api.Node node)

Description copied from interface: GraphElementsController

Prepares and returns an array with the edges incident to the specified node.

Specified by:

getNodeEdges in interface GraphElementsController

Parameters:

node - Node to get edges

Returns:

Array of incident edges

getNodesCount

public int getNodesCount()

Description copied from interface: GraphElementsController

Returns the number of nodes in the graph.

Specified by:

getNodesCount in interface GraphElementsController

Returns:

Nodes count

getEdgesCount

public int getEdgesCount()

Description copied from interface: GraphElementsController

Returns the number of edges in the graph.

Specified by:

getEdgesCount in interface GraphElementsController

Returns:

Edges count

isNodeInGraph

public boolean isNodeInGraph(org.gephi.graph.api.Node node)

Description copied from interface: GraphElementsController

Checks if a node is contained in the main view graph.

Specified by:

isNodeInGraph in interface GraphElementsController

Parameters:

node - Node to check

Returns:

True if the node is in the graph, false otherwise

areNodesInGraph

public boolean areNodesInGraph(org.gephi.graph.api.Node[] nodes)

Description copied from interface: GraphElementsController

Checks if an array of nodes are contained in the main view graph.

Specified by:

areNodesInGraph in interface GraphElementsController

Parameters:

nodes - Array of nodes to check

Returns:

True if all the nodes are in the graph, false otherwise

isEdgeInGraph

public boolean isEdgeInGraph(org.gephi.graph.api.Edge edge)

Description copied from interface: GraphElementsController

Checks if an edge is contained in the main view graph.

Specified by:

isEdgeInGraph in interface GraphElementsController

Parameters:

edge - Edge to check

Returns:

True if the edge is in the graph, false otherwise

areEdgesInGraph

public boolean areEdgesInGraph(org.gephi.graph.api.Edge[] edges)

Description copied from interface: GraphElementsController

Checks if an array of edges are contained in the main view graph.

Specified by:

areEdgesInGraph in interface GraphElementsController

Parameters:

edges - Edges to check

Returns:

True if all the edges are in the graph, false otherwise

getCurrentGraph

private org.gephi.graph.api.Graph getCurrentGraph()

**********Private methods : ***********

buildNode

private org.gephi.graph.api.Node buildNode(org.gephi.graph.api.Graph graph,
                                 String label)

buildNode

private org.gephi.graph.api.Node buildNode(org.gephi.graph.api.Graph graph,
                                 String label,
                                 String id)

buildEdge

private org.gephi.graph.api.Edge buildEdge(org.gephi.graph.api.Graph graph,
                                 String id,
                                 org.gephi.graph.api.Node source,
                                 org.gephi.graph.api.Node target,
                                 boolean directed,
                                 Object typeLabel)

copyNode

private org.gephi.graph.api.Node copyNode(org.gephi.graph.api.Node node,
                                org.gephi.graph.api.Graph graph)

removeNode

private void removeNode(org.gephi.graph.api.Node node,
              org.gephi.graph.api.Graph graph)

removeEdge

private void removeEdge(org.gephi.graph.api.Edge edge,
              org.gephi.graph.api.Graph graph)