ucar.util.prefs

Class XMLStore

java.lang.Object

ucar.util.prefs.XMLStore

public class XMLStore
extends java.lang.Object

This implements an XML-based backing store for PreferencesExt. XMLStores can be chained together to provide independent collections of "stored defaults", eg store1 -> store2 -> store3. In this case, a call to getXXX( key) first looks in store1, and if not found, then in store2, etc. A call to putXXX(key, value) first checks to see if the (key, value) pair already exists in any of the chained stores; if not, then it is added to store1. Normally, only store1 would be changed and saved.

A chain of stored defaults might look like:

 try {
   XMLStore store3 = XMLStore.createFromResource("/auxdata/system.xml", null);
   XMLStore store2 = XMLStore.createFromFile("/usr/local/metapps/GDV/site.xml", store3);
   XMLStore store1 = XMLStore.createFromFile("/home/username/.GDV/user.xml", store2);
   PreferencesExt prefs = store1.getPreferences();
 } catch (IOException e) {
   System.out.println("XMLStore Creation failed "+e);
 }
 

If you plan to call Preferences.userRoot(), you must explicilty set it, eg:

   PreferencesExt.setUserRoot( prefs);
 

Before exiting the application, in order to save changes, you must call:

 try {
   store1.save();
 } catch (IOException e) {
   System.out.println("XMLStore Save failed "+e);
 }
  

Author:

John Caron

See Also:

PreferencesExt, Preferences

Constructor Summary

Constructors

Constructor and Description
XMLStore()

Method Summary

Methods

Modifier and Type	Method and Description
static XMLStore	createFromFile(java.lang.String fileName, XMLStore storedDefaults) Create an XMLStore reading from the specified filename.
static XMLStore	createFromInputStream(java.io.InputStream is1, java.io.InputStream is2, XMLStore storedDefaults) Create an XMLStore reading from an input stream.
static XMLStore	createFromResource(java.lang.String resourceName, XMLStore storedDefaults) Create a read-only XMLStore reading from the specified resource, opened as a Resource stream using the XMLStore ClassLoader.
PreferencesExt	getPreferences() Get the root Preferences node.
static java.lang.String	makeStandardFilename(java.lang.String appName, java.lang.String storeName) Convenience routine for creating an XMLStore file in a standard place.
void	save() Save the current state of the Preferences tree to disk, using the original filename.
void	save(java.io.OutputStream out) Save the current state of the Preferences tree to the given OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLStore

public XMLStore()

Method Detail

createFromFile

public static XMLStore createFromFile(java.lang.String fileName,
                      XMLStore storedDefaults)
                               throws java.io.IOException

Create an XMLStore reading from the specified filename.

Parameters:

fileName - The XMLStore is stored in this files.

storedDefaults - This contains the "stored defaults", or null if none.

Returns:

new XMLStore object

Throws:

java.io.IOException - on error

createFromInputStream

public static XMLStore createFromInputStream(java.io.InputStream is1,
                             java.io.InputStream is2,
                             XMLStore storedDefaults)
                                      throws java.io.IOException

Create an XMLStore reading from an input stream. Because of some peculiariteis, you must open the input stream wtice, and pass both in.

Parameters:

is1 - the first copy of the input stream.

is2 - the second copy of the input stream.

storedDefaults - This contains the "stored defaults", or null if none.

Returns:

new XMLStore object

Throws:

java.io.IOException - on error

createFromResource

public static XMLStore createFromResource(java.lang.String resourceName,
                          XMLStore storedDefaults)
                                   throws java.io.IOException

Create a read-only XMLStore reading from the specified resource, opened as a Resource stream using the XMLStore ClassLoader. This allows you to find files that are in jar files on the application CLASSPATH.

Parameters:

resourceName - The XMLStore is stored in this resource. By convention it has .xml suffix.

storedDefaults - This contains the "stored defaults", or null if none.

Returns:

new XMLStore object

Throws:

java.io.IOException - if Resource not found or error reading it

makeStandardFilename

public static java.lang.String makeStandardFilename(java.lang.String appName,
                                    java.lang.String storeName)

Convenience routine for creating an XMLStore file in a standard place.

Initialize:

1. $user.home = System.getProperty("user.home"), if not exist, use "."
2. create directory "$(user_home)/appName/" , if not exist, create it
3. return "$(user_home)/appName/storeName" for use in createFromFile()

Parameters:

appName - application name

storeName - store name

Returns:

standard file name

getPreferences

public PreferencesExt getPreferences()

Get the root Preferences node. All manipulation is done through it.

save

public void save()
          throws java.io.IOException

Save the current state of the Preferences tree to disk, using the original filename. The XMLStore must have been constructed from a writeable XML file.

Throws:

UnsupportedOperationException: - if XMLStore was created from createFromResource.

java.io.IOException - on read error

save

public void save(java.io.OutputStream out)
          throws java.io.IOException

Save the current state of the Preferences tree to the given OutputStream.

Throws:

java.io.IOException