PersistenceManager (McIDAS-V 1.01 Developer Documentation)

java.lang.Object
- ucar.unidata.ui.WindowHolder
- - ucar.unidata.idv.IdvManager
  - - ucar.unidata.idv.IdvPersistenceManager
    - - edu.wisc.ssec.mcidasv.PersistenceManager

All Implemented Interfaces:

ActionListener, EventListener, IdvConstants, PrototypeManager
```
public class PersistenceManager
extends IdvPersistenceManager
```
McIDAS-V has 99 problems, and bundles are several of 'em. Since the UI of alpha 10 relies upon component groups and McIDAS-V needs to support IDV and bundles prior to alpha 10, we must add facilities for coping with bundles that may not contain component groups. Here's a list of the issues and how they are resolved:
- Bundles prior to alpha 9 use the TabbedUIManager. Each tab is, internally, an IDV window. This is reflected in the contents of bundles, so the IDV wants to create a new window for each tab upon loading. Alpha 10 allows the user to force bundles to only create one window. This work is done in injectComponentGroups(List).
- The IDV allows users to save bundles that contain both ViewManagers with component groups and without! This is actually only a problem when limiting the windows; injectComponentGroups has to wrap ViewManagers without component groups in dynamic skins. These ViewManagers must be removed from the bundle's internal list of ViewManagers, as they don't exist until the dynamic skin is built. Do not simply clear the list! The ViewManagers within component groups must appear in it, otherwise the IDV does not add them to the VMManager. If limiting windows is off, everything will be caught properly by the unpersisting facilities in UIManager.
See Also:
IdvPersistenceManager, UIManager

Nested Class Summary
- Nested classes/interfaces inherited from class ucar.unidata.idv.IdvPersistenceManager
  IdvPersistenceManager.DataSourceComponent

Field Summary

Fields
Modifier and Type	Field and Description
`private static String`	`ATTR_NAME`
`private boolean`	`bundleLoading` Whether or not a bundle is actively loading.
`private static String`	`DYNSKIN_ATTR_CLASS`
`private static String`	`DYNSKIN_ATTR_COLS`
`private static String`	`DYNSKIN_ATTR_ID`
`private static String`	`DYNSKIN_ATTR_PROPS`
`private static String`	`DYNSKIN_ATTR_VIEWID`
`private static String`	`DYNSKIN_ID_VALUE`
`private static String`	`DYNSKIN_PROPS_GENERAL`
`private static String`	`DYNSKIN_PROPS_GLOBE`
`private static String`	`DYNSKIN_TAG_PANEL`
`private static String`	`DYNSKIN_TAG_VIEW`
`private static String`	`DYNSKIN_TMPNAME`
`static String`	`ID_MCV_VERSION` Key used to access a bundle's McIDAS-V in-depth versioning info section.
`private ViewManager`	`lastBeforeBundle` Stores the last active ViewManager from before a bundle load.
`private JRadioButton`	`layoutOnlyRadio` Use radio buttons to control state saving
`private JRadioButton`	`layoutSourcesDataRadio`
`private JRadioButton`	`layoutSourcesRadio`
`(package private) static LogUtil.LogCategory`	`log_`
`private static org.slf4j.Logger`	`logger`
`private static String`	`MACRO_ZIDVPATH` Macro used as a place holder for wherever the IDV decides to place extracted contents of a bundle.
`private boolean`	`mergeBundledLayers` Whether or not the user wants to attempt merging bundled layers into current displays.
`private static String`	`NEW_COMP_STUFF`
`private static String`	`NEW_SOURCE_MACRO`
`private static String`	`OLD_COMP_STUFF`
`private static String`	`OLD_SOURCE_MACRO`
`private XmlResourceCollection`	`parameterSets` Cache the parameter sets XML
`private static Document`	`parameterSetsDocument`
`private static Element`	`parameterSetsRoot`
`private boolean`	`savingDefaultLayout` Is the bundle being saved a layout bundle?
`private static String`	`SIMPLE_SKIN_TEMPLATE` XML template for generating dynamic skins.
`private static String`	`TAG_DEFAULT`
`private static String`	`TAG_FOLDER`

Fields inherited from class ucar.unidata.ui.WindowHolder
contents, dialog, frame, window

