org.gephi.project.api

Interface WorkspaceProvider

All Known Implementing Classes:

WorkspaceProviderImpl

public interface WorkspaceProvider

Maintains workspaces list for projects, and the currently selected workspace.

Author:

Mathieu Bastian

See Also:

Project

Method Summary

Methods

Modifier and Type	Method and Description
Workspace	getCurrentWorkspace() Returns the current workspace or null if none.
Workspace	getWorkspace(int id) Retrieve a workspace based on its unique identifier.
Workspace[]	getWorkspaces() Returns all the workspaces.
boolean	hasCurrentWorkspace() Returns true if the project has a current workspace.

Method Detail

getCurrentWorkspace

Workspace getCurrentWorkspace()

Returns the current workspace or null if none.

Returns:

current workspace or null if missing

hasCurrentWorkspace

boolean hasCurrentWorkspace()

Returns true if the project has a current workspace.

Returns:

true if has a current workspace, false otherwise

getWorkspaces

Workspace[] getWorkspaces()

Returns all the workspaces.

Returns an empty array if no workspaces.

Returns:

an array of all workspaces

getWorkspace

Workspace getWorkspace(int id)

Retrieve a workspace based on its unique identifier.

Parameters:

id - workspace's unique identifier

Returns:

found workspace or null if not found