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
List<Creator>	getFactories(String category)
Creator	getFactory(String category, String path) Returns a factory identified by the provided category and path.
ArrayList<Creator>	getSaved(String category)
List<Persistable.Descriptor>	getSavedDescriptors(String category)
Persistable	make(Persistable.Descriptor descriptor) Creates a Persistable instance based on the provided descriptor.
Persistable	make(Persistable.Descriptor descriptor, String title, JComponent parent, String category) Creates a Persistable instance by letting the user to select one of the available factories in the given category, and using the provided descriptor (if any) as the starting point.
void	save(Persistable.Descriptor descriptor)
void	saveAs(Persistable.Descriptor descriptor, JComponent parent)
void	startService()

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()

Specified by:

startService in interface ConsoleService

make

public Persistable make(Persistable.Descriptor descriptor)

Creates a Persistable instance based on the provided descriptor. No user interaction. An instance of Persistable is constructed by the Creator identified in the descriptor, then its restore(...) method is called.

Parameters:

descriptor - JavaBean that describes the Persistable type and state.

Returns:

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

make

public Persistable make(Persistable.Descriptor descriptor,
                        String title,
                        JComponent parent,
                        String category)

Creates a Persistable instance by letting the user to select one of the available factories in the given category, and using the provided descriptor (if any) as the starting point.

Parameters:

descriptor - Object state 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 - Object category.

Returns:

Newly created Persistable, or null if the object creation was canceled by the user or failed for other reason.

save

public void save(Persistable.Descriptor descriptor)

saveAs

public void saveAs(Persistable.Descriptor descriptor,
                   JComponent parent)

getFactory

public Creator getFactory(String category,
                          String path)

Returns a factory identified by the provided 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)

getSavedDescriptors

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

getSaved

public ArrayList<Creator> getSaved(String category)