org.gephi.io.importer.plugin.file

Class ImporterDL

java.lang.Object

org.gephi.io.importer.plugin.file.ImporterDL

All Implemented Interfaces:

FileImporter, Importer, LongTask

public class ImporterDL
extends Object
implements FileImporter, LongTask

Author:

Mathieu Bastian

Nested Class Summary

Nested classes/interfaces inherited from interface org.gephi.io.importer.spi.FileImporter

FileImporter.FileAware

Constructor Summary

Constructors

Constructor and Description
ImporterDL()

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel the task.
boolean	execute(ContainerLoader container) Run the import process.
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(Reader reader) Sets the reader where characters can be retrieved.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImporterDL

public ImporterDL()

Method Detail

execute

public boolean execute(ContainerLoader container)

Description copied from interface: Importer

Run the import process.

Specified by:

execute in interface Importer

Parameters:

container - the container where imported data will be pushed

Returns:

true if the import is successful or false if it has been cancelled

setReader

public void setReader(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