Fields inherited from interface ucar.unidata.idv.IdvConstants
ARG_B64BUNDLE, ARG_B64ISL, ARG_BUNDLE, ARG_CATALOG, ARG_CHOOSER, ARG_CLEARDEFAULT, ARG_CODE, ARG_CONNECT, ARG_CURRENTTIME, ARG_DATA, ARG_DEBUG, ARG_DEFAULT, ARG_DISPLAY, ARG_DXML, ARG_FIXEDTIME, ARG_HELP, ARG_IMAGE, ARG_IMAGESERVER, ARG_INSTALLPLUGIN, ARG_ISLFILE, ARG_ISLINTERACTIVE, ARG_LISTRESOURCES, ARG_MAINCLASS, ARG_MOVIE, ARG_MSG_DEBUG, ARG_MSG_RECORD, ARG_NODEFAULT, ARG_NOERRORSINGUI, ARG_NOGUI, ARG_NOONEINSTANCE, ARG_NOPLUGINS, ARG_NOPREF, ARG_ONEINSTANCEPORT, ARG_PLUGIN, ARG_PORT, ARG_PRINTJNLP, ARG_PROPERTIES, ARG_SCRIPT, ARG_SERVER, ARG_SETFILES, ARG_SITEPATH, ARG_TEMPLATE, ARG_TEST, ARG_TESTEVAL, ARG_TRACE, ARG_TRACEONLY, ARG_USERPATH, DEFAULT_DATE_FORMAT, DEFAULT_DOCPATH, DEFAULT_TIMEZONE, FILTER_CPT, FILTER_ISL, FILTER_JNLP, FILTER_XIDV, FILTER_XIDVZIDV, FILTER_XML, FILTER_ZIDV, ID_COMMANDSTORUN, ID_DATASOURCES, ID_DISPLAYCONTROLS, ID_IDV, ID_JYTHON, ID_MESSAGE, ID_MISCHASHTABLE, ID_VERSION, ID_VIEWMANAGERS, ID_WINDOWS, INITIAL_PROBE_EARTHLOCATION, NULL_DATA_SELECTION, NULL_STRING, PREF_ARCHIVEDIR, PREF_ARCHIVENAME, PREF_AUTODISPLAYS_ENABLE, PREF_AUTODISPLAYS_SHOWGUI, PREF_AUTOSELECTDATA, PREF_CACHESIZE, PREF_CONTROLSINTABS, PREF_DATAPREFIX, PREF_DATE_FORMAT, PREF_DISTANCEUNIT, PREF_DOCACHE, PREF_EMBEDDATACHOOSERINDASHBOARD, PREF_EMBEDFIELDSELECTORINDASHBOARD, PREF_EMBEDLEGENDINDASHBOARD, PREF_EMBEDQUICKLINKSINDASHBOARD, PREF_EVENT_KEYBOARDMAP, PREF_EVENT_MOUSEMAP, PREF_EVENT_WHEELMAP, PREF_FAST_RENDER, PREF_FIELD_CACHETHRESHOLD, PREF_FILEREADDIR, PREF_FILEWRITEDIR, PREF_HISTORY, PREF_LASTVERSION, PREF_LATLON_FORMAT, PREF_LEGEND_SHOWICONS, PREF_LOCALE, PREF_LOOKANDFEEL, PREF_MAXIMAGESIZE, PREF_OPEN_ASK, PREF_OPEN_MERGE, PREF_OPEN_REMOVE, PREF_PROJ_LIST, PREF_SAMPLINGMODE, PREF_SHOWCONTROLWINDOW, PREF_SHOWDASHBOARD, PREF_SHOWDECODEDIALOG, PREF_SHOWHIDDENFILES, PREF_SHOWQUITCONFIRM, PREF_SITEPATH, PREF_THREADS_DATA, PREF_THREADS_RENDER, PREF_TIMEZONE, PREF_VERTICALCS, PREF_VERTICALUNIT, PREF_ZIDV_ASK, PREF_ZIDV_DIRECTORY, PREF_ZIDV_SAVETOTMP, PROP_3DMODE, PROP_ABOUTTEXT, PROP_APPRESOURCEPATH, PROP_CHOOSERS, PROP_CHOOSERS_ALL, PROP_CONTROLDESCRIPTORS, PROP_CONTROLDESCRIPTORS_ALL, PROP_DATAHOLDERBOUNDS, PROP_DEFAULTLOCATIONS, PROP_DISPLAYLIST_GROUP, PROP_FIXFILELOCKUP, PROP_JNLPCODEBASE, PROP_JNLPTEMPLATE, PROP_JNLPTITLE, PROP_LOADINGXML, PROP_MAP_GLOBE_LEVEL, PROP_MAP_MAP_LEVEL, PROP_MINIMUMFRAMECYCLETIME, PROP_MONITORPORT, PROP_OLDCONTROLDESCRIPTORS, PROP_ONEINSTANCEPORT, PROP_PREFERENCES, PROP_PROJ_NAME, PROP_RESOURCEFILES, PROP_SHOWCLOCK, PROP_SHOWDASHBOARD, PROP_SHOWDATATREE, PROP_SHOWFORMULAS, PROP_SHOWSPLASH, PROP_SPLASHICON, PROP_UI_DESKTOP, PROP_VERSIONFILE, PROP_WINDOW_SCREENSIZEOFFSET, PROP_WINDOW_SIZEHEIGHT, PROP_WINDOW_SIZEWIDTH, PROP_WINDOW_USESCREENSIZE, SUFFIX_BAT, SUFFIX_CPT, SUFFIX_ISL, SUFFIX_JNLP, SUFFIX_RBI, SUFFIX_SH, SUFFIX_XIDV, SUFFIX_XML, SUFFIX_ZIDV

Constructor Summary

Constructors
Constructor and Description

PersistenceManager()
Java requires this constructor.

PersistenceManager(IntegratedDataViewer idv)

