Gephi Toolkit Javadoc

org.gephi.io.exporter.plugin
Class ExporterCSV

java.lang.Object
  extended by org.gephi.io.exporter.plugin.ExporterCSV
All Implemented Interfaces:
CharacterExporter, Exporter, GraphExporter, LongTask

public class ExporterCSV
extends java.lang.Object
implements GraphExporter, CharacterExporter, LongTask

Author:
Mathieu Bastian

Constructor Summary
ExporterCSV()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 boolean execute()
          Run the export process.
 Workspace getWorkspace()
          Returns the workspace from where data are exported
 boolean isEdgeWeight()
           
 boolean isExportVisible()
          Returns true if only the visible graph has to be exported.
 boolean isHeader()
           
 boolean isList()
           
 boolean isWriteZero()
           
 void setEdgeWeight(boolean edgeWeight)
           
 void setExportVisible(boolean exportVisible)
          Sets if only the visible graph has to be exported.
 void setHeader(boolean header)
           
 void setList(boolean list)
           
 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(java.io.Writer writer)
          Set the writer where to export.
 void setWriteZero(boolean writeZero)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExporterCSV

public ExporterCSV()
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

isEdgeWeight

public boolean isEdgeWeight()

setEdgeWeight

public void setEdgeWeight(boolean edgeWeight)

isHeader

public boolean isHeader()

setHeader

public void setHeader(boolean header)

isWriteZero

public boolean isWriteZero()

setWriteZero

public void setWriteZero(boolean writeZero)

isList

public boolean isList()

setList

public void setList(boolean list)

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.

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(java.io.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

Gephi Toolkit Javadoc