org.gephi.project.spi

Interface WorkspacePersistenceProvider

public interface WorkspacePersistenceProvider

Interface modules implement to notify the system they can read/write part of the .gephi project file to serialize states and data.

How saving a project works

1. The saving task is looking for all implementations of this interface and asks to return an XML element that represents data for each workspace.
2. All of these elements are written in the .gephi project file.

How loading a project works

1. The loading task is looking for all implementations of this interface and asks for the identifier returned by getIdentifier().
2. When traversing the gephi project XML document it tries to match markups with identifiers. When match, call this provider readXML() method with the XML element.

Thus this interface allows any module to serialize and deserialize its data to gephi project files.

In order to have your WorkspacePersistenceProvider called, you must annotate it with @ServiceProvider(service = WorkspacePersistenceProvider.class, position = xy)

The position parameter is optional but often useful when when you need other WorkspacePersistenceProvider data deserialized before yours.

Author:

Mathieu Bastian

See Also:

Workspace

Method Summary

Methods

Modifier and Type	Method and Description
String	getIdentifier() Unique XML tag identifier for your WorkspacePersistenceProvider
void	readXML(XMLStreamReader reader, Workspace workspace) This is automatically called when a start element with the tag name provided in your getIdentifier method.
void	writeXML(XMLStreamWriter writer, Workspace workspace) This is automatically called when saving a project file.

Method Detail

writeXML

void writeXML(XMLStreamWriter writer,
            Workspace workspace)

This is automatically called when saving a project file.

Your implementation must enclose all your data xml in a tag with the name provided in your getIdentifier method.

Parameters:

writer - XMLStreamWriter for xml serialization of this persistence provider data

workspace - Current workspace being serialized

readXML

void readXML(XMLStreamReader reader,
           Workspace workspace)

This is automatically called when a start element with the tag name provided in your getIdentifier method.

Your implementation must detect the tag end element to stop reading.

Parameters:

reader - XMLStreamReader for deserialization of this persistence provider data previously serialized

workspace - Current workspace being deserialized

getIdentifier

String getIdentifier()

Unique XML tag identifier for your WorkspacePersistenceProvider

Returns:

Unique identifier describing your data