Constructors
Constructor and Description
`PersistenceManager()` Java requires this constructor.
`PersistenceManager(IntegratedDataViewer idv)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addParameterSetCategory(String parameterType, String category)` Add the directory
`protected boolean`	`addToBundle(Hashtable data, List dataSources, List displayControls, List viewManagers, String jython)` Overridden so that McIDAS-V can: add better versioning information to bundles remove `ReadoutProbes` from the `displayControls` that are getting persisted.
`protected List<WindowInfo>`	`betterInject(List<WindowInfo> windows)` Builds an altered copy of `windows` that preserves the number of windows while ensuring all displays are inside component holders.
`protected List<IdvComponentHolder>`	`buildHolders(WindowInfo window)` Builds a list of component holders with all of `window`'s displays.
`private void`	`checkForBadMaps(String bundlePath)`
`void`	`decodeXml(String xml, boolean fromCollab, String xmlFile, String label, boolean showDialog, boolean shouldMerge, Hashtable bundleProperties, boolean removeAll, boolean letUserChangeData)` Overridden so that McIDAS-V can redirect to the version of this method that supports limiting the number of new windows.
`void`	`decodeXml(String xml, boolean fromCollab, String xmlFile, String label, boolean showDialog, boolean shouldMerge, Hashtable bundleProperties, boolean removeAll, boolean letUserChangeData, boolean limitWindows)` Hijacks the second part of the IDV bundle loading pipeline so that McIDAS-V can limit the number of new windows.
`boolean`	`decodeXmlFile(String xmlFile, String label, boolean checkToRemove, boolean letUserChangeData, Hashtable bundleProperties)` Hijacks control of the IDV's bundle loading facilities.
`protected void`	`decodeXmlInner(String xml, boolean fromCollab, String xmlFile, String label, boolean showDialog, boolean shouldMerge, Hashtable bundleProperties, boolean didRemoveAll, boolean changeData)` Overridden so that McIDAS-V can redirect to the version of this method that supports limiting the number of new windows.
`protected void`	`decodeXmlInner(String xml, boolean fromCollab, String xmlFile, String label, boolean showDialog, boolean shouldMerge, Hashtable bundleProperties, boolean didRemoveAll, boolean letUserChangeData, boolean limitNewWindows)` Hijacks the third part of the bundle loading pipeline.
`void`	`deleteParameterSet(String parameterType, ParameterSet set)` Delete the given parameter set
`void`	`deleteParameterSetCategory(String parameterType, String category)` Delete the directory and all of its contents that the given category represents.
`void`	`doSaveAs()` Have the user select an xidv filename and write the current application state to it.
`void`	`doSaveAsDefaultLayout()`
`protected static List<ViewManager>`	`extractCompGroupVMs(List<WindowInfo> windows)` Builds a list of an incoming bundle's `ViewManager`s that are part of a component group.
`private void`	`fixBulkDataSources(List<DataSourceImpl> ds)` Attempts to reconcile McIDAS-V's ability to easily load all files in a directory with the way the IDV expects file data sources to behave upon unpersistence.
`protected IdvComponentGroup`	`flattenGroup(IdvComponentGroup nested)`
`protected void`	`flattenWindows(List<WindowInfo> windows)` Alters `windows` so that no windows in the bundle contain nested component groups.
`private List<ViewManager>`	`generateViewManagers(List<DisplayControlImpl> controls)`
`List<String>`	`getAllParameterSetCategories(String parameterType)` Get a list of all of the categories for the given parameterType
`List<ParameterSet>`	`getAllParameterSets(String parameterType)` Get the list of `ParameterSet`s that are writable
`JPanel`	`getFileAccessory()` Create, if needed, and return te GUI panel to put into the file dialog when saving a file.
`ViewManager`	`getLastViewManager()` Returns the last active `ViewManager` from before loading the most recent bundle.
`List`	`getLocalBundles()` Create, if needed, and return the list of locally saved `SavedBundle`s
`boolean`	`getMergeBundledLayers()`
`private Element`	`getParameterTypeNode(String parameterType)` Get the node representing the parameterType
`boolean`	`getSaveDataSources()` Should the data sources be saved
`boolean`	`getSaveDisplays()` Should the displays be saved
`boolean`	`getSaveJython()` Should the jython be saved
`boolean`	`getSaveViewState()` Should the view state be saved
`protected List<WindowInfo>`	`injectComponentGroups(List<WindowInfo> windows)` Builds a single window with a single component group.
`protected void`	`instantiateFromBundle(Hashtable ht, boolean fromCollab, LoadBundleDialog loadDialog, boolean shouldMerge, Hashtable bundleProperties, boolean didRemoveAll, boolean letUserChangeData)` Overridden so that McIDAS-V can redirect to the version of this method that supports limiting the number of new windows.
`protected void`	`instantiateFromBundle(Hashtable ht, boolean fromCollab, LoadBundleDialog loadDialog, boolean shouldMerge, Hashtable bundleProperties, boolean didRemoveAll, boolean letUserChangeData, boolean limitNewWindows)` Overridden so that McIDAS-V can preempt the IDV's bundle loading.
`private boolean`	`isBulkDataSource(DataSourceImpl d)` Attempts to determine whether or not a given `DataSourceImpl` is the result of a McIDAS-V "bulk load".
`boolean`	`isBundleLoading()` Returns whether or not a bundle is currently being loaded.
`protected void`	`loadBundlesInDirectory(List<SavedBundle> allBundles, List categories, File file)` For each of of the bundle files in the given file directory create a SavedBundle object with the given categories list ad add it into the given allBundles list.
`McvComponentHolder`	`makeDynSkin(WindowInfo info)` Uses the `ViewManager`s in `info` to build a dynamic skin.
`List<ViewManager>`	`mapDynamicSkins(List<WindowInfo> windows)` Builds a list of any dynamic skins in the bundle and adds them to the UIMananger's "cache" of encountered ViewManagers.
`void`	`moveParameterSet(String parameterType, ParameterSet set, List categories)` Move the bundle to the given category area
`void`	`moveParameterSetCategory(String parameterType, List fromCategories, List toCategories)` Move the bundle category
`protected static void`	`populateEssentialLists(String[] ids, Hashtable<String,Object> table)` Ensures that the lists corresponding to the ids in `ids` actually exist in `table`, even if they are empty.
`protected static List<IdvComponentHolder>`	`removeUIHolders(IdvComponentGroup group)`
`protected static List<WindowInfo>`	`removeUIHolders(List<WindowInfo> windows)` Returns an altered copy of `windows` containing only component holders that have displays.
`void`	`renameParameterSet(String parameterType, ParameterSet set)` Rename the parameter set
`protected void`	`reverseCollisions(List<ViewManager> vms)` Does the work in fixing the collisions described in the `instantiateFromBundle` javadoc.
`boolean`	`saveParameterSet(String parameterType, Hashtable parameterValues)` Show the Save Parameter Set dialog
`private void`	`setMergeBundledLayers(boolean newValue)`
`private List<WindowInfo>`	`wrapViewManagers(List<ViewManager> vms)`
`void`	`writeParameterSets()` Write the parameter sets

