Gephi Toolkit Javadoc

org.gephi.io.importer.plugin.file
Class ImporterGML

java.lang.Object
  extended by org.gephi.io.importer.plugin.file.ImporterGML
All Implemented Interfaces:
FileImporter, Importer, LongTask

public class ImporterGML
extends java.lang.Object
implements FileImporter, LongTask


Constructor Summary
ImporterGML()
           
 
Method Summary
 boolean cancel()
          Cancel the task.
 boolean execute(ContainerLoader container)
          Run the import processus.
 ContainerLoader getContainer()
          Returns the import container.
 Report getReport()
          Returns the import report, filled with logs and potential issues.
 void setProgressTicket(ProgressTicket progressTicket)
          Set the progress ticket for the long task.
 void setReader(java.io.Reader reader)
          Sets the reader where characters can be retrieved.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImporterGML

public ImporterGML()
Method Detail

execute

public boolean execute(ContainerLoader container)
Description copied from interface: Importer
Run the import processus.

Specified by:
execute in interface Importer
Parameters:
container - the container where imported data will be pushed
Returns:
true if the import is successfull or false if it has been cancelled

setReader

public void setReader(java.io.Reader reader)
Description copied from interface: FileImporter
Sets the reader where characters can be retrieved.

Specified by:
setReader in interface FileImporter
Parameters:
reader - the reader on data

getContainer

public ContainerLoader getContainer()
Description copied from interface: Importer
Returns the import container. The container is the import "result", all data found during import are being pushed to the container.

Specified by:
getContainer in interface Importer
Returns:
the import container

getReport

public Report getReport()
Description copied from interface: Importer
Returns the import report, filled with logs and potential issues.

Specified by:
getReport in interface Importer
Returns:
the import report

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

Gephi Toolkit Javadoc