ucar.unidata.xml

Class XmlObjectStore

java.lang.Object

ucar.unidata.xml.XmlObjectStore

All Implemented Interfaces:

PersistentStore

Direct Known Subclasses:

IdvObjectStore

public class XmlObjectStore
extends java.lang.Object
implements PersistentStore

This allows us to use the XmlEncoder to read/write a Hashtable that holds a collection of persistent objects.

Version:

$Revision: 1.51 $

Author:

Metapps development team

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List	tmpFiles Keep track of the tmp files that have been created

Constructor Summary

Constructors

Constructor and Description
XmlObjectStore(XmlEncoder encoder) Create a new store.

Method Summary

Modifier and Type	Method and Description
int	append(XmlResourceCollection rc, boolean onlyAddIfNotExists) _more_
void	cleanupTmpDirectory() This routine will delete all files in the user's tmp directory but will leave the directories
void	cleanupTmpFiles() This method will remove all temp files that have been created during the current run of the program and clear out the list of tmp files.
java.lang.Object	get(java.lang.Object key) Lookup the given key's value.
java.lang.Object	get(java.lang.String key) Return the object held in the table identified by the given key.
boolean	get(java.lang.String key, boolean dflt) Lookup the given key's value.
char	get(java.lang.String key, char dflt) Lookup the given key's value.
java.awt.Color	get(java.lang.String key, java.awt.Color dflt) Lookup the given key's value.
double	get(java.lang.String key, double dflt) Lookup the given key's value.
float	get(java.lang.String key, float dflt) Lookup the given key's value.
java.awt.Font	get(java.lang.String key, java.awt.Font dflt) Lookup the given key's value.
int	get(java.lang.String key, int dflt) Lookup the given key's value.
long	get(java.lang.String key, long dflt) Lookup the given key's value.
short	get(java.lang.String key, short dflt) Lookup the given key's value.
java.lang.String	get(java.lang.String key, java.lang.String dflt) Lookup the given key's value.
java.lang.Object	getEncodedFile(java.lang.String filename) The given filename is a file which (should) hold the xml encoded (XmlEncoder) version of some Object.
protected XmlEncoder	getEncoder() Get the encoder we use
java.lang.String	getFileContents(java.lang.String filename) Read the contents of the filename, which is relative to the user's directory.
java.lang.String	getTmpFile(java.lang.String tail) Return the full path to a temporary file with the given file tail.
java.io.File	getUniqueTmpDirectory() _more_
java.lang.String	getUniqueTmpFile(java.lang.String prefix, java.lang.String suffix) _more_
java.io.File	getUserDirectory() We will assume that the first file in the list of store files is held within the user's directory.
java.lang.String	getUserTmpDirectory() Create (if not there) a "tmp" directory under the user's directory.
int	init(XmlResourceCollection rc) Initialize the store.
static void	main(java.lang.String[] args)
protected java.util.Hashtable	processTable(java.util.Hashtable newTable) Process a HashTable
void	put(java.lang.Object key, java.lang.Object value) Put the given value.
void	put(java.lang.String key, boolean value) Put the given value into the tabl.
void	put(java.lang.String key, char value) Put the given value into the tabl.
void	put(java.lang.String key, double value) Put the given value into the tabl.
void	put(java.lang.String key, float value) Put the given value into the tabl.
void	put(java.lang.String key, int value) Put the given value into the tabl.
void	put(java.lang.String key, long value) Put the given value into the tabl.
void	put(java.lang.String key, java.lang.Object value) Put the given value.
void	put(java.lang.String key, short value) Put the given value into the tabl.
void	putEncodedFile(java.lang.String filename, java.lang.Object o) Encode the given object and write it to the given filename.
void	putFile(java.lang.String filename, java.lang.String contents) Write the contents to the filename, which is relative to the user's directory.
void	remove(java.lang.String key) Remove the given value from the table.
void	save() Save the store to disk.
void	saveIfNeeded() Save the store to disk if there has been a put since the last save
protected void	setEncoder(XmlEncoder encoder) Set the XmlEncoder that we use
void	setTmpDir(java.lang.String dir) _more_
boolean	userDirectoryOk() Check if the userDirectory is okay to write to.

Methods inherited from class java.lang.Object

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

Field Detail

tmpFiles

protected java.util.List tmpFiles

Keep track of the tmp files that have been created

Constructor Detail

XmlObjectStore

public XmlObjectStore(XmlEncoder encoder)

Create a new store.

Parameters:

encoder -

Method Detail

setEncoder

protected void setEncoder(XmlEncoder encoder)

Set the XmlEncoder that we use

Parameters:

encoder - The encoder we use to write out the store

getEncoder

protected XmlEncoder getEncoder()

Get the encoder we use

Returns:

The encoder we use to write out the store

getUserDirectory

public java.io.File getUserDirectory()

We will assume that the first file in the list of store files is held within the user's directory.

Returns:

The user's directory.

userDirectoryOk

public boolean userDirectoryOk()

Check if the userDirectory is okay to write to.

Returns:

true if the directory exists and is writable

setTmpDir

public void setTmpDir(java.lang.String dir)

_more_

Parameters:

dir - _more_

getUserTmpDirectory

