edu.wisc.ssec.mcidasv.util

Class JythonObjectStore

java.lang.Object

edu.wisc.ssec.mcidasv.util.JythonObjectStore

public class JythonObjectStore
extends java.lang.Object

Wraps the application's IdvObjectStore object and provides methods that are safe to use from Jython scripts.

A secondary aim of this class is to be largely API-compatible with java.util.prefs.Preferences.

Field Summary

Fields

Modifier and Type	Field and Description
private ucar.unidata.idv.IdvObjectStore	idvStore IdvObjectStore used by the current McIDAS-V session.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JythonObjectStore(ucar.unidata.idv.IdvObjectStore store) Create a new JythonObjectStore wrapper object.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String key, boolean defaultValue) Returns the boolean value associated with the given key.
char	getCharacter(java.lang.String key, char defaultValue) Returns the char value associated with the given key.
double	getDouble(java.lang.String key, double defaultValue) Returns the double value associated with the given key.
float	getFloat(java.lang.String key, float defaultValue) Returns the float value associated with the given key.
int	getInteger(java.lang.String key, int defaultValue) Returns the int value associated with the given key.
long	getLong(java.lang.String key, long defaultValue) Returns the long value associated with the given key.
<T> T	getObject(java.lang.String key, T defaultValue) Returns the object associated with the given key.
short	getShort(java.lang.String key, short defaultValue) Returns the short value associated with the given key.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Returns the String value associated with the given key.
java.util.List<org.python.core.PyTuple>	items()
java.util.List<org.python.core.PyTuple>	items(java.lang.String substring)
java.util.Set<java.lang.String>	keys()
java.util.Set<java.lang.String>	keys(java.lang.String substring)
java.lang.String	listItems()
java.lang.String	listKeys()
java.lang.String	listMatchingItems(java.lang.String substring)
java.lang.String	listMatchingKeys(java.lang.String substring)
static JythonObjectStore	newInstance(McIDASV mcidasv) Return a new JythonObjectStore instance.
void	putBoolean(java.lang.String key, boolean value) Associates the given key with the given boolean value.
void	putCharacter(java.lang.String key, char value) Associates the given key with the given char value.
void	putDouble(java.lang.String key, double value) Associates the given key with the given double value.
void	putFloat(java.lang.String key, float value) Associates the given key with the given float value.
void	putInteger(java.lang.String key, int value) Associates the given key with the given int value.
void	putLong(java.lang.String key, long value) Associates the given key with the given long value.
<T> void	putObject(java.lang.String key, T value) Associates the given key with the given object.
void	putShort(java.lang.String key, short value) Associates the given key with the given short value.
void	putString(java.lang.String key, java.lang.String value) Associates the given key with the given String value.
void	remove(java.lang.String key) Removes the value associated with the given key (if any).

Methods inherited from class java.lang.Object

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

Field Detail

idvStore

private final ucar.unidata.idv.IdvObjectStore idvStore

IdvObjectStore used by the current McIDAS-V session.

Constructor Detail

JythonObjectStore

private JythonObjectStore(ucar.unidata.idv.IdvObjectStore store)

Create a new JythonObjectStore wrapper object.

Parameters:

store - McIDAS-V object store. Cannot be null.

Throws:

java.lang.NullPointerException - if store is null.

Method Detail

newInstance

public static JythonObjectStore newInstance(McIDASV mcidasv)

Return a new JythonObjectStore instance.

Use this method rather than the constructor.

Parameters:

mcidasv - McIDAS-V instance that represents current session. Cannot be null.

Returns:

New instance of the JythonObjectStore class.

Throws:

java.lang.NullPointerException - if mcidasv is null.

remove

public void remove(java.lang.String key)

Removes the value associated with the given key (if any).

Parameters:

key - Key whose associated value is to be removed. Cannot be null.

Throws:

java.lang.NullPointerException - if key is null.

getObject

public <T> T getObject(java.lang.String key,
                       T defaultValue)

Returns the object associated with the given key. If key does not exist, defaultValue is returned.

Type Parameters:

T - Type of object that will be returned.

Parameters:

key - Key whose associated object is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid. null is allowed.

Returns:

Object associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getShort

public short getShort(java.lang.String key,
                      short defaultValue)

Returns the short value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated short value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

short value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getCharacter

public char getCharacter(java.lang.String key,
                         char defaultValue)

Returns the char value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated char value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

char value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defaultValue)

Returns the String value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated String value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

String value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defaultValue)

Returns the boolean value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated boolean value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

boolean value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getDouble

public double getDouble(java.lang.String key,
                        double defaultValue)

Returns the double value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated double value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

double value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

Returns the float value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated float value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

float value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getInteger

public int getInteger(java.lang.String key,
                      int defaultValue)

Returns the int value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated int value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

int value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

getLong

public long getLong(java.lang.String key,
                    long defaultValue)

Returns the long value associated with the given key. If key does not exist, defaultValue is returned.

Parameters:

key - Key whose associated long value is to be returned. Cannot be null.

defaultValue - Value to be returned if key is not valid.

Returns:

long value associated with key or defaultValue if key is not valid.

Throws:

java.lang.NullPointerException - if key is null.

putObject

public <T> void putObject(java.lang.String key,
                          T value)

Associates the given key with the given object.

Type Parameters:

T - Type of object to store.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - Object to associate with key. Cannot be null.

Throws:

java.lang.NullPointerException - if either key or value is null.

putShort

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

Associates the given key with the given short value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - short value to associate with key.

Throws:

java.lang.NullPointerException - if either key or value is null.

putCharacter

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

Associates the given key with the given char value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - char value to associate with key.

Throws:

java.lang.NullPointerException - if either key or value is null.

putString

public void putString(java.lang.String key,
                      java.lang.String value)

Associates the given key with the given String value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - String value to associate with key. Cannot be null.

Throws:

java.lang.NullPointerException - if either key or value is null.

putBoolean

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

Associates the given key with the given boolean value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - boolean value to associate with key.

Throws:

java.lang.NullPointerException - if either key or value is null.

putDouble

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

Associates the given key with the given double value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - double value to associate with key.

Throws:

java.lang.NullPointerException - if either key or value is null.

putFloat

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

Associates the given key with the given float value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - float value to associate with key.

Throws:

java.lang.NullPointerException - if either key or value is null.

putInteger

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

Associates the given key with the given int value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - int value to associate with key.

Throws:

java.lang.NullPointerException - if either key or value is null.

putLong

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

Associates the given key with the given long value.

Parameters:

key - Key to associate with the given value. Cannot be null.

value - long value to associate with key.

Throws:

java.lang.NullPointerException - if either key or value is null.

keys

public java.util.Set<java.lang.String> keys()

keys

public java.util.Set<java.lang.String> keys(java.lang.String substring)

items

public java.util.List<org.python.core.PyTuple> items()

items

public java.util.List<org.python.core.PyTuple> items(java.lang.String substring)

listKeys

public java.lang.String listKeys()

listMatchingKeys

public java.lang.String listMatchingKeys(java.lang.String substring)

listItems

public java.lang.String listItems()

listMatchingItems

public java.lang.String listMatchingItems(java.lang.String substring)