Package com.illumon.iris.console.events.export

Class ExportWorkspaceHelper

java.lang.Object

com.illumon.iris.console.events.export.ExportWorkspaceHelper

All Implemented Interfaces:

WorkspaceExporter

public class ExportWorkspaceHelper
extends Object
implements WorkspaceExporter

A Helper class for sharing (exporting) part of a workspace.

Constructor Summary

Constructors

Constructor	Description
ExportWorkspaceHelper(com.fishlib.io.logger.Logger log, com.illumon.infonode.docking.RootWindow rootWindow, com.illumon.infonode.docking.AbstractTabWindow tabGroup, String userName)	Creates an ExportWorkspaceHelper.

Method Summary

Modifier and Type	Method	Description
void	exportWorkspace()	Exports a workspace.
org.jdom2.Element	exportWorkspace(Workspace workspace)	Exports a Workspace.

Methods inherited from class java.lang.Object

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

Constructor Details

ExportWorkspaceHelper

public ExportWorkspaceHelper(com.fishlib.io.logger.Logger log,
 com.illumon.infonode.docking.RootWindow rootWindow,
 com.illumon.infonode.docking.AbstractTabWindow tabGroup,
 String userName)

Creates an ExportWorkspaceHelper.

Parameters:

log - the logger

rootWindow - the Root Window

tabGroup - the selected Tab Group

userName - the active user name

Method Details

exportWorkspace

public void exportWorkspace()

Exports a workspace.

exportWorkspace

public org.jdom2.Element exportWorkspace(Workspace workspace)

Description copied from interface: WorkspaceExporter

Exports a Workspace. This is similar Workspace.getWorkspaceInfo() but may only save a subset of the data. Returns null if a Workspace cannot be exported.

Specified by:

exportWorkspace in interface WorkspaceExporter

Returns:

An Element containing the data to persist, null if the workspace cannot be exported