Methods inherited from class ucar.unidata.idv.IdvPersistenceManager
addBundleCategories, addBundleCategory, addFileMapping, addToBundle, applyPropertiesToBundle, categoriesToString, changeData, changeState, changeState, cleanupOldSavedBundles, clearDataSourcesState, clearDataSourcesState, clearFileMapping, clearPrototype, copyBundle, decodeBase64Bundle, decodeJnlpFile, decodeXml, decodeXmlFile, decodeXmlFile, decodeXmlFile, decodeXmlFile, decodeXmlFile, decodeXmlInner, deleteBundle, deleteBundleCategory, doImport, doOpenDefault, doSave, doSave, doSave, doSaveAsDefault, doSaveAsFavorite, encodeSpecial, export, extractBundleFromJnlp, fileToCategories, flushState, getAllCategories, getBundleDirectory, getBundles, getBundleTitle, getBundleXml, getBundleXml, getBundleXml, getCategories, getCategorizedFile, getControlDescriptors, getCurrentFileName, getCurrentTemplateName, getDataSourceBundles, getDataSourcesToPersist, getDisplayTemplates, getFavorites, getFavoritesCategories, getJnlpBundle, getJnlpBundle, getPrototype, getPrototypeFile, getSaveData, getWritableBundles, getXmlBundles, initBundleMenu, instantiateFromTemplate, loadB64Bundle, makeCategoryBox, makeDataSourceFromXml, moveBundle, moveCategory, moveOrCopyBundle, open, open, rename, saveDataSource, saveDisplayControl, saveDisplayControl, saveDisplayControlFavorite, setCurrentFileName, setFileMapping, showDataEditableGui, showDataEmbedGui, showDataRelativeGui, stringToCategories, updateDataPaths, writePrototype

Methods inherited from class ucar.unidata.ui.WindowHolder
actionPerformed, close, doMakeContents, getContents, getDialog, getFrame, getWindow, getWindowTitle, isShowing, removeAll, setMenuBar, setWindowTitle, shouldMakeDialog, show, show, showModal, toFront, windowIsClosing

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ID_MCV_VERSION
```
public static final String ID_MCV_VERSION
```
    Key used to access a bundle's McIDAS-V in-depth versioning info section.
    
    See Also:
    Constant Field Values
  - logger
```
private static final org.slf4j.Logger logger
```
  - MACRO_ZIDVPATH
```
private static final String MACRO_ZIDVPATH
```
    Macro used as a place holder for wherever the IDV decides to place extracted contents of a bundle.
    
    See Also:
    Constant Field Values
  - log_
```
static LogUtil.LogCategory log_
```
  - savingDefaultLayout
```
private boolean savingDefaultLayout
```
    Is the bundle being saved a layout bundle?
  - lastBeforeBundle
```
private ViewManager lastBeforeBundle
```
    Stores the last active ViewManager from before a bundle load.
  - mergeBundledLayers
```
private boolean mergeBundledLayers
```
    Whether or not the user wants to attempt merging bundled layers into current displays.
  - bundleLoading
```
private boolean bundleLoading
```
    Whether or not a bundle is actively loading.
  - parameterSets
```
private XmlResourceCollection parameterSets
```
    Cache the parameter sets XML
  - parameterSetsDocument
```
private static Document parameterSetsDocument
```
  - parameterSetsRoot
```
private static Element parameterSetsRoot
```
  - TAG_FOLDER
```
private static final String TAG_FOLDER
```
    See Also:
    Constant Field Values
  - TAG_DEFAULT
```
private static final String TAG_DEFAULT
```
    See Also:
    Constant Field Values
  - ATTR_NAME
```
private static final String ATTR_NAME
```
    See Also:
    Constant Field Values
  - layoutOnlyRadio
```
private JRadioButton layoutOnlyRadio
```
    Use radio buttons to control state saving
  - layoutSourcesRadio
```
private JRadioButton layoutSourcesRadio
```
  - layoutSourcesDataRadio
```
private JRadioButton layoutSourcesDataRadio
```
  - OLD_COMP_STUFF
```
private static final String OLD_COMP_STUFF
```
    See Also:
    Constant Field Values
  - NEW_COMP_STUFF
```
private static final String NEW_COMP_STUFF
```
    See Also:
    Constant Field Values
  - OLD_SOURCE_MACRO
```
private static final String OLD_SOURCE_MACRO
```
    See Also:
    Constant Field Values
  - NEW_SOURCE_MACRO
```
private static final String NEW_SOURCE_MACRO
```
    See Also:
    Constant Field Values
  - DYNSKIN_TMPNAME
```
private static final String DYNSKIN_TMPNAME
```
    See Also:
    Constant Field Values
  - DYNSKIN_TAG_PANEL
```
private static final String DYNSKIN_TAG_PANEL
```
    See Also:
    Constant Field Values
  - DYNSKIN_TAG_VIEW
```
private static final String DYNSKIN_TAG_VIEW
```
    See Also:
    Constant Field Values
  - DYNSKIN_ATTR_ID
```
private static final String DYNSKIN_ATTR_ID
```
    See Also:
    Constant Field Values
  - DYNSKIN_ATTR_COLS
```
private static final String DYNSKIN_ATTR_COLS
```
    See Also:
    Constant Field Values
  - DYNSKIN_ATTR_PROPS
```
private static final String DYNSKIN_ATTR_PROPS
```
    See Also:
    Constant Field Values
  - DYNSKIN_ATTR_CLASS
```
private static final String DYNSKIN_ATTR_CLASS
```
    See Also:
    Constant Field Values
  - DYNSKIN_ATTR_VIEWID
```
private static final String DYNSKIN_ATTR_VIEWID
```
    See Also:
    Constant Field Values
  - DYNSKIN_PROPS_GLOBE