public java.lang.String getUserTmpDirectory()

Create (if not there) a "tmp" directory under the user's directory.

Returns:

The path to the new tmp directory.

getTmpFile

public java.lang.String getTmpFile(java.lang.String tail)

Return the full path to a temporary file with the given file tail. The filename will be added to a list of tmpFiles that can then be removed when an application exits.

Parameters:

tail - The file tail (e.g., temp.txt)

Returns:

The full path (e.g., ~/.metapps/tmp/temp.txt)

cleanupTmpDirectory

public void cleanupTmpDirectory()

This routine will delete all files in the user's tmp directory but will leave the directories

getUniqueTmpDirectory

public java.io.File getUniqueTmpDirectory()

_more_

Returns:

_more_

getUniqueTmpFile

public java.lang.String getUniqueTmpFile(java.lang.String prefix,
                                         java.lang.String suffix)

_more_

Parameters:

prefix - _more_

suffix - _more_

Returns:

_more_

cleanupTmpFiles

public void cleanupTmpFiles()

This method will remove all temp files that have been created during the current run of the program and clear out the list of tmp files.

init

public int init(XmlResourceCollection rc)

Initialize the store.

Parameters:

rc - The resource collection to read from

Returns:

_more_

append

public int append(XmlResourceCollection rc,
                  boolean onlyAddIfNotExists)

_more_

Parameters:

rc - _more_

onlyAddIfNotExists - _more_

Returns:

_more_

processTable

protected java.util.Hashtable processTable(java.util.Hashtable newTable)

Process a HashTable

Parameters:

newTable - table to process

Returns:

a processed table

getEncodedFile

public java.lang.Object getEncodedFile(java.lang.String filename)

The given filename is a file which (should) hold the xml encoded (XmlEncoder) version of some Object.

Parameters:

filename - The file that contains the encoded object.

Returns:

The decoded object.

putEncodedFile

public void putEncodedFile(java.lang.String filename,
                           java.lang.Object o)

Encode the given object and write it to the given filename.

Parameters:

filename - The filename to write to.

o - The object to encode.

getFileContents

public java.lang.String getFileContents(java.lang.String filename)

Read the contents of the filename, which is relative to the user's directory.

Parameters:

filename - The file to read.

Returns:

The contents of the file.

putFile

public void putFile(java.lang.String filename,
                    java.lang.String contents)

Write the contents to the filename, which is relative to the user's directory.

Parameters:

filename - The file to read.

contents - The contents of the file.

get

public java.lang.Object get(java.lang.String key)

Return the object held in the table identified by the given key.

Parameters:

key - The object's key.

Returns:

The Object identified by the given key or null if not found.

put

public void put(java.lang.String key,
                boolean value)

Put the given value into the tabl.

Parameters:

key - The object's key.

value - The value to store.

put

public void put(java.lang.String key,
                char value)

Put the given value into the tabl.

Parameters:

key - The object's key.

value - The value to store.

put

public void put(java.lang.String key,
                short value)

Put the given value into the tabl.

Parameters:

key - The object's key.

value - The value to store.

put

public void put(java.lang.String key,
                int value)

Put the given value into the tabl.

Parameters:

key - The object's key.

value - The value to store.

put

public void put(java.lang.String key,
                float value)

Put the given value into the tabl.

Parameters:

key - The object's key.

value - The value to store.

put

public void put(java.lang.String key,
                long value)

Put the given value into the tabl.

Parameters:

key - The object's key.

value - The value to store.

put

public void put(java.lang.String key,
                double value)

Put the given value into the tabl.

Parameters:

key - The object's key.

value - The value to store.

put

public void put(java.lang.Object key,
                java.lang.Object value)

Put the given value.

Specified by:

put in interface PersistentStore

Parameters:

key - Convert to toString to get the actual key.

value - The value to store.

put

public void put(java.lang.String key,
                java.lang.Object value)

Put the given value.

Parameters:

key - The object's key.

value - The value to store.

get

public java.lang.String get(java.lang.String key,
                            java.lang.String dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public java.awt.Color get(java.lang.String key,
                          java.awt.Color dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public java.awt.Font get(java.lang.String key,
                         java.awt.Font dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public boolean get(java.lang.String key,
                   boolean dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public char get(java.lang.String key,
                char dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public short get(java.lang.String key,
                 short dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public int get(java.lang.String key,
               int dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public float get(java.lang.String key,
                 float dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public long get(java.lang.String key,
                long dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public double get(java.lang.String key,
                  double dflt)

Lookup the given key's value. If not found return the dflt.

Parameters:

key - The object's key.

dflt - The default value to return if not found.

Returns:

The value of the given key or the dflt if not found.

get

public java.lang.Object get(java.lang.Object key)

Lookup the given key's value. If not found return null.

Specified by:

get in interface PersistentStore

Parameters:

key - The object's key.

Returns:

The value of the given key.

remove

public void remove(java.lang.String key)

Remove the given value from the table.

Parameters:

key - The object's key.

saveIfNeeded

public void saveIfNeeded()

Save the store to disk if there has been a put since the last save

save

public void save()

Save the store to disk.

Specified by:

save in interface PersistentStore

main

public static void main(java.lang.String[] args)

Parameters:

args - Command line args.