org.gephi.io.importer.plugin.file.spreadsheet

Class AbstractImporterSpreadsheet

java.lang.Object

org.gephi.io.importer.plugin.file.spreadsheet.AbstractImporterSpreadsheet

All Implemented Interfaces:

FileImporter, FileImporter.FileAware, Importer, LongTask

Direct Known Subclasses:

ImporterSpreadsheetCSV, ImporterSpreadsheetExcel

public abstract class AbstractImporterSpreadsheet
extends Object
implements FileImporter, FileImporter.FileAware, LongTask

Author:

Eduardo Ramos

Nested Class Summary

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

FileImporter.FileAware

Constructor Summary

Constructors

Constructor and Description
AbstractImporterSpreadsheet()

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel the task.
abstract SheetParser	createParser()
abstract SheetParser	createParserWithoutHeaders()
boolean	execute(ContainerLoader container) Run the import process.
Class	getColumnClass(String column)
Map<String,Class>	getColumnsClasses()
ContainerLoader	getContainer() Returns the import container.
File	getFile()
List<SheetRow>	getFirstRows(int maxRows)
List<SheetRow>	getFirstRows(SheetParser parser, int maxRows)
Map<String,Integer>	getHeadersMap()
SpreadsheetGeneralConfiguration.Mode	getMode()
Report	getReport() Returns the import report, filled with logs and potential issues.
org.gephi.graph.api.TimeRepresentation	getTimeRepresentation()
org.joda.time.DateTimeZone	getTimeZone()
void	refreshAutoDetections()
void	setColumnClass(String column, Class clazz)
void	setColumnsClasses(Map<String,Class> columnsClasses)
void	setFile(File file) Called before showing the ImporterUI and before executing the importer.
void	setMode(SpreadsheetGeneralConfiguration.Mode table)
void	setProgressTicket(ProgressTicket progressTicket) Set the progress ticket for the long task.
void	setReader(Reader reader) Sets the reader where characters can be retrieved.
void	setTimeRepresentation(org.gephi.graph.api.TimeRepresentation timeRepresentation)
void	setTimeZone(org.joda.time.DateTimeZone timeZone)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractImporterSpreadsheet

public AbstractImporterSpreadsheet()

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

createParser

public abstract SheetParser createParser()
                                  throws IOException

Throws:

IOException

createParserWithoutHeaders

public abstract SheetParser createParserWithoutHeaders()
                                                throws IOException

Throws:

IOException

getHeadersMap

public Map<String,Integer> getHeadersMap()
                                  throws IOException

Throws:

IOException

getFirstRows

public List<SheetRow> getFirstRows(int maxRows)
                            throws IOException

Throws:

IOException

getFirstRows

public List<SheetRow> getFirstRows(SheetParser parser,
                                   int maxRows)
                            throws IOException

Throws:

IOException

refreshAutoDetections

public void refreshAutoDetections()

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

setFile

public void setFile(File file)

Description copied from interface: FileImporter.FileAware

Called before showing the ImporterUI and before executing the importer.

Specified by:

setFile in interface FileImporter.FileAware

Parameters:

file - Source file

getFile

public File getFile()

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

getMode

public SpreadsheetGeneralConfiguration.Mode getMode()

setMode

public void setMode(SpreadsheetGeneralConfiguration.Mode table)

getTimeRepresentation

public org.gephi.graph.api.TimeRepresentation getTimeRepresentation()

setTimeRepresentation

public void setTimeRepresentation(org.gephi.graph.api.TimeRepresentation timeRepresentation)

getTimeZone

public org.joda.time.DateTimeZone getTimeZone()

setTimeZone

public void setTimeZone(org.joda.time.DateTimeZone timeZone)

getColumnsClasses

public Map<String,Class> getColumnsClasses()

setColumnsClasses

public void setColumnsClasses(Map<String,Class> columnsClasses)

getColumnClass

public Class getColumnClass(String column)

setColumnClass

public void setColumnClass(String column,
                           Class clazz)