```
private static final String DYNSKIN_PROPS_GLOBE
```
    See Also:
    Constant Field Values
  - DYNSKIN_PROPS_GENERAL
```
private static final String DYNSKIN_PROPS_GENERAL
```
    See Also:
    Constant Field Values
  - DYNSKIN_ID_VALUE
```
private static final String DYNSKIN_ID_VALUE
```
    See Also:
    Constant Field Values
  - SIMPLE_SKIN_TEMPLATE
```
private static final String SIMPLE_SKIN_TEMPLATE
```
    XML template for generating dynamic skins.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - PersistenceManager
```
public PersistenceManager()
```
    Java requires this constructor.
  - PersistenceManager
```
public PersistenceManager(IntegratedDataViewer idv)
```
    See Also:
    ucar.unidata.idv.IdvPersistenceManager#PersistenceManager(IntegratedDataViewer)
- Method Detail
  - getLastViewManager
```
public ViewManager getLastViewManager()
```
    Returns the last active ViewManager from before loading the most recent bundle.
    
    Returns:
    Either the ViewManager or null if there was no previous ViewManager (such as loading a default bundle/layout).
  - isBundleLoading
```
public boolean isBundleLoading()
```
    Returns whether or not a bundle is currently being loaded.
    
    Returns:
    Either true if instantiateFromBundle is doing what it needs to do, or false.
    See Also:
    instantiateFromBundle(Hashtable, boolean, LoadBundleDialog, boolean, Hashtable, boolean, boolean, boolean)
  - getMergeBundledLayers
```
public boolean getMergeBundledLayers()
```
  - setMergeBundledLayers
```
private void setMergeBundledLayers(boolean newValue)
```
  - getSaveDataSources
```
public boolean getSaveDataSources()
```
    Description copied from class: ucar.unidata.idv.IdvPersistenceManager
    
    Should the data sources be saved
    
    Overrides:
    
    getSaveDataSources in class IdvPersistenceManager
    
    Returns:
    Save the data sources
  - getSaveDisplays
```
public boolean getSaveDisplays()
```
    Description copied from class: ucar.unidata.idv.IdvPersistenceManager
    
    Should the displays be saved
    
    Overrides:
    
    getSaveDisplays in class IdvPersistenceManager
    
    Returns:
    Save the displays
  - getSaveViewState
```
public boolean getSaveViewState()
```
    Description copied from class: ucar.unidata.idv.IdvPersistenceManager
    
    Should the view state be saved
    
    Overrides:
    
    getSaveViewState in class IdvPersistenceManager
    
    Returns:
    Save the view state
  - getSaveJython
```
public boolean getSaveJython()
```
    Description copied from class: ucar.unidata.idv.IdvPersistenceManager
    
    Should the jython be saved
    
    Overrides:
    
    getSaveJython in class IdvPersistenceManager
    
    Returns:
    Save the data sources
  - doSaveAsDefaultLayout
```
public void doSaveAsDefaultLayout()
```
  - getFileAccessory
```
public JPanel getFileAccessory()
```
    Description copied from class: ucar.unidata.idv.IdvPersistenceManager
    
    Create, if needed, and return te GUI panel to put into the file dialog when saving a file.
    
    Overrides:
    
    getFileAccessory in class IdvPersistenceManager
    
    Returns:
    The file accessory panel
  - doSaveAs
```
public void doSaveAs()
```
    Have the user select an xidv filename and write the current application state to it. This also sets the current file name and adds the file to the history list.
    
    Overrides:
    
    doSaveAs in class IdvPersistenceManager
  - addToBundle
```
protected boolean addToBundle(Hashtable data,
                  List dataSources,
                  List displayControls,
                  List viewManagers,
                  String jython)
```
    Overridden so that McIDAS-V can:
    - add better versioning information to bundles
    - remove ReadoutProbes from the displayControls that are getting persisted.
    - disallow saving multi-banded ADDE data sources until we have fix!
    Overrides:
    
    addToBundle in class IdvPersistenceManager
    
    Parameters:
    data - Holds the bundle state
    dataSources - List of data sources to add
    displayControls - List of displays to add
    viewManagers - List of view managers to add
    jython - jython to add
    
    Returns:
    If user is ok
  - getLocalBundles
```
public List getLocalBundles()
```
    Description copied from class: ucar.unidata.idv.IdvPersistenceManager
    
    Create, if needed, and return the list of locally saved SavedBundles
    
    Overrides:
    
    getLocalBundles in class IdvPersistenceManager
    
    Returns:
    List of saved bundles
  - loadBundlesInDirectory
```
protected void loadBundlesInDirectory(List<SavedBundle> allBundles,
                          List categories,
                          File file)
```
    Description copied from class: ucar.unidata.idv.IdvPersistenceManager
    
    For each of of the bundle files in the given file directory create a SavedBundle object with the given categories list ad add it into the given allBundles list.
    
    Overrides:
    
    loadBundlesInDirectory in class IdvPersistenceManager
    
    Parameters:
    allBundles - The list to put the bundles in
    categories - Categories for the SavedBundle objects
    file - Where to look
  - decodeXml
```
public void decodeXml(String xml,
             boolean fromCollab,
             String xmlFile,
             String label,
             boolean showDialog,
             boolean shouldMerge,
             Hashtable bundleProperties,
             boolean removeAll,
             boolean letUserChangeData)
```
    Overridden so that McIDAS-V can redirect to the version of this method that supports limiting the number of new windows.
    
    Overrides:
    
    decodeXml in class IdvPersistenceManager
    
    Parameters:
    xml - The bundle xml
    fromCollab - Was this bundle from the collaboration facility. If it was we treat it differently.
    xmlFile - The filename this came from. May be null.
    label - The label to use in the dialog
    showDialog - Should the dialog be shown
    shouldMerge - Should we merge the windows/views in the bundle into the existing windows
    bundleProperties - set of properties
    removeAll - Should we remove all data/displays
    letUserChangeData - Should popup the data path dialog
    See Also:
    decodeXml(String, boolean, String, String, boolean, boolean, Hashtable, boolean, boolean, boolean)
  - decodeXmlFile
