icy.workspace

Class Workspace

java.lang.Object

icy.workspace.Workspace

All Implemented Interfaces:

XMLPersistent, java.lang.Comparable<Workspace>

public class Workspace
extends java.lang.Object
implements XMLPersistent, java.lang.Comparable<Workspace>

Author:

Stephane

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Workspace.TaskDefinition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEFAULT_ACTIVE_WORKSPACES
static java.lang.String	WORKSPACE_SYSTEM_NAME

Constructor Summary

Constructors

Constructor and Description
Workspace() empty workspace
Workspace(java.io.File file) workspace loaded from file
Workspace(java.lang.String name) workspace loaded from his name
Workspace(java.net.URL url, RepositoryPreferences.RepositoryInfo repos) workspace loaded from url (online)

Method Summary

Methods

Modifier and Type	Method and Description
Workspace.TaskDefinition.BandDefinition	addBand(java.lang.String taskName, java.lang.String bandName) add a BandDefinition
Workspace.TaskDefinition.BandDefinition.ItemDefinition	addItem(java.lang.String taskName, java.lang.String bandName, java.lang.String className) add a ItemDefinition
Workspace.TaskDefinition	addTask(org.pushingpixels.flamingo.api.ribbon.RibbonTask ribbonTask) add a TaskDefinition from RibbonTask component
Workspace.TaskDefinition	addTask(java.lang.String taskName) add a TaskDefinition
static boolean	addWorkspace(java.util.List<Workspace> list, Workspace workspace)
void	clear() Clear all tasks.
int	compareTo(Workspace o)
static boolean	contains(java.util.List<Workspace.TaskDefinition.BandDefinition> bands, Workspace.TaskDefinition.BandDefinition band)
static boolean	contains(java.util.List<Workspace.TaskDefinition> tasks, Workspace.TaskDefinition task)
Workspace.TaskDefinition.BandDefinition	findBand(java.lang.String taskName, java.lang.String bandName)
Workspace.TaskDefinition.BandDefinition.ItemDefinition	findItem(java.lang.String className)
Workspace.TaskDefinition	findTask(java.lang.String taskName)
java.util.ArrayList<Workspace.TaskDefinition.BandDefinition.ItemDefinition>	getAllItems()
java.lang.String	getDescription()
java.lang.String	getLocalFilename()
java.lang.String	getName()
RepositoryPreferences.RepositoryInfo	getRepository()
java.util.ArrayList<Workspace.TaskDefinition>	getTasks()
static Workspace	getWorkspace(java.util.List<Workspace> list, java.lang.String name)
int	install(ProgressFrame progressFrame) Install the workspace.
boolean	isEmpty()
boolean	isInstalling()
boolean	load() load from local
boolean	load(java.io.File file) load from file
boolean	load(java.net.URL url) load from file
boolean	loadFromXML(org.w3c.dom.Node node) LOAD
boolean	removeTask(java.lang.String taskName)
static boolean	removeWorkspace(java.util.List<Workspace> list, java.lang.String name)
boolean	save() save
boolean	saveToXML(org.w3c.dom.Node node) SAVE
void	setDescription(java.lang.String description)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACTIVE_WORKSPACES

public static final java.lang.String[] DEFAULT_ACTIVE_WORKSPACES

WORKSPACE_SYSTEM_NAME

public static final java.lang.String WORKSPACE_SYSTEM_NAME

See Also:

Constant Field Values

Constructor Detail

Workspace

public Workspace()

empty workspace

Workspace

public Workspace(java.io.File file)
          throws java.lang.IllegalArgumentException

workspace loaded from file

Throws:

java.lang.IllegalArgumentException

Workspace

public Workspace(java.net.URL url,
         RepositoryPreferences.RepositoryInfo repos)
          throws java.lang.IllegalArgumentException

workspace loaded from url (online)

Throws:

java.lang.IllegalArgumentException

Workspace

public Workspace(java.lang.String name)
          throws java.lang.IllegalArgumentException

workspace loaded from his name

Throws:

java.lang.IllegalArgumentException

Method Detail

contains

public static boolean contains(java.util.List<Workspace.TaskDefinition> tasks,
               Workspace.TaskDefinition task)

contains

public static boolean contains(java.util.List<Workspace.TaskDefinition.BandDefinition> bands,
               Workspace.TaskDefinition.BandDefinition band)

getWorkspace

public static Workspace getWorkspace(java.util.List<Workspace> list,
                     java.lang.String name)

addWorkspace

public static boolean addWorkspace(java.util.List<Workspace> list,
                   Workspace workspace)

removeWorkspace

public static boolean removeWorkspace(java.util.List<Workspace> list,
                      java.lang.String name)

getLocalFilename

public java.lang.String getLocalFilename()

getName

public java.lang.String getName()

Returns:

the name

getDescription

public java.lang.String getDescription()

Returns:

the description

isEmpty

public boolean isEmpty()

setName

public void setName(java.lang.String name)

Parameters:

name - the name to set

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set

isInstalling

public boolean isInstalling()

Returns:

the installing

getRepository

public RepositoryPreferences.RepositoryInfo getRepository()

clear

public void clear()

Clear all tasks.

findTask

public Workspace.TaskDefinition findTask(java.lang.String taskName)

findBand

public Workspace.TaskDefinition.BandDefinition findBand(java.lang.String taskName,
                                               java.lang.String bandName)

findItem

public Workspace.TaskDefinition.BandDefinition.ItemDefinition findItem(java.lang.String className)

getTasks

public java.util.ArrayList<Workspace.TaskDefinition> getTasks()

Returns:

the definitions

getAllItems

public java.util.ArrayList<Workspace.TaskDefinition.BandDefinition.ItemDefinition> getAllItems()

Returns:

all items contained in this workspace

addTask

public Workspace.TaskDefinition addTask(org.pushingpixels.flamingo.api.ribbon.RibbonTask ribbonTask)

add a TaskDefinition from RibbonTask component

addTask

public Workspace.TaskDefinition addTask(java.lang.String taskName)

add a TaskDefinition

addBand

public Workspace.TaskDefinition.BandDefinition addBand(java.lang.String taskName,
                                              java.lang.String bandName)

add a BandDefinition

addItem

public Workspace.TaskDefinition.BandDefinition.ItemDefinition addItem(java.lang.String taskName,
                                                             java.lang.String bandName,
                                                             java.lang.String className)

add a ItemDefinition

removeTask

public boolean removeTask(java.lang.String taskName)

load

public boolean load()

load from local

load

public boolean load(java.io.File file)

load from file

load

public boolean load(java.net.URL url)

load from file

loadFromXML

public boolean loadFromXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

LOAD

Specified by:

loadFromXML in interface XMLPersistent

save

public boolean save()

save

saveToXML

public boolean saveToXML(org.w3c.dom.Node node)

Description copied from interface: XMLPersistent

SAVE

Specified by:

saveToXML in interface XMLPersistent

install

public int install(ProgressFrame progressFrame)

Install the workspace.
Return 0 if workspace cannot be installed
Return 1 if workspace correctly installed
Return 2 if workspace partially installed

compareTo

public int compareTo(Workspace o)

Specified by:

compareTo in interface java.lang.Comparable<Workspace>