org.cytoscape.session.events
Class SessionAboutToBeSavedEvent
java.lang.Object
org.cytoscape.event.AbstractCyEvent<CySessionManager>
org.cytoscape.session.events.SessionAboutToBeSavedEvent
- All Implemented Interfaces:
- CyEvent<CySessionManager>
public final class SessionAboutToBeSavedEvent
- extends AbstractCyEvent<CySessionManager>
This event is fired synchronously by the CySessionManager
at beginning of the
CySessionManager.getCurrentSession()
method. The intent is to allow
listeners to provide information to this event object or to update their
state before that state is interrogated by the CySessionManager.
Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.
Method Summary |
void |
addAppFiles(String appName,
List<File> files)
A method that allows apps to specify a list of files that should be
stored in the session. |
Map<String,List<File>> |
getAppFileListMap()
This method is not meant to be used by listeners for this event,
although you can and no harm should come to you. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SessionAboutToBeSavedEvent
public SessionAboutToBeSavedEvent(CySessionManager source)
- Constructor.
- Parameters:
source
- The CySessionManager
that will be saving the session.
addAppFiles
public void addAppFiles(String appName,
List<File> files)
throws Exception
- A method that allows apps to specify a list of files that should be
stored in the session.
- Parameters:
appName
- The name of the app that these files should be stored for.files
- The list of File objects to be stored in the session file.
- Throws:
Exception
getAppFileListMap
public Map<String,List<File>> getAppFileListMap()
- This method is not meant to be used by listeners for this event,
although you can and no harm should come to you. This method is
used by the
CySessionManager
to retrieve the list of files from
apps.
- Returns:
- A map of app names to lists of files to be stored in the
session for that app.
Copyright 2011 Cytoscape Consortium. All rights reserved.