```
public boolean decodeXmlFile(String xmlFile,
                    String label,
                    boolean checkToRemove,
                    boolean letUserChangeData,
                    Hashtable bundleProperties)
```
    Hijacks control of the IDV's bundle loading facilities. Due to the way versions of McIDAS-V prior to alpha 10 handled tabs, the user will end up with a new window for each tab in the bundle. McIDAS-V alpha 10 has the ability to only create one new window and have everything else go into that window's tabs.
    
    Overrides:
    
    decodeXmlFile in class IdvPersistenceManager
    
    Parameters:
    xmlFile - file
    label - label
    checkToRemove - check to remove
    letUserChangeData - if true then ask user to change data paths
    bundleProperties - set of properties
    
    Returns:
    everything cool
    See Also:
    IdvPersistenceManager.decodeXmlFile(String, String, boolean, boolean, Hashtable), decodeXml(String, boolean, String, String, boolean, boolean, Hashtable, boolean, boolean, boolean)
  - decodeXmlInner
```
protected void decodeXmlInner(String xml,
                  boolean fromCollab,
                  String xmlFile,
                  String label,
                  boolean showDialog,
                  boolean shouldMerge,
                  Hashtable bundleProperties,
                  boolean didRemoveAll,
                  boolean changeData)
```
    Overridden so that McIDAS-V can redirect to the version of this method that supports limiting the number of new windows.
    
    Overrides:
    
    decodeXmlInner in class IdvPersistenceManager
    
    Parameters:
    xml - The xml bundle
    fromCollab - Was this bundle from the collaboration facility. If it was we treat it differently.
    xmlFile - The filename where the xml came from - may be null.
    label - The label to show in the gui
    showDialog - Should the loadbundle dialog be shown
    shouldMerge - Should we merge the windows/views in the bundle into the existing windows
    bundleProperties - set of properties
    didRemoveAll - Was remove all called before we decoded the xml
    changeData - Should popup data path change dialog
    See Also:
    decodeXmlInner(String, boolean, String, String, boolean, boolean, Hashtable, boolean, boolean, boolean)
  - instantiateFromBundle
```
protected void instantiateFromBundle(Hashtable ht,
                         boolean fromCollab,
                         LoadBundleDialog loadDialog,
                         boolean shouldMerge,
                         Hashtable bundleProperties,
                         boolean didRemoveAll,
                         boolean letUserChangeData)
                              throws Exception
```
    Overridden so that McIDAS-V can redirect to the version of this method that supports limiting the number of new windows.
    
    Overrides:
    
    instantiateFromBundle in class IdvPersistenceManager
    
    Parameters:
    ht - Contains the unpersisted objects
    fromCollab - Was this bundle from the collaboration facility. If it was we treat it differently.
    loadDialog - The load bundle dialog
    shouldMerge - Should we merge the windows/views in the bundle into the existing windows
    bundleProperties - set of properties
    didRemoveAll - Was remove all called before we decoded the xml
    letUserChangeData - Should popup data path change dialog
    
    Throws:
    
    Exception
    See Also:
    instantiateFromBundle(Hashtable, boolean, LoadBundleDialog, boolean, Hashtable, boolean, boolean, boolean)
  - decodeXml
```
public void decodeXml(String xml,
             boolean fromCollab,
             String xmlFile,
             String label,
             boolean showDialog,
             boolean shouldMerge,
             Hashtable bundleProperties,
             boolean removeAll,
             boolean letUserChangeData,
             boolean limitWindows)
```
    Hijacks the second part of the IDV bundle loading pipeline so that McIDAS-V can limit the number of new windows.
    
    See Also:
    IdvPersistenceManager.decodeXml(String, boolean, String, String, boolean, boolean, Hashtable, boolean, boolean), decodeXmlInner(String, boolean, String, String, boolean, boolean, Hashtable, boolean, boolean, boolean)
  - decodeXmlInner
```
protected void decodeXmlInner(String xml,
                  boolean fromCollab,
                  String xmlFile,
                  String label,
                  boolean showDialog,
                  boolean shouldMerge,
                  Hashtable bundleProperties,
                  boolean didRemoveAll,
                  boolean letUserChangeData,
                  boolean limitNewWindows)
```
    Hijacks the third part of the bundle loading pipeline.
    
    See Also:
    IdvPersistenceManager.decodeXmlInner(String, boolean, String, String, boolean, boolean, Hashtable, boolean, boolean), instantiateFromBundle(Hashtable, boolean, LoadBundleDialog, boolean, Hashtable, boolean, boolean, boolean)
  - checkForBadMaps
```
private void checkForBadMaps(String bundlePath)
```
  - extractCompGroupVMs
```
protected static List<ViewManager> extractCompGroupVMs(List<WindowInfo> windows)
```
    Builds a list of an incoming bundle's ViewManagers that are part of a component group.
    
    The reason for only being interested in component groups is because any windows not using component groups will be made into a dynamic skin. The associated ViewManagers do not technically exist until the skin has been "built", so there's nothing to do. These ViewManagers must also be removed from the bundle's list of ViewManagers.
    
    However, any ViewManagers associated with component groups still need to appear in the bundle's ViewManager list, and that's where this method comes into play!
    
    Parameters:
    windows - WindowInfos to be searched.
    
    Returns:
    List of ViewManagers inside any component groups.
  - reverseCollisions
