org.gephi.io.exporter.plugin

Class ExporterGEXF

java.lang.Object

org.gephi.io.exporter.plugin.ExporterGEXF

All Implemented Interfaces:

CharacterExporter, Exporter, GraphExporter, LongTask

public class ExporterGEXF
extends Object
implements GraphExporter, CharacterExporter, LongTask

Author:

Mathieu Bastian, Sébastien Heymann

Constructor Summary

Constructors

Constructor and Description
ExporterGEXF()

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel the task.
boolean	execute() Run the export process.
FileType[]	getFileTypes()
String	getName()
Workspace	getWorkspace() Returns the workspace from where data are exported
boolean	isExportAttributes()
boolean	isExportColors()
boolean	isExportDynamic()
boolean	isExportPosition()
boolean	isExportSize()
boolean	isExportVisible() Returns true if only the visible graph has to be exported.
boolean	isNormalize()
void	setExportAttributes(boolean exportAttributes)
void	setExportColors(boolean exportColors)
void	setExportDynamic(boolean exportDynamic)
void	setExportPosition(boolean exportPosition)
void	setExportSize(boolean exportSize)
void	setExportVisible(boolean exportVisible) Sets if only the visible graph has to be exported.
void	setNormalize(boolean normalize)
void	setProgressTicket(ProgressTicket progressTicket) Set the progress ticket for the long task.
void	setWorkspace(Workspace workspace) Sets the worksapce from where to export data
void	setWriter(Writer writer) Set the writer where to export.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExporterGEXF

public ExporterGEXF()

Method Detail

execute

public boolean execute()

Description copied from interface: Exporter

Run the export process.

Specified by:

execute in interface Exporter

Returns:

true if the operation is successful, false if it has been cancelled

cancel

public boolean cancel()

Description copied from interface: LongTask

Cancel the task. Returns true if the task has been sucessfully cancelled, false otherwise.

Specified by:

cancel in interface LongTask

Returns:

true if the task has been sucessfully cancelled, false otherwise

setProgressTicket

public void setProgressTicket(ProgressTicket progressTicket)

Description copied from interface: LongTask

Set the progress ticket for the long task. Can't be null.

Specified by:

setProgressTicket in interface LongTask

Parameters:

progressTicket - the progress ticket for this task

getName

public String getName()

getFileTypes

public FileType[] getFileTypes()

setExportAttributes

public void setExportAttributes(boolean exportAttributes)

setExportColors

public void setExportColors(boolean exportColors)

setExportPosition

public void setExportPosition(boolean exportPosition)

setExportSize

public void setExportSize(boolean exportSize)

setNormalize

public void setNormalize(boolean normalize)

setExportDynamic

public void setExportDynamic(boolean exportDynamic)

isExportAttributes

public boolean isExportAttributes()

isExportColors

public boolean isExportColors()

isExportPosition

public boolean isExportPosition()

isExportSize

public boolean isExportSize()

isNormalize

public boolean isNormalize()

isExportVisible

public boolean isExportVisible()

Description copied from interface: GraphExporter

Returns true if only the visible graph has to be exported.

Specified by:

isExportVisible in interface GraphExporter

Returns:

true if only the visible graph has to be exported, false for the complete graph.

isExportDynamic

public boolean isExportDynamic()

setExportVisible

public void setExportVisible(boolean exportVisible)

Description copied from interface: GraphExporter

Sets if only the visible graph has to be exported. If false, the complete graph is exported.

Specified by:

setExportVisible in interface GraphExporter

Parameters:

exportVisible - the export visible parameter value

setWriter

public void setWriter(Writer writer)

Description copied from interface: CharacterExporter

Set the writer where to export.

Specified by:

setWriter in interface CharacterExporter

Parameters:

writer - the writer the exporter is to write

getWorkspace

public Workspace getWorkspace()

Description copied from interface: Exporter

Returns the workspace from where data are exported

Specified by:

getWorkspace in interface Exporter

Returns:

the workspace the data are to be exported

setWorkspace

public void setWorkspace(Workspace workspace)

Description copied from interface: Exporter

Sets the worksapce from where to export data

Specified by:

setWorkspace in interface Exporter

Parameters:

workspace - the workspace to export