Package org.gephi.io.exporter.spi

Interfaces for creating new data exporters.

See: Description

Interface Summary

Interface	Description
ByteExporter	Exporter class for byte streams, when an OutputStream is needed.
CharacterExporter	Exporter class for char streams, when an Writer is needed.
Exporter	Define a class that can export data.
ExporterBuilder	Factory class for building exporter instances.
ExporterUI	Define exporter settings user interface.
FileExporterBuilder	Exporter builder for a particular file format support.
GraphExporter	Exporter interface for exporters that export the graph, either complete or filtered (i.e.
GraphFileExporterBuilder	Exporter builder for graph file format support.
VectorExporter	Exporter interface for exporters that export vector graphics.
VectorFileExporterBuilder	Exporter builder for vector file format support.

Package org.gephi.io.exporter.spi Description

Interfaces for creating new data exporters.

Create a new Exporter

1. Create a new module and set Export API, Project API and Utilities API as dependencies.
2. Create a new builder class, which implements:
   • GraphFileExporterBuilder (graph)
   • VectorFileExporterBuilder (vector graphics)
   • ExportBuilder (custom)
3. Add @ServiceProvider annotation to your class to declare you are implementing an Exporter service. Put GraphFileExporterBuilder.class as the annotation service parameter for graph files, VectorFileExporterBuilder.class for vector graphics and ExportBuilder.class for the rest.
4. Create a new exporter class, which implements GraphExporter, VectorExporter or simply Exporter.
5. Implement also ByteExporter interface for byte streams or CharacterExporter for texts.
6. In the builder, return a new instance of your exporter in the buildExporter() method.
7. For settings UI, create a new ExporterUI implementation and add the @ServiceProvider annotation to it.

To let your export task be cancelled and its progress watched, implement LongTask interface. Add LongTask API as dependency to your module first.