```
protected void reverseCollisions(List<ViewManager> vms)
```
    Does the work in fixing the collisions described in the instantiateFromBundle javadoc. Basically just queries the VMManager for each ViewManager. If a match is found, a new ID is generated and associated with the ViewManager, its ViewDescriptor, and any associated DisplayControls.
    
    Parameters:
    vms - ViewManagers in the incoming bundle.
    See Also:
    instantiateFromBundle(Hashtable, boolean, LoadBundleDialog, boolean, Hashtable, boolean, boolean, boolean)
  - injectComponentGroups
```
protected List<WindowInfo> injectComponentGroups(List<WindowInfo> windows)
                                          throws Exception
```
    Builds a single window with a single component group. The group contains component holders that correspond to each window or component holder stored in the incoming bundle.
    
    Parameters:
    windows - The bundle's list of WindowInfos.
    
    Returns:
    List of WindowInfos that contains only one element/window.
    
    Throws:
    
    Exception - Bubble up any exceptions from makeImpromptuSkin.
  - betterInject
```
protected List<WindowInfo> betterInject(List<WindowInfo> windows)
                                 throws Exception
```
    Builds an altered copy of windows that preserves the number of windows while ensuring all displays are inside component holders.
    
    Throws:
    
    Exception - Bubble up dynamic skin exceptions.
    See Also:
    injectComponentGroups(List)
  - buildHolders
```
protected List<IdvComponentHolder> buildHolders(WindowInfo window)
                                         throws Exception
```
    Builds a list of component holders with all of window's displays.
    
    Throws:
    
    Exception - Bubble up any problems creating a dynamic skin.
  - mapDynamicSkins
```
public List<ViewManager> mapDynamicSkins(List<WindowInfo> windows)
```
    Builds a list of any dynamic skins in the bundle and adds them to the UIMananger's "cache" of encountered ViewManagers.
    
    Parameters:
    windows - The bundle's windows.
    
    Returns:
    Any dynamic skins in windows.
  - fixBulkDataSources
```
private void fixBulkDataSources(List<DataSourceImpl> ds)
```
    Attempts to reconcile McIDAS-V's ability to easily load all files in a directory with the way the IDV expects file data sources to behave upon unpersistence.
    The problem is twofold: the paths referenced in the data source's Sources may not exist, and the persistence code combines each individual file into a blob.
    The current solution is to note that the data source's PollingInfo is used by FilesDataSource.initWithPollingInfo() to replace the contents of the data source's file paths. Simply overwrite PollingInfo#filePaths with the path to the blob.
    
    Parameters:
    ds - List of DataSourceImpls to inspect and/or fix. Cannot be null.
    See Also:
    isBulkDataSource(DataSourceImpl)
  - isBulkDataSource
```
private boolean isBulkDataSource(DataSourceImpl d)
```
    Attempts to determine whether or not a given DataSourceImpl is the result of a McIDAS-V "bulk load".
    
    Parameters:
    d - DataSourceImpl to check. Cannot be null.
    
    Returns:
    true if the DataSourceImpl matched the criteria.
  - instantiateFromBundle
```
protected void instantiateFromBundle(Hashtable ht,
                         boolean fromCollab,
                         LoadBundleDialog loadDialog,
                         boolean shouldMerge,
                         Hashtable bundleProperties,
                         boolean didRemoveAll,
                         boolean letUserChangeData,
                         boolean limitNewWindows)
                              throws Exception
```
    Overridden so that McIDAS-V can preempt the IDV's bundle loading. There will be problems if any of the incoming ViewManagers share an ID with an existing ViewManager. While this case may seem unlikely, it can be triggered when loading a bundle and then reloading. The problem is that the ViewManagers are the same, and if the previous ViewManagers were not removed, the IDV doesn't know what to do.
    
    Assigning the incoming ViewManagers a new ID, and associating its ViewDescriptors and DisplayControls with the new ID fixes this problem.
    
    McIDAS-V also allows the user to limit the number of new windows the bundle may create. If enabled, one new window will be created, and any additional windows will become tabs (component holders) inside the new window.
    
    McIDAS-V also prefers the bundles being loaded to be in a semi-regular regular state. For example, say you have bundle containing only data. The bundle will probably not contain lists of WindowInfos or ViewManagers. Perhaps the bundle contains nested component groups as well! McIDAS-V will alter the unpersisted bundle state (not the actual bundle file) to make it fit into the expected idiom. Mostly this just entails wrapping things in component groups and holders while "flattening" any nested component groups.
    
    Parameters:
    ht - Holds unpersisted objects.
    fromCollab - Did the bundle come from the collab stuff?
    loadDialog - Show the bundle loading dialog?
    shouldMerge - Merge bundle contents into an existing window?
    bundleProperties - If non-null, use the set of time indices for data sources?
    didRemoveAll - Remove all data and displays?
    letUserChangeData - Allow changes to the data path?
    limitNewWindows - Only create one new window?
    
    Throws:
    
    Exception
    See Also:
    IdvPersistenceManager.instantiateFromBundle(Hashtable, boolean, LoadBundleDialog, boolean, Hashtable, boolean, boolean)
  - wrapViewManagers
```
private List<WindowInfo> wrapViewManagers(List<ViewManager> vms)
```
  - generateViewManagers
```
private List<ViewManager> generateViewManagers(List<DisplayControlImpl> controls)
```
  - flattenWindows
```
protected void flattenWindows(List<WindowInfo> windows)
```
    Alters windows so that no windows in the bundle contain nested component groups.
  - flattenGroup
```
protected IdvComponentGroup flattenGroup(IdvComponentGroup nested)
```
    Returns:
    An altered version of nested that contains no nested component groups.
  - removeUIHolders
```
protected static List<IdvComponentHolder> removeUIHolders(IdvComponentGroup group)
```
    Returns:
    An altered group containing only component holders with displays.
  - populateEssentialLists
