eu.fthevenet.binjr.data.workspace

Class Workspace

java.lang.Object

eu.fthevenet.binjr.data.workspace.Workspace

All Implemented Interfaces:

Dirtyable

public class Workspace
extends java.lang.Object
implements Dirtyable

A class that represents and holds the current state of the application

It provides the means to track changes, persist and reload a state in between usage session of the application

Author:

Frederic Thevenet

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	dirty A BooleanProperty that observes the changes made to the Dirtyable instance
javafx.beans.property.Property<java.nio.file.Path>	path Returns the property that observes the Path for the serialized form of the Workspace

Field Summary

Fields

Modifier and Type	Field and Description
static Version	MINIMUM_SUPPORTED_SCHEMA_VERSION
static java.lang.String	WORKSPACE_SCHEMA_VERSION

Constructor Summary

Constructors

Constructor and Description
Workspace() Initializes a new instance of the Workspace class

Method Summary

Modifier and Type	Method and Description
void	addSource(Source sourceToAdd)
void	addSources(java.util.Collection<Source> sourcesToAdd) /** Add all the elements in the provided collection to the list of Source instances
void	addWorksheets(java.util.Collection<Worksheet<?>> worksheetsToAdd) Add all the elements in the provided collection to the list of Worksheet instances
void	addWorksheets(Worksheet<?>... worksheetsToAdd)
void	cleanUp() Clear the dirty status of the Dirtyable instance
void	clear() Clear all the properties of the Workspace instance
void	clearSources() Clear the Source list
void	clearWorksheets() Clear the Worksheet list
javafx.beans.property.BooleanProperty	dirtyProperty() A BooleanProperty that observes the changes made to the Dirtyable instance
static Workspace	from(java.io.File file) Deserializes the content of the provided file as a new instance of the Workspace class
java.nio.file.Path	getPath() Returns the Path for the serialized form of the Workspace
java.lang.Iterable<Source>	getSources() Returns all Source instances currently held by the Workspace as an Iterable structure.
java.lang.Iterable<Worksheet>	getWorksheets() Returns all Worksheet instances currently held by the Workspace as an Iterable structure.
boolean	hasPath() Returns true is the Workspace has a valid Path, false otherwise
java.lang.Boolean	isDirty() Gets the value of the property dirty.
javafx.beans.property.Property<java.nio.file.Path>	pathProperty() Returns the property that observes the Path for the serialized form of the Workspace
void	removeSource(Source sourceToRemove)
void	removeSources(java.util.Collection<Source> sourcesToRemove) Remove all the elements in the provided collection from the list of Source instances
void	removeWorksheets(Worksheet... worksheetsToRemove) Remove all the elements in the provided collection from the list of Worksheet instances
void	save() Commits the current state of the Workspace instance to its persistence layer
void	save(java.io.File file) Commits the current state of the Workspace instance to the provided file
void	setPath(java.nio.file.Path path) Sets the Path for the serialized form of the Workspace
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Property Detail

path

public javafx.beans.property.Property<java.nio.file.Path> pathProperty

Returns the property that observes the Path for the serialized form of the Workspace

See Also:

getPath(), setPath(Path)

dirty

public javafx.beans.property.BooleanProperty dirtyProperty

Specified by:

dirtyProperty in interface Dirtyable

See Also:

isDirty()

Field Detail

WORKSPACE_SCHEMA_VERSION

public static final java.lang.String WORKSPACE_SCHEMA_VERSION

See Also:

Constant Field Values

MINIMUM_SUPPORTED_SCHEMA_VERSION

public static final Version MINIMUM_SUPPORTED_SCHEMA_VERSION

Constructor Detail

Workspace

public Workspace()

Initializes a new instance of the Workspace class

Method Detail

addWorksheets

public void addWorksheets(java.util.Collection<Worksheet<?>> worksheetsToAdd)

Add all the elements in the provided collection to the list of Worksheet instances

Parameters:

worksheetsToAdd - the list of Worksheet instances to add

addWorksheets

public void addWorksheets(Worksheet<?>... worksheetsToAdd)

removeWorksheets

public void removeWorksheets(Worksheet... worksheetsToRemove)

Remove all the elements in the provided collection from the list of Worksheet instances

Parameters:

worksheetsToRemove - the list of Worksheet instances to remove

clearWorksheets

public void clearWorksheets()

Clear the Worksheet list

clearSources

public void clearSources()

Clear the Source list

addSources

public void addSources(java.util.Collection<Source> sourcesToAdd)

/** Add all the elements in the provided collection to the list of Source instances

Parameters:

sourcesToAdd - the list of Source instances to add

addSource

public void addSource(Source sourceToAdd)

removeSources

public void removeSources(java.util.Collection<Source> sourcesToRemove)

Remove all the elements in the provided collection from the list of Source instances

Parameters:

sourcesToRemove - the list of Source instances to remove

removeSource

public void removeSource(Source sourceToRemove)

getWorksheets

public java.lang.Iterable<Worksheet> getWorksheets()

Returns all Worksheet instances currently held by the Workspace as an Iterable structure.

Returns:

all Worksheet instances currently held by the Workspace as an Iterable structure.

getSources

public java.lang.Iterable<Source> getSources()

Returns all Source instances currently held by the Workspace as an Iterable structure.

Returns:

all Source instances currently held by the Workspace as an Iterable structure.

getPath

public java.nio.file.Path getPath()

Returns the Path for the serialized form of the Workspace

Returns:

the Path for the serialized form of the Workspace

pathProperty

public javafx.beans.property.Property<java.nio.file.Path> pathProperty()

Returns the property that observes the Path for the serialized form of the Workspace

See Also:

getPath(), setPath(Path)

hasPath

public boolean hasPath()

Returns true is the Workspace has a valid Path, false otherwise

Returns:

true is the Workspace has a valid Path, false otherwise

setPath

public void setPath(java.nio.file.Path path)

Sets the Path for the serialized form of the Workspace

Parameters:

path - the Path for the serialized form of the Workspace

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clear

public void clear()

Clear all the properties of the Workspace instance

save

public void save()
          throws java.io.IOException,
                 javax.xml.bind.JAXBException

Commits the current state of the Workspace instance to its persistence layer

Throws:

java.io.IOException - if an IO error occurs with the persistence layer

javax.xml.bind.JAXBException - if an error occurs while serializing the current state of the Workspace

save

public void save(java.io.File file)
          throws java.io.IOException,
                 javax.xml.bind.JAXBException

Commits the current state of the Workspace instance to the provided file

Parameters:

file - the file to save the the current state of the Workspace to

Throws:

java.io.IOException - if an IO error occurs when accessing the file

javax.xml.bind.JAXBException - if an error occurs while serializing the current state of the Workspace

from

public static Workspace from(java.io.File file)
                      throws java.io.IOException,
                             javax.xml.bind.JAXBException,
                             CannotLoadWorkspaceException

Deserializes the content of the provided file as a new instance of the Workspace class

Parameters:

file - the file to deserialize

Returns:

a new instance of the Workspace class

Throws:

java.io.IOException - if an IO error occurs when accessing the file

javax.xml.bind.JAXBException - if an error occurs while deserializing the file

CannotLoadWorkspaceException

isDirty

public java.lang.Boolean isDirty()

Gets the value of the property dirty.

Specified by:

isDirty in interface Dirtyable

Returns:

true if the Dirtyable instance needs to be persisted, false otherwise

dirtyProperty

public javafx.beans.property.BooleanProperty dirtyProperty()

Description copied from interface: Dirtyable

A BooleanProperty that observes the changes made to the Dirtyable instance

Specified by:

dirtyProperty in interface Dirtyable

See Also:

isDirty()

cleanUp

public void cleanUp()

Description copied from interface: Dirtyable

Clear the dirty status of the Dirtyable instance

Specified by:

cleanUp in interface Dirtyable