org.gephi.io.generator.spi

Interface Generator

All Superinterfaces:

LongTask

public interface Generator
extends LongTask

Define a generator, that is generating graph structure from a bunch of parameters.

Extends LongTask to support tasks progress and cancellation.

Author:

Mathieu Bastian

Method Summary

Modifier and Type	Method and Description
void	generate(ContainerLoader container) Main method that generates the graph and put it in the container.
String	getName() Returns the generator display name.
GeneratorUI	getUI() Returns the UI that belongs to this generator, or null if UI is not needed.

Methods inherited from interface org.gephi.utils.longtask.spi.LongTask

cancel, setProgressTicket

Method Detail

generate

void generate(ContainerLoader container)

Main method that generates the graph and put it in the container.

From the container content, the controller makes verification and append the graph to GraphAPI.

Parameters:

container - the container the graph is to be pushed

getName

String getName()

Returns the generator display name.

Returns:

returns the generator name

getUI

GeneratorUI getUI()

Returns the UI that belongs to this generator, or null if UI is not needed.

Returns:

the UI thet belongs to this generator, or null