org.lsst.ccs.gconsole.services.persist

Class PersistenceService

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

org.lsst.ccs.gconsole.services.persist.PersistenceService

All Implemented Interfaces:

ConsoleService

@Plugin(name="Persistence Service Plugin",
        id="persistence-service",
        description="Service that facilitates persisting data between the graphical console sessions.")
public class PersistenceService
extends ConsolePlugin
implements ConsoleService

Service that facilitates persisting data between the graphical console sessions.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
PersistenceService()

Method Summary

Modifier and Type	Method and Description
void	delete(Persistable.Descriptor descriptor) Deletes the specified descriptor from storage.
Persistable	edit(Persistable before, String title, Component parent) Takes user input and returns a modified Persistable instance.
List<Creator>	getFactories(String category) Utility method that returns all registered instance creators in the specified category.
Creator	getFactory(String category, String path) Utility method that returns an instance creator identified by category and path.
ArrayList<Persistable.Descriptor>	getSavedDescriptors(String category) Returns a list of saved descriptors in the specified category.
static PersistenceService	getService()
Persistable.Descriptor	load(String category, String title, Component parent) Lets the user select one of the saved descriptors in the specified category.
<T extends Persistable> T	make(Creator.Descriptor desc) Creates a Persistable instance.
<T extends Persistable> T	make(Persistable.Descriptor descriptor) Creates a Persistable instance based on the provided descriptor.
<T extends Persistable> T	make(Persistable.Descriptor descriptor, String title, Component parent, String category) Creates a Persistable instance by letting the user to select one of the available creators in the given category, and using the provided descriptor (if any) as the starting point.
<T extends Persistable> T	make(String category, String path, Object... parameters) Creates a Persistable instance.
<T extends Persistable> T	make(String category, String path, String[] parameters) Creates a Persistable instance.
void	save(Persistable.Descriptor descriptor) Saves the specified descriptor to disk, making it available in future console sessions.
void	saveAs(Persistable.Descriptor descriptor, String title, Component parent) Saves the descriptor to disk, letting the user specify path, name, and description.
void	startService() Called by the framework to start the service.

Methods inherited from class org.lsst.ccs.gconsole.base.ConsolePlugin

getConsole, getServices, initialize, propertiesChanged, restore, save, setServicesProvider, shutdown, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.base.ConsoleService

stopService

Constructor Detail

PersistenceService

public PersistenceService()

Method Detail

startService

public void startService()

Called by the framework to start the service.

Specified by:

startService in interface ConsoleService

getService

public static PersistenceService getService()

make

public <T extends Persistable> T make(Persistable.Descriptor descriptor)

Creates a Persistable instance based on the provided descriptor. No user interaction. An instance of Persistable is constructed as follows:

• if the descriptor's class has a target class, identified either explicitly with Describe annotation or by being an enclosing class, and the target class has a constructor that takes the descriptor as the only argument, that constructor is used;
• otherwise, if the descriptor has "creator" property and a Creator factory identified by it can be found, that factory is used;
• otherwise, if the descriptor's class has a target class with a default constructor, that constructor is used.

After the Persistable instance is created, its restore(...) method is called.

Type Parameters:

T - Type of Persistable.

Parameters:

descriptor - JavaBean that describes the Persistable type and state.

Returns:

Newly created Persistable, or null if it cannot be created.

make

public <T extends Persistable> T make(String category,
                                      String path,
                                      Object... parameters)

Creates a Persistable instance. No user interaction.

Type Parameters:

T - Type of Persistable.

Parameters:

category - Persistable category.

path - Path of the Creator that should be used.

parameters - Parameters to be passed to the Creator.

Returns:

Newly created Persistable, or null if it cannot be created.

make

public <T extends Persistable> T make(String category,
                                      String path,
                                      String[] parameters)

Creates a Persistable instance. No user interaction.

Type Parameters:

T - Type of Persistable.

Parameters:

category - Persistable category.

path - Path of the Creator that should be used.

parameters - Parameters to be passed to the Creator, encoded as strings.

Returns:

Newly created Persistable, or null if it cannot be created.

make

public <T extends Persistable> T make(Creator.Descriptor desc)

Creates a Persistable instance. No user interaction.

Type Parameters:

T - Type of Persistable.

Parameters:

desc - Creator descriptor.

Returns:

Newly created Persistable, or null if it cannot be created.

make

public <T extends Persistable> T make(Persistable.Descriptor descriptor,
                                      String title,
                                      Component parent,
                                      String category)

Creates a Persistable instance by letting the user to select one of the available creators in the given category, and using the provided descriptor (if any) as the starting point. Returns null if the user cancels creation, or an instance cannot be created for any reason.

Type Parameters:

T - Type of Persistable.

Parameters:

descriptor - Descriptor to be used as a starting point.

title - User-interaction dialog title, or null if the default title should be used.

parent - Graphical component to be use as a parent for user-interaction dialog(s).

category - Persistable category. If null, the category will be extracted from the provided descriptor.

Returns:

Newly created Persistable.

Throws:

IllegalArgumentException - if the category is not provided and cannot be inferred from the descriptor.

CancellationException - if creation is canceled by the user.

save

public void save(Persistable.Descriptor descriptor)

Saves the specified descriptor to disk, making it available in future console sessions. The method will display an error message if the descriptor does not have category or path set.

Parameters:

descriptor - Descriptor to be saved.

saveAs

public void saveAs(Persistable.Descriptor descriptor,
                   String title,
                   Component parent)

Saves the descriptor to disk, letting the user specify path, name, and description. The saved descriptor will be available in future console sessions. The method will display an error message if the descriptor cannot be saved.

Parameters:

descriptor - Descriptor to be saved.

title - User interaction dialog title.

parent - User interaction dialog parent component, or null if the parent is the console window.

delete

public void delete(Persistable.Descriptor descriptor)

Deletes the specified descriptor from storage.

Parameters:

descriptor - Descriptor to be removed.

load

public Persistable.Descriptor load(String category,
                                   String title,
                                   Component parent)

Lets the user select one of the saved descriptors in the specified category.

Parameters:

category - Persistable object category.

title - User interaction dialog title.

parent - User interaction dialog parent component, or null if the parent is the console window.

Returns:

Chosen descriptor.

edit

public Persistable edit(Persistable before,
                        String title,
                        Component parent)

Takes user input and returns a modified Persistable instance. This method should be called on EDT.

Parameters:

before - Persistable instance to edit.

title - User-interaction dialog title, or null if the default title should be used.

parent - Graphical component to be use as a parent for user-interaction dialog(s).

Returns:

Modified instance (may or may not be this).

Throws:

CancellationException - If editing is canceled by the user.

RuntimeException - If editing fails for any reason.

getFactory

public Creator getFactory(String category,
                          String path)

Utility method that returns an instance creator identified by category and path.

Parameters:

category - Creator category.

path - Creator path.

Returns:

Desired factory, or null if no such factory is known to this service.

getFactories

public List<Creator> getFactories(String category)

Utility method that returns all registered instance creators in the specified category.

Parameters:

category - Persistable object category.

Returns:

List of known creators.

getSavedDescriptors

public ArrayList<Persistable.Descriptor> getSavedDescriptors(String category)

Returns a list of saved descriptors in the specified category.

Parameters:

category - Persistable object category.

Returns:

List of saved descriptors.