com.luciad.lucy.workspace

LuciadLightspeedClass TLcyWorkspaceManager

java.lang.Object

com.luciad.lucy.workspace.TLcyWorkspaceManager

All Implemented Interfaces:

ILcdPropertyChangeSource

public class TLcyWorkspaceManager
extends Object
implements ILcdPropertyChangeSource

This manager is the starting point for doing workspace related tasks. It takes care of:

• accounting the ALcyWorkspaceCodec
• accounting the registered ALcyWorkspaceCodecDelegates
• accounting the registered ALcyWorkspaceObjectCodecs

To encode a workspace, use canEncodeWorkspace(String) and encodeWorkspace(String). To decode a workspace, use canDecodeWorkspace(String) and decodeWorkspace(String). One can be notified when the workspace encoding/decoded starts/ends by using addWorkspaceManagerListener(ILcyWorkspaceManagerListener).

Furthermore, this TLcyWorkspaceManager stores whether the workspace has been changed since it was last encoded/decoded. It is the responsibility of the ALcyWorkspaceCodecDelegates and ALcyWorkspaceObjectCodecs to inform the TLcyWorkspaceManager that the workspace has changed by using notifyWorkspaceChanged().

Constructor Summary

Constructors

Constructor and Description
TLcyWorkspaceManager(ILcyLucyEnv aLucyEnv) Creates a new TLcyWorkspaceManager.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener) Registers the given PropertyChangeListener to be notified when this object's properties change.
void	addWorkspaceCodecDelegate(ALcyWorkspaceCodecDelegate aDelegate) Registers a ALcyWorkspaceCodecDelegate to the framework.
void	addWorkspaceManagerListener(ILcyWorkspaceManagerListener aListener) Adds a workspace manager listener.
void	addWorkspaceObjectCodec(ALcyWorkspaceObjectCodec aObjectCodec) Registers a ALcyWorkspaceObjectCodec to the framework.
boolean	canDecodeWorkspace(String aSourceName) Returns true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canDecodeWorkspace(String).
boolean	canDecodeWorkspace(String aSourceName, List<String> aReasonsSFCT) Returns true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canDecodeWorkspace(String, List).
boolean	canEncodeWorkspace(String aDestinationName) Returns true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canEncodeWorkspace(String).
void	decodeWorkspace(String aSourceName) Decodes the workspace using ALcyWorkspaceCodec.decodeWorkspace(String) of the set ALcyWorkspaceCodec.
void	encodeWorkspace(String aDestinationName) Encodes the workspace using ALcyWorkspaceCodec.encodeWorkspace(String) of the set ALcyWorkspaceCodec.
ALcyWorkspaceCodec	getWorkspaceCodec() Returns the ALcyWorkspaceCodec.
ALcyWorkspaceCodecDelegate	getWorkspaceCodecDelegate(int aIndex) Returns the ALcyWorkspaceCodecDelegate at the given index.
int	getWorkspaceCodecDelegateCount() Returns the amount of registered ALcyWorkspaceCodecDelegates.
ALcyWorkspaceObjectCodec	getWorkspaceObjectCodec(int aIndex) Returns the ALcyWorkspaceObjectCodec at the given index.
int	getWorkspaceObjectCodecCount() Returns the amount of registered ALcyWorkspaceObjectCodecs.
String	getWorkspaceStorageName() Short for ALcyWorkspaceCodec.getWorkspaceStorageName().
boolean	isDecodingWorkspace() Returns true if a workspace is currently being decoded, false otherwise.
boolean	isEncodingWorkspace() Returns true if a workspace is currently being encoded, false otherwise.
boolean	isWorkspaceChanged() Returns true if the workspace has changed since the last encoding/decoding.
void	notifyWorkspaceChanged() Use this method to notify that the workspace has changed since the last encoding/decoding.
void	removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener) De-registers the given PropertyChangeListener from receiving property change events for this object.
void	removeWorkspaceCodecDelegate(ALcyWorkspaceCodecDelegate aDelegate) Unregisters the given ALcyWorkspaceCodecDelegate from the framework.
void	removeWorkspaceManagerListener(ILcyWorkspaceManagerListener aListener) Removes the given ILcyWorkspaceManagerListener, it will no longer receive any events.
void	removeWorkspaceObjectCodec(ALcyWorkspaceObjectCodec aObjectCodec) Unregisters the given ALcyWorkspaceObjectCodec from the framework.
void	setWorkspaceChanged(boolean aWorkspaceChanged) Sets the workspace changed status.
void	setWorkspaceCodec(ALcyWorkspaceCodec aWorkspaceCodec) Sets the ALcyWorkspaceCodec.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyWorkspaceManager

public TLcyWorkspaceManager(ILcyLucyEnv aLucyEnv)

Creates a new TLcyWorkspaceManager. This constructor must not be used, instead the TLcyWorkspaceManager must be retrieved using ILcyLucyEnv.getWorkspaceManager().

Parameters:

aLucyEnv - The lucy environment.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Description copied from interface: ILcdPropertyChangeSource

Registers the given PropertyChangeListener to be notified when this object's properties change.