```
protected static void populateEssentialLists(String[] ids,
                          Hashtable<String,Object> table)
```
    Ensures that the lists corresponding to the ids in ids actually exist in table, even if they are empty.
  - removeUIHolders
```
protected static List<WindowInfo> removeUIHolders(List<WindowInfo> windows)
```
    Returns an altered copy of windows containing only component holders that have displays.
    
    The IDV allows users to embed HTML controls or things like the dashboard into component holders. This ability, while powerful, could make for a confusing UI.
  - makeDynSkin
```
public McvComponentHolder makeDynSkin(WindowInfo info)
                               throws Exception
```
    Uses the ViewManagers in info to build a dynamic skin.
    
    Parameters:
    info - Window that needs to become a dynamic skin.
    
    Returns:
    A McvComponentHolder containing the ViewManagers inside info.
    
    Throws:
    
    Exception - Bubble up any XML problems.
  - writeParameterSets
```
public void writeParameterSets()
```
    Write the parameter sets
  - getParameterTypeNode
```
private Element getParameterTypeNode(String parameterType)
```
    Get the node representing the parameterType
    
    Parameters:
    parameterType - What type of parameter set
    
    Returns:
    Element representing parameterType node
  - getAllParameterSetCategories
```
public List<String> getAllParameterSetCategories(String parameterType)
```
    Get a list of all of the categories for the given parameterType
    
    Parameters:
    parameterType - What type of parameter set
    
    Returns:
    List of (String) categories
  - getAllParameterSets
```
public List<ParameterSet> getAllParameterSets(String parameterType)
```
    Get the list of ParameterSets that are writable
    
    Parameters:
    parameterType - The type of parameter set
    
    Returns:
    List of writable parameter sets
  - addParameterSetCategory
```
public boolean addParameterSetCategory(String parameterType,
                              String category)
```
    Add the directory
    
    Parameters:
    parameterType - The type of parameter set
    category - The category (really a ">" delimited string)
    
    Returns:
    true if the create was successful. False if there already is a category with that name
  - deleteParameterSet
```
public void deleteParameterSet(String parameterType,
                      ParameterSet set)
```
    Delete the given parameter set
    
    Parameters:
    parameterType - The type of parameter set
    name - The name of the parameter set
  - deleteParameterSetCategory
```
public void deleteParameterSetCategory(String parameterType,
                              String category)
```
    Delete the directory and all of its contents that the given category represents.
    
    Parameters:
    parameterType - The type of parameter set
    category - The category (really a ">" delimited string)
  - renameParameterSet
```
public void renameParameterSet(String parameterType,
                      ParameterSet set)
```
    Rename the parameter set
    
    Parameters:
    parameterType - The type of parameter set
    set - The parameter set
  - moveParameterSet
```
public void moveParameterSet(String parameterType,
                    ParameterSet set,
                    List categories)
```
    Move the bundle to the given category area
    
    Parameters:
    parameterType - The type of parameter set
    set - The parameter set
    categories - Where to move to
  - moveParameterSetCategory
```
public void moveParameterSetCategory(String parameterType,
                            List fromCategories,
                            List toCategories)
```
    Move the bundle category
    
    Parameters:
    parameterType - The type of parameter set
    fromCategories - The category to move
    toCategories - Where to move to
  - saveParameterSet
```
public boolean saveParameterSet(String parameterType,
                       Hashtable parameterValues)
```
    Show the Save Parameter Set dialog

Class PersistenceManager

Nested Class Summary

Nested classes/interfaces inherited from class ucar.unidata.idv.IdvPersistenceManager

Field Summary

Fields inherited from class ucar.unidata.idv.IdvPersistenceManager

Fields inherited from class ucar.unidata.ui.WindowHolder

Fields inherited from interface ucar.unidata.idv.IdvConstants

Constructor Summary

Method Summary

Methods inherited from class ucar.unidata.idv.IdvPersistenceManager

Methods inherited from class ucar.unidata.idv.IdvManager

Methods inherited from class ucar.unidata.ui.WindowHolder

Methods inherited from class java.lang.Object

Field Detail

ID_MCV_VERSION

logger

MACRO_ZIDVPATH

log_

savingDefaultLayout

lastBeforeBundle

mergeBundledLayers

bundleLoading

parameterSets

parameterSetsDocument

parameterSetsRoot

TAG_FOLDER

TAG_DEFAULT

ATTR_NAME

layoutOnlyRadio

layoutSourcesRadio

layoutSourcesDataRadio

OLD_COMP_STUFF

NEW_COMP_STUFF

OLD_SOURCE_MACRO

NEW_SOURCE_MACRO

DYNSKIN_TMPNAME

DYNSKIN_TAG_PANEL

DYNSKIN_TAG_VIEW

DYNSKIN_ATTR_ID

DYNSKIN_ATTR_COLS

DYNSKIN_ATTR_PROPS

DYNSKIN_ATTR_CLASS

DYNSKIN_ATTR_VIEWID

DYNSKIN_PROPS_GLOBE

DYNSKIN_PROPS_GENERAL

DYNSKIN_ID_VALUE

SIMPLE_SKIN_TEMPLATE

Constructor Detail

PersistenceManager

PersistenceManager

Method Detail

getLastViewManager

isBundleLoading

getMergeBundledLayers

setMergeBundledLayers

getSaveDataSources

getSaveDisplays

getSaveViewState

getSaveJython

doSaveAsDefaultLayout

getFileAccessory

doSaveAs

addToBundle

getLocalBundles

loadBundlesInDirectory

decodeXml

decodeXmlFile

decodeXmlInner

instantiateFromBundle

decodeXml

decodeXmlInner

checkForBadMaps

extractCompGroupVMs

reverseCollisions

injectComponentGroups

betterInject

buildHolders

mapDynamicSkins

fixBulkDataSources

isBulkDataSource