Package es.uam.eps.ir.relison.sna.community.graph

Class SimpleCommunityGraphGenerator<U>

java.lang.Object

es.uam.eps.ir.relison.sna.community.graph.SimpleCommunityGraphGenerator<U>

Type Parameters:

U - type of the users.

All Implemented Interfaces:

GraphGenerator<java.lang.Integer>

public class SimpleCommunityGraphGenerator<U>
extends java.lang.Object
implements GraphGenerator<java.lang.Integer>

Generates a community graph, which has, at most, a single link between each pair of communities (including auto-loops). The weight of the corresponding graph is the sum of the weight of the links between communities.

Field Summary

Fields

Modifier and Type	Field	Description
private Communities<U>	comm	A community partition.
private boolean	configured	true if the generator has been configured, false otherwise.
private boolean	directed	true if we have to take into account the real directionality of the graph, false if the graph has to be undirected.
private Graph<U>	graph	The graph.

Constructor Summary

Constructors

Constructor	Description
SimpleCommunityGraphGenerator()

Method Summary

Modifier and Type	Method	Description
void	configure(Graph<U> graph, Communities<U> comm, boolean directed)	Configures the generator.
void	configure(java.lang.Object... configuration)	Configures the generator.
Graph<java.lang.Integer>	generate()	Generates a graph.

Methods inherited from class java.lang.Object

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

Field Details

graph

private Graph<U> graph

The graph.

comm

private Communities<U> comm

A community partition.

directed

private boolean directed

true if we have to take into account the real directionality of the graph, false if the graph has to be undirected.

configured

private boolean configured

true if the generator has been configured, false otherwise.

Constructor Details

SimpleCommunityGraphGenerator

public SimpleCommunityGraphGenerator()

Method Details

configure

public void configure(java.lang.Object... configuration)

Description copied from interface: GraphGenerator

Configures the generator.

Specified by:

configure in interface GraphGenerator<U>

Parameters:

configuration - An array containing the configuration parameters.

configure

public void configure(Graph<U> graph, Communities<U> comm, boolean directed)

Configures the generator.

Parameters:

graph - the graph.

comm - the community partition.

directed - true if we have to take communities into account.

generate

public Graph<java.lang.Integer> generate() throws GeneratorNotConfiguredException, GeneratorBadConfiguredException

Description copied from interface: GraphGenerator

Generates a graph.

Specified by:

generate in interface GraphGenerator<U>

Returns:

the generated graph.

Throws:

GeneratorNotConfiguredException - The generator is not configured.

GeneratorBadConfiguredException - The generator parameters are incorretct.