Gephi Toolkit Javadoc

org.gephi.io.exporter.plugin
Class ExporterGraphML

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

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

Author:
Sebastien Heymann, Mathieu Bastian

Constructor Summary
ExporterGraphML()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 org.w3c.dom.Document createDocument()
           
 boolean execute()
          Run the export process.
 boolean exportData(org.w3c.dom.Document document, HierarchicalGraph graph, AttributeModel model)
           
 FileType[] getFileTypes()
           
 java.lang.String getName()
           
 Workspace getWorkspace()
          Returns the workspace from where data are exported
 boolean isExportAttributes()
           
 boolean isExportColors()
           
 boolean isExportHierarchy()
           
 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 setExportHierarchy(boolean exportHierarchy)
           
 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(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

ExporterGraphML

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

createDocument

public org.w3c.dom.Document createDocument()
                                    throws javax.xml.parsers.ParserConfigurationException
Throws:
javax.xml.parsers.ParserConfigurationException

exportData

public boolean exportData(org.w3c.dom.Document document,
                          HierarchicalGraph graph,
                          AttributeModel model)
                   throws java.lang.Exception
Throws:
java.lang.Exception

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 java.lang.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)

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.

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

isExportHierarchy

public boolean isExportHierarchy()

setExportHierarchy

public void setExportHierarchy(boolean exportHierarchy)

Gephi Toolkit Javadoc