In case you need to register a listener which keeps a reference to an object with a shorter life-time than this change source, you can use a ALcdWeakPropertyChangeListener instance as property change listener.

Specified by:

addPropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aPropertyChangeListener - The listener to be notified

See Also:

ALcdWeakPropertyChangeListener, ILcdPropertyChangeSource.removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener aPropertyChangeListener)

Description copied from interface: ILcdPropertyChangeSource

De-registers the given PropertyChangeListener from receiving property change events for this object.

If the listener was added more than once, it will be notified one less time after being removed. If the listener is null, or was never added, no exception is thrown and no action is taken.

Specified by:

removePropertyChangeListener in interface ILcdPropertyChangeSource

Parameters:

aPropertyChangeListener - the listener that should no longer be notified of changes of this object's properties

See Also:

ILcdPropertyChangeSource.addPropertyChangeListener(java.beans.PropertyChangeListener)

addWorkspaceManagerListener

public void addWorkspaceManagerListener(ILcyWorkspaceManagerListener aListener)

Adds a workspace manager listener. This allows to receive an event when workspace de/encoding starts/ends. To know if a workspace is being de/encoded at a certain moment, it is also possible to use isEncodingWorkspace() or isDecodingWorkspace().

Parameters:

aListener - The listener to add.

See Also:

removeWorkspaceManagerListener(ILcyWorkspaceManagerListener)

removeWorkspaceManagerListener

public void removeWorkspaceManagerListener(ILcyWorkspaceManagerListener aListener)

Removes the given ILcyWorkspaceManagerListener, it will no longer receive any events. Does nothing if the given listener was never added or already removed.

Parameters:

aListener - The listener to remove

See Also:

addWorkspaceManagerListener(ILcyWorkspaceManagerListener)

addWorkspaceCodecDelegate

public void addWorkspaceCodecDelegate(ALcyWorkspaceCodecDelegate aDelegate)

Registers a ALcyWorkspaceCodecDelegate to the framework. When a workspace is encoded/decoded, the given aDelegate will be asked to encode/decode part of it.

Parameters:

aDelegate - The ALcyWorkspaceCodecDelegate to register.

See Also:

ALcyWorkspaceCodecDelegate

removeWorkspaceCodecDelegate

public void removeWorkspaceCodecDelegate(ALcyWorkspaceCodecDelegate aDelegate)

Unregisters the given ALcyWorkspaceCodecDelegate from the framework. It will no longer be part of workspace encoding/decoding.

Parameters:

aDelegate - The ALcyWorkspaceCodecDelegate to remove.

See Also:

ALcyWorkspaceCodecDelegate

getWorkspaceCodecDelegateCount

public int getWorkspaceCodecDelegateCount()

Returns the amount of registered ALcyWorkspaceCodecDelegates.

Returns:

the amount of registered ALcyWorkspaceCodecDelegates.

getWorkspaceCodecDelegate

public ALcyWorkspaceCodecDelegate getWorkspaceCodecDelegate(int aIndex)

Returns the ALcyWorkspaceCodecDelegate at the given index.

Parameters:

aIndex - The index to get the ALcyWorkspaceCodecDelegate for.

Returns:

the ALcyWorkspaceCodecDelegate at the given index.

addWorkspaceObjectCodec

public void addWorkspaceObjectCodec(ALcyWorkspaceObjectCodec aObjectCodec)

Registers a ALcyWorkspaceObjectCodec to the framework. When the ALcyWorkspaceCodec needs to encode an object reference, it might ask this aObjectCodec to do it, depending on what aObjectCodec.canEncodeObject returns.

Parameters:

aObjectCodec - The ALcyWorkspaceObjectCodec to register.

See Also:

ALcyWorkspaceObjectCodec

removeWorkspaceObjectCodec

public void removeWorkspaceObjectCodec(ALcyWorkspaceObjectCodec aObjectCodec)

Unregisters the given ALcyWorkspaceObjectCodec from the framework. It will no longer be part of workspace encoding/decoding.

Parameters:

aObjectCodec - The ALcyWorkspaceObjectCodec to remove.

See Also:

ALcyWorkspaceObjectCodec

getWorkspaceObjectCodecCount

public int getWorkspaceObjectCodecCount()

Returns the amount of registered ALcyWorkspaceObjectCodecs.

Returns:

the amount of registered ALcyWorkspaceObjectCodecs.

getWorkspaceObjectCodec

public ALcyWorkspaceObjectCodec getWorkspaceObjectCodec(int aIndex)

Returns the ALcyWorkspaceObjectCodec at the given index.

Parameters:

aIndex - The index to get the ALcyWorkspaceObjectCodec for.

Returns:

the ALcyWorkspaceObjectCodec at the given index.

getWorkspaceCodec

public ALcyWorkspaceCodec getWorkspaceCodec()

Returns the ALcyWorkspaceCodec. By default an ALcyWorkspaceCodec is returned that stores the workspace to a file.

Returns:

the ALcyWorkspaceCodec.

See Also:

setWorkspaceCodec(ALcyWorkspaceCodec)

setWorkspaceCodec

