Gephi Toolkit Javadoc

org.gephi.io.exporter.plugin
Class ExporterGML

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

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

Author:
megaterik

Constructor Summary
ExporterGML()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 boolean execute()
          Run the export process.
 int getSpaces()
           
 Workspace getWorkspace()
          Returns the workspace from where data are exported
 boolean isExportColor()
           
 boolean isExportCoordinates()
           
 boolean isExportEdgeSize()
           
 boolean isExportLabel()
           
 boolean isExportNodeSize()
           
 boolean isExportNotRecognizedElements()
           
 boolean isExportVisible()
          Returns true if only the visible graph has to be exported.
 boolean isNormalize()
           
 void setExportColor(boolean exportColor)
           
 void setExportCoordinates(boolean exportCoordinates)
           
 void setExportEdgeSize(boolean exportEdgeSize)
           
 void setExportLabel(boolean exportLabel)
           
 void setExportNodeSize(boolean exportNodeSize)
           
 void setExportNotRecognizedElements(boolean exportNotRecognizedElements)
           
 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 setSpaces(int spaces)
           
 void setWorkspace(Workspace workspace)
          Sets the worksapce from where to export data
 void setWriter(java.io.Writer writer)
          Set the writer where to export.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExporterGML

public ExporterGML()
Method Detail

isNormalize

public boolean isNormalize()

setNormalize

public void setNormalize(boolean normalize)

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

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.

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

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

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

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

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

isExportColor

public boolean isExportColor()

setExportColor

public void setExportColor(boolean exportColor)

isExportCoordinates

public boolean isExportCoordinates()

setExportCoordinates

public void setExportCoordinates(boolean exportCoordinates)

isExportEdgeSize

public boolean isExportEdgeSize()

setExportEdgeSize

public void setExportEdgeSize(boolean exportEdgeSize)

isExportLabel

public boolean isExportLabel()

setExportLabel

public void setExportLabel(boolean exportLabel)

isExportNodeSize

public boolean isExportNodeSize()

setExportNodeSize

public void setExportNodeSize(boolean exportNodeSize)

isExportNotRecognizedElements

public boolean isExportNotRecognizedElements()

setExportNotRecognizedElements

public void setExportNotRecognizedElements(boolean exportNotRecognizedElements)

getSpaces

public int getSpaces()

setSpaces

public void setSpaces(int spaces)

Gephi Toolkit Javadoc