org.dice_research.ldcbench.graph

Interface GraphBuilder

All Superinterfaces:

Graph

All Known Implementing Classes:

GrphBasedGraph

public interface GraphBuilder
extends Graph

An extension of the Graph interface offering methods for the addition of nodes and edges.

Author:

Michael Röder (michael.roeder@uni-paderborn.de)

Field Summary

Fields inherited from interface org.dice_research.ldcbench.graph.Graph

INTERNAL_NODE_GRAPH_ID

Method Summary

Modifier and Type	Method and Description
boolean	addEdge(int sourceId, int targetId, int typeId) Adds a new edge with the given information if possible.
int	addNode() Adds a new node to the graph and returns its ID.
int[]	addNodes(int nodeCount) Adds the given number of nodes to the graph and returns the range of node IDs.
default Graph	build() Returns a Graph instance based on the graph data that the builder collected until now.
void	setEntranceNodes(int[] entranceNodes) Sets the IDs of the entrance nodes (i.e., nodes from which all other nodes can be reached).
void	setGraphIdOfNode(int nodeId, int graphId, int externalId) Sets the graph ID of the given node.

Methods inherited from interface org.dice_research.ldcbench.graph.Graph

getEntranceNodes, getExternalNodeId, getGraphId, getNumberOfEdges, getNumberOfNodes, incomingEdgeSources, incomingEdgeTypes, outgoingEdgeTargets, outgoingEdgeTypes

Method Detail

build

default Graph build()

Returns a Graph instance based on the graph data that the builder collected until now. This instance might offer a faster implementation than the builder class.

Returns:

a Graph instance containing the built graph.

addEdge

boolean addEdge(int sourceId,
                int targetId,
                int typeId)

Adds a new edge with the given information if possible. Returns true if the edge could be added.

Parameters:

sourceId - the id of the source node

targetId - the id of the target node

typeId - the type id of the edge

Returns:

true if the edge could be added. Otherwise false is returned.

addNode

int addNode()

Adds a new node to the graph and returns its ID.

Returns:

the ID of the newly created node

addNodes

int[] addNodes(int nodeCount)

Adds the given number of nodes to the graph and returns the range of node IDs.

Parameters:

nodeCount - the number of nodes that should be added

Returns:

the range of IDs from the first added node ([0], inclusive) to the first node after the last added node ([1], exclusive).

setEntranceNodes

void setEntranceNodes(int[] entranceNodes)

Sets the IDs of the entrance nodes (i.e., nodes from which all other nodes can be reached).

Parameters:

entranceNodes - the IDs of the entrance nodes

setGraphIdOfNode

void setGraphIdOfNode(int nodeId,
                      int graphId,
                      int externalId)

Sets the graph ID of the given node. By default, all nodes have Graph.INTERNAL_NODE_GRAPH_ID as graph ID meaning that they are part of this graph. However, to mark external nodes (i.e., nodes that are not part of this graph but are linked from one of the nodes of this graph), this method can be used to store their graph ID as well as their ID in the other graph.

Parameters:

nodeId - the ID of the node in this graph

graphId - the ID of the graph in the other graph. Use Graph.INTERNAL_NODE_GRAPH_ID to delete the marking of a node being external.

externalId - the ID of this node inside the other graph (only used if the graphID != Graph.INTERNAL_NODE_GRAPH_ID)