org.graphstream.algorithm.generator

Class LobsterGenerator

java.lang.Object

org.graphstream.stream.SourceBase

org.graphstream.algorithm.generator.BaseGenerator

org.graphstream.algorithm.generator.LobsterGenerator

All Implemented Interfaces:

Generator, org.graphstream.stream.Source

public class LobsterGenerator
extends BaseGenerator

Generate a Lobster tree. Lobster are trees where the distance between any node and a root path is less than 2. In this generator, the max distance can be customized.

Nested Class Summary

Nested classes/interfaces inherited from class org.graphstream.stream.SourceBase

org.graphstream.stream.SourceBase.ElementType

Constructor Summary

Constructors

Constructor and Description
LobsterGenerator() Main constructor to a Lobster generator.
LobsterGenerator(int maxDistance) Constructor allowing to customize maximum distance to the root path.
LobsterGenerator(int maxDistance, int maxDegree) Constructor allowing to customize maximum distance to the root path and maximum degree of nodes.

Method Summary

Modifier and Type	Method and Description
void	begin() Begin the graph generation.
boolean	nextEvents() Perform the next step in generating the graph.

Methods inherited from class org.graphstream.algorithm.generator.BaseGenerator

addEdgeAttribute, addEdgeAttribute, addEdgeAttribute, addEdgeLabels, addNodeAttribute, addNodeAttribute, addNodeAttribute, addNodeLabels, end, isUsingInternalGraph, removeEdgeAttribute, removeNodeAttribute, setDirectedEdges, setRandomSeed, setUseInternalGraph

Methods inherited from class org.graphstream.stream.SourceBase

addAttributeSink, addElementSink, addSink, attributeSinks, clearAttributeSinks, clearElementSinks, clearSinks, elementSinks, removeAttributeSink, removeElementSink, removeSink, sendAttributeChangedEvent, sendAttributeChangedEvent, sendEdgeAdded, sendEdgeAdded, sendEdgeAttributeAdded, sendEdgeAttributeAdded, sendEdgeAttributeChanged, sendEdgeAttributeChanged, sendEdgeAttributeRemoved, sendEdgeAttributeRemoved, sendEdgeRemoved, sendEdgeRemoved, sendGraphAttributeAdded, sendGraphAttributeAdded, sendGraphAttributeChanged, sendGraphAttributeChanged, sendGraphAttributeRemoved, sendGraphAttributeRemoved, sendGraphCleared, sendGraphCleared, sendNodeAdded, sendNodeAdded, sendNodeAttributeAdded, sendNodeAttributeAdded, sendNodeAttributeChanged, sendNodeAttributeChanged, sendNodeAttributeRemoved, sendNodeAttributeRemoved, sendNodeRemoved, sendNodeRemoved, sendStepBegins, sendStepBegins

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graphstream.stream.Source

addAttributeSink, addElementSink, addSink, clearAttributeSinks, clearElementSinks, clearSinks, removeAttributeSink, removeElementSink, removeSink

Constructor Detail

LobsterGenerator

public LobsterGenerator()

Main constructor to a Lobster generator.

LobsterGenerator

public LobsterGenerator(int maxDistance,
                        int maxDegree)

Constructor allowing to customize maximum distance to the root path and maximum degree of nodes.

Parameters:

maxDistance - max distance to root path

maxDegree - max degree of nodes

LobsterGenerator

public LobsterGenerator(int maxDistance)

Constructor allowing to customize maximum distance to the root path.

Parameters:

maxDistance - max distance to root path

Method Detail

begin

public void begin()

Description copied from interface: Generator

Begin the graph generation. This usually is the place for initialization of the generator. After calling this method, call the Generator.nextEvents() method to add elements to the graph.

nextEvents

public boolean nextEvents()

Description copied from interface: Generator

Perform the next step in generating the graph. While this method returns true, there are still more elements to add to the graph to generate it. Be careful that some generators never return false here, since they can generate graphs of arbitrary size. For such generators, simply stop calling this method when enough elements have been generated. A call to this method can produce an undetermined number of nodes and edges. Checking nodes count is advisable when generating the graph to avoid an unwanted big graph.

Returns:

true while there are elements to add to the graph.