Package dk.gtz.graphedit.spi

Interface IImporter

public interface IImporter

An importer interface for importing / converting non-graphedit projects to graphedit format. Note that none of the functions should actually save to disk.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	IImporter.FiletypesFilter	A filter object for representing supported filetypes.
static final record	IImporter.ImportResult	A result object for representing the result of an import.

Method Summary

Modifier and Type	Method	Description
default IImporter.FiletypesFilter	getFiletypesFilter()	Get the supported filetypes.
String	getName()	Get the target project type that the importer can import.
List<IImporter.ImportResult>	importFiles(List<File> importPaths)	Converts a series of model files to graphedit format and imports them into the currently open project.

Method Details

getFiletypesFilter

default IImporter.FiletypesFilter getFiletypesFilter()

Get the supported filetypes.

Returns:

A filetypes filter object with a description and at least one extension

getName

String getName()

Get the target project type that the importer can import. This will be used in the importer drop-down UI.

Returns:

A string name of the type of project that this importer can import.

importFiles

List<IImporter.ImportResult> importFiles(List<File> importPaths)
                                  throws ImportException

Converts a series of model files to graphedit format and imports them into the currently open project.

Parameters:

importPaths - List of path to either a folder or file to convert.

Returns:

A new project resource in graphedit format.

Throws:

ImportException - if something went wrong during the import.