public void setWorkspaceCodec(ALcyWorkspaceCodec aWorkspaceCodec)

Sets the ALcyWorkspaceCodec. This default ALcyWorkspaceCodec that writes to a file can be replaced with a custom one. This allows to implement e.g. a ALcyWorkspaceCodec that writes to a database.

Parameters:

aWorkspaceCodec - The ALcyWorkspaceCodec to use.

See Also:

getWorkspaceCodec()

isDecodingWorkspace

public boolean isDecodingWorkspace()

Returns true if a workspace is currently being decoded, false otherwise. Changes to this value can be received by using addWorkspaceManagerListener(ILcyWorkspaceManagerListener).

Returns:

true if a workspace is currently being decoded, false otherwise.

isEncodingWorkspace

public boolean isEncodingWorkspace()

Returns true if a workspace is currently being encoded, false otherwise. Changes to this value can be received by using addWorkspaceManagerListener(ILcyWorkspaceManagerListener).

Returns:

true if a workspace is currently being encoded, false otherwise.

isWorkspaceChanged

public boolean isWorkspaceChanged()

Returns true if the workspace has changed since the last encoding/decoding. It is the responsibility of the ALcyWorkspaceCodecDelegates and the ALcyWorkspaceObjectCodecs to use notifyWorkspaceChanged() to inform about changes in the workspace. A property change event informs about changes to this value.

A typical use of this property would be to inform an end user that changes were made to the workspace, before loading another workspace or quiting the application.

Returns:

true if the workspace has changed since the last encoding/decoding.

See Also:

notifyWorkspaceChanged()

setWorkspaceChanged

public void setWorkspaceChanged(boolean aWorkspaceChanged)

Sets the workspace changed status. Setting the changed status to true can also be done using notifyWorkspaceChanged(). Setting the status to false usually isn't needed, as the workspace changed flag is automatically updated when loading or saving a workspace.

Sends a property change event if the result of isWorkspaceChanged() has changed.

Parameters:

aWorkspaceChanged - True to set the workspace to 'changed', false otherwise.

notifyWorkspaceChanged

public void notifyWorkspaceChanged()

Use this method to notify that the workspace has changed since the last encoding/decoding. This is equivalent to calling setWorkspaceChanged(boolean) with true.

It is the responsibility of the ALcyWorkspaceCodecDelegates and the ALcyWorkspaceObjectCodecs to use this method.

Sends a property change event if the result of isWorkspaceChanged() has changed.

getWorkspaceStorageName

public String getWorkspaceStorageName()

Short for ALcyWorkspaceCodec.getWorkspaceStorageName(). A property change event informs about changes to this value.

Returns:

the current storage name of the workspace.

canEncodeWorkspace

public boolean canEncodeWorkspace(String aDestinationName)

Returns true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canEncodeWorkspace(String).

Parameters:

aDestinationName - The destination name to check.

Returns:

true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canEncodeWorkspace(String).

encodeWorkspace

public void encodeWorkspace(String aDestinationName)
                     throws IOException,
                            TLcyWorkspaceAbortedException

Encodes the workspace using ALcyWorkspaceCodec.encodeWorkspace(String) of the set ALcyWorkspaceCodec.

Fires an event with id TLcyWorkspaceManagerEvent.STARTING_WORKSPACE_ENCODING before actually encoding the workspace. Fires an event with id TLcyWorkspaceManagerEvent.WORKSPACE_ENCODING_ENDED after the workspace is encoded.

Parameters:

aDestinationName - The destination name to encode to.

Throws:

IOException - In case of fatal IO failure.

TLcyWorkspaceAbortedException - In case the operation is aborted, e.g. because the user canceled it.

canDecodeWorkspace

public boolean canDecodeWorkspace(String aSourceName)

Returns true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canDecodeWorkspace(String).

Parameters:

aSourceName - The source name to check.

Returns:

true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canDecodeWorkspace(String).

canDecodeWorkspace

public boolean canDecodeWorkspace(String aSourceName,
                                  List<String> aReasonsSFCT)

Returns true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canDecodeWorkspace(String, List).

Parameters:

aSourceName - The source name to check

aReasonsSFCT - A side-effect parameter to which this method may add reasons on why it returned true or false

Returns:

true if the set ALcyWorkspaceCodec returns true for ALcyWorkspaceCodec.canDecodeWorkspace(String, List).

Since:

2015.1

decodeWorkspace

public void decodeWorkspace(String aSourceName)
                     throws IOException,
                            TLcyWorkspaceAbortedException

Decodes the workspace using ALcyWorkspaceCodec.decodeWorkspace(String) of the set ALcyWorkspaceCodec.

Fires an event with id TLcyWorkspaceManagerEvent.STARTING_WORKSPACE_DECODING before actually decoding the workspace. Fires an event with id TLcyWorkspaceManagerEvent.WORKSPACE_DECODING_ENDED after the workspace is decoded.

Parameters:

aSourceName - The source name to decode from.

Throws:

IOException - In case of fatal IO failure.

TLcyWorkspaceAbortedException - In case the operation is aborted, e.g. because the user canceled it.