j2meClient.nEventProperties Class Reference

This class manages a hashtable of metadata for a nirvana event. More...


Public Member Functions

boolean containsKey (String key)
 Returns true if the specified key exists, false otherwise.
void copy (nEventProperties p_dictionary)
 Copies all key-value pairs to the specified dictionary.
void fromByteArray (nObject session, byte[] bytes) throws Exception
 Reads all data for this instance from a byte[] representation.
Object get (String key)
 Returns the value of associated with the specified key.
boolean getBoolean (byte[] key)
 Retrieves the data from the table based on the key as a boolean.
boolean getBoolean (String key)
 Retrieves the data from the table based on the key as a boolean.
boolean[] getBooleanArray (String key)
 Retrieves the data from the table based on the key as a boolean array.
byte getByte (String key)
 Retrieves the data from the table based on the key as a byte.
byte[] getByteArray (String key)
 Retrieves the data from the table based on the key as a byte array.
char getChar (String key)
 Retrieves the data from the table based on the key as a char.
char[] getCharArray (String key)
 Retrieves the data from the table based on the key as a char array.
String getClass (String key)
 Returns the name of the class name associated with the value for the specified key.
nEventProperties getDictionary (String key)
 Retrieves the data from the table based on the key as an nEventProperties.
nEventProperties[] getDictionaryArray (String key)
 Retrieves the data from the table based on the key as an nEventProperties array.
J2MEDouble getDouble (String key)
 Retrieves the data from the table based on the key as a double.
J2MEFloat getFloat (String key)
 Retrieves the data from the table based on the key as an float.
int getInt (byte[] key)
 Retrieves the data from the table based on the key as an int.
int getInt (String key)
 Retrieves the data from the table based on the key as an int.
int[] getIntArray (String key)
 Retrieves the data from the table based on the key as an int array.
Enumeration getKeys ()
 Returns an Enumeration of all the keys as fStringEntry objects.
Enumeration getKeysAsStrings ()
 Returns an Enumeration of all the keys as String objects.
long getLong (byte[] key)
 Retrieves the data from the table based on the key as a long.
long getLong (String key)
 Retrieves the data from the table based on the key as a long.
long[] getLongArray (String key)
 Retrieves the data from the table based on the key as a long array.
short getShort (String key)
 Retrieves the data from the table based on the key as a short.
short[] getShortArray (String key)
 Retrieves the data from the table based on the key as a short array.
int getSize ()
 Returns the number of key-value pairs this dictionary contains.
String getString (byte[] key)
 Retrieves the data from the table based on the key as a string.
String getString (String key)
 Retrieves the data from the table based on the key as a string.
String[] getStringArray (String key)
 Retrieves the data from the table based on the key as a string array.
boolean isValid ()
 Returns true if the dictionary is valid, false otherwise.
 nEventProperties (nEventProperties ed)
 Constructs an event properties object that is a copy of the specified event properties.
 nEventProperties ()
 Default constructor for the dictionary.
void put (String key, long[] value)
 Puts the specified long array value to the dictionary.
void put (byte[] key, long value)
 Puts the specified long value to the dictionary.
void put (String key, long value)
 Places a key value pair into the hashtable.
void put (String key, J2MEDouble value)
 Puts the specified double value to the dictionary.
void put (String key, J2MEFloat value)
 Puts the specified float value to the dictionary.
void put (String key, int[] value)
 Puts the specified int array value to the dictionary.
void put (byte[] key, int value)
 Puts the specified int value into the dictionary.
void put (String key, int value)
 Places a key value pair into the hashtable.
void put (String key, boolean[] value)
 Puts the specified boolean array value to the dictionary.
void put (byte[] key, boolean value)
 Puts the specified boolean value to the dictionary.
void put (String key, boolean value)
 Places a key value pair into the hashtable.
void put (String key, char[] c)
 Puts the specified char array value to the dictionary.
void put (String key, char c)
 Puts the specified char value to the dictionary.
void put (String key, byte[] b)
 Puts the specified byte array value to the dictionary.
void put (String key, byte b)
 Puts the specified byte value to the dictionary.
void put (String key, short[] s)
 Puts the specified short array value to the dictionary.
void put (String key, short s)
 Puts the specified short value to the dictionary.
void put (String key, String[] value)
 Puts the specified string array value to the dictionary.
void put (byte[] key, String value)
 Puts the specified string value into the dictionary.
void put (String key, String value)
 Places a key value pair into the hashtable.
void put (String key, nEventProperties[] value)
 Puts the specified dictionary array value to the dictionary.
void put (String key, nEventProperties value)
 Puts the specified dictionary value to the dictionary.
void readExternal (fEventInputStream ois) throws IOException, ClassNotFoundException
 Reads this dictionary object from an event stream (Internal Use).
void remove (String key)
 Removes the key-value pair denoted by the specified key.
byte[] toByteArray () throws IOException
 Converts the object to a byte[] for persistent storage or other use.
String toString ()
 Used to serialize this dictionary into a string format.
void writeExternal (fEventOutputStream oos) throws IOException
 Writes this dictionary object to an event stream (Internal Use).

Detailed Description

This class manages a hashtable of metadata for a nirvana event.

This data can be streamed to a String and constructed from a string

Constructor & Destructor Documentation

j2meClient.nEventProperties.nEventProperties ( nEventProperties  ed  ) 

Constructs an event properties object that is a copy of the specified event properties.

Parameters:
ed the event properties object to be copied

Member Function Documentation

boolean j2meClient.nEventProperties.containsKey ( String  key  ) 

Returns true if the specified key exists, false otherwise.

Parameters:
key a dictionary key
Returns:
true if it contains the key else false

void j2meClient.nEventProperties.copy ( nEventProperties  p_dictionary  ) 

Copies all key-value pairs to the specified dictionary.

Parameters:
p_dictionary copy the contents of p_dictionary to this

void j2meClient.nEventProperties.fromByteArray ( nObject  session,
byte[]  bytes 
) throws Exception

Reads all data for this instance from a byte[] representation.

Parameters:
session the nirvana session (used to extract max buffer size)
bytes a byte[] representation of this object
Exceptions:
IOException is thrown if an IO error occurs.

Object j2meClient.nEventProperties.get ( String  key  ) 

Returns the value of associated with the specified key.

Parameters:
key dictionary key
Returns:
the object associated with the specified key

boolean j2meClient.nEventProperties.getBoolean ( byte[]  key  ) 

Retrieves the data from the table based on the key as a boolean.

Parameters:
key Key to reference the data
Returns:
a boolean associated with this key

boolean j2meClient.nEventProperties.getBoolean ( String  key  ) 

Retrieves the data from the table based on the key as a boolean.

Parameters:
key Key to reference the data
Returns:
a boolean with the value associated with this key

boolean [] j2meClient.nEventProperties.getBooleanArray ( String  key  ) 

Retrieves the data from the table based on the key as a boolean array.

Parameters:
key Key to reference the data
Returns:
a boolean array associated with this key

byte j2meClient.nEventProperties.getByte ( String  key  ) 

Retrieves the data from the table based on the key as a byte.

Parameters:
key Key to reference the data
Returns:
a byte associated with this key

byte [] j2meClient.nEventProperties.getByteArray ( String  key  ) 

Retrieves the data from the table based on the key as a byte array.

Parameters:
key Key to reference the data
Returns:
a byte array associated with this key

char j2meClient.nEventProperties.getChar ( String  key  ) 

Retrieves the data from the table based on the key as a char.

Parameters:
key Key to reference the data
Returns:
a char associated with this key

char [] j2meClient.nEventProperties.getCharArray ( String  key  ) 

Retrieves the data from the table based on the key as a char array.

Parameters:
key Key to reference the data
Returns:
a char array associated with this key

String j2meClient.nEventProperties.getClass ( String  key  ) 

Returns the name of the class name associated with the value for the specified key.

Parameters:
key dictionary key
Returns:
the string name of the class for the value of the specified key

nEventProperties j2meClient.nEventProperties.getDictionary ( String  key  ) 

Retrieves the data from the table based on the key as an nEventProperties.

Parameters:
key Key to reference the data
Returns:
an nEventProperties associated with this key

nEventProperties [] j2meClient.nEventProperties.getDictionaryArray ( String  key  ) 

Retrieves the data from the table based on the key as an nEventProperties array.

Parameters:
key Key to reference the data
Returns:
an nEventProperties array associated with this key

J2MEDouble j2meClient.nEventProperties.getDouble ( String  key  ) 

Retrieves the data from the table based on the key as a double.

Parameters:
key Key to reference the data
Returns:
an int associated with this key

J2MEFloat j2meClient.nEventProperties.getFloat ( String  key  ) 

Retrieves the data from the table based on the key as an float.

Parameters:
key Key to reference the data
Returns:
an int associated with this key

int j2meClient.nEventProperties.getInt ( byte[]  key  ) 

Retrieves the data from the table based on the key as an int.

Parameters:
key Key to reference the data
Returns:
an int associated with this key

int j2meClient.nEventProperties.getInt ( String  key  ) 

Retrieves the data from the table based on the key as an int.

Parameters:
key Key to reference the data
Returns:
an int associated with this key

int [] j2meClient.nEventProperties.getIntArray ( String  key  ) 

Retrieves the data from the table based on the key as an int array.

Parameters:
key Key to reference the data
Returns:
an int array associated with this key

Enumeration j2meClient.nEventProperties.getKeys (  ) 

Returns an Enumeration of all the keys as fStringEntry objects.

Returns:
Enumeration of the dictionary keys

Enumeration j2meClient.nEventProperties.getKeysAsStrings (  ) 

Returns an Enumeration of all the keys as String objects.

Returns:
enumeration of the dictionary keys as strings

long j2meClient.nEventProperties.getLong ( byte[]  key  ) 

Retrieves the data from the table based on the key as a long.

Parameters:
key Key to reference the data
Returns:
a long associated with this key

long j2meClient.nEventProperties.getLong ( String  key  ) 

Retrieves the data from the table based on the key as a long.

Parameters:
key Key to reference the data
Returns:
a long with the value associated with this key

long [] j2meClient.nEventProperties.getLongArray ( String  key  ) 

Retrieves the data from the table based on the key as a long array.

Parameters:
key Key to reference the data
Returns:
a long array associated with this key

short j2meClient.nEventProperties.getShort ( String  key  ) 

Retrieves the data from the table based on the key as a short.

Parameters:
key Key to reference the data
Returns:
a short associated with this key

short [] j2meClient.nEventProperties.getShortArray ( String  key  ) 

Retrieves the data from the table based on the key as a short array.

Parameters:
key Key to reference the data
Returns:
a short array associated with this key

int j2meClient.nEventProperties.getSize (  ) 

Returns the number of key-value pairs this dictionary contains.

Returns:
the number of entries in the dictionary

String j2meClient.nEventProperties.getString ( byte[]  key  ) 

Retrieves the data from the table based on the key as a string.

Parameters:
key Key to reference the data
Returns:
a string associated with this key

String j2meClient.nEventProperties.getString ( String  key  ) 

Retrieves the data from the table based on the key as a string.

Parameters:
key Key to reference the data
Returns:
a string with the value associated with this key

String [] j2meClient.nEventProperties.getStringArray ( String  key  ) 

Retrieves the data from the table based on the key as a string array.

Parameters:
key Key to reference the data
Returns:
a string array associated with this key

boolean j2meClient.nEventProperties.isValid (  ) 

Returns true if the dictionary is valid, false otherwise.

Returns:
true if the dictionary is valid else false

void j2meClient.nEventProperties.put ( String  key,
long[]  value 
)

Puts the specified long array value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( byte[]  key,
long  value 
)

Puts the specified long value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( String  key,
long  value 
)

Places a key value pair into the hashtable.

Parameters:
key Key to reference the data
value Data to be stored

void j2meClient.nEventProperties.put ( String  key,
J2MEDouble  value 
)

Puts the specified double value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( String  key,
J2MEFloat  value 
)

Puts the specified float value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( String  key,
int[]  value 
)

Puts the specified int array value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( byte[]  key,
int  value 
)

Puts the specified int value into the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( String  key,
int  value 
)

Places a key value pair into the hashtable.

Parameters:
key Key to reference the data
value Data to be stored

void j2meClient.nEventProperties.put ( String  key,
boolean[]  value 
)

Puts the specified boolean array value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( byte[]  key,
boolean  value 
)

Puts the specified boolean value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( String  key,
boolean  value 
)

Places a key value pair into the hashtable.

Parameters:
key Key to reference the data
value Data to be stored

void j2meClient.nEventProperties.put ( String  key,
char[]  c 
)

Puts the specified char array value to the dictionary.

Parameters:
key dictionary key
c the char array for the specified key

void j2meClient.nEventProperties.put ( String  key,
char  c 
)

Puts the specified char value to the dictionary.

Parameters:
key dictionary key
c the char value for the specified key

void j2meClient.nEventProperties.put ( String  key,
byte[]  b 
)

Puts the specified byte array value to the dictionary.

Parameters:
key dictionary key
b the byte srray for the specified key

void j2meClient.nEventProperties.put ( String  key,
byte  b 
)

Puts the specified byte value to the dictionary.

Parameters:
key dictionary key
b the byte value for the specified key

void j2meClient.nEventProperties.put ( String  key,
short[]  s 
)

Puts the specified short array value to the dictionary.

Parameters:
key dictionary key
s the short array for the specified key

void j2meClient.nEventProperties.put ( String  key,
short  s 
)

Puts the specified short value to the dictionary.

Parameters:
key dictionary key
s the short value for the specified key

void j2meClient.nEventProperties.put ( String  key,
String[]  value 
)

Puts the specified string array value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( byte[]  key,
String  value 
)

Puts the specified string value into the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( String  key,
String  value 
)

Places a key value pair into the hashtable.

Parameters:
key Key to reference the data
value Data to be stored

void j2meClient.nEventProperties.put ( String  key,
nEventProperties[]  value 
)

Puts the specified dictionary array value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.put ( String  key,
nEventProperties  value 
)

Puts the specified dictionary value to the dictionary.

Parameters:
key dictionary key
value dictionary value

void j2meClient.nEventProperties.readExternal ( fEventInputStream  ois  )  throws IOException, ClassNotFoundException

Reads this dictionary object from an event stream (Internal Use).

Parameters:
ois <*Enter Parameter Description*>
Exceptions:
IOException <*Enter Exception Description*>
ClassNotFoundException <*Enter Exception Description*>

void j2meClient.nEventProperties.remove ( String  key  ) 

Removes the key-value pair denoted by the specified key.

Parameters:
key a dictionary key

byte [] j2meClient.nEventProperties.toByteArray (  )  throws IOException

Converts the object to a byte[] for persistent storage or other use.

Returns:
a byte[] representation of this object
Exceptions:
IOException is thrown if an IO error occurs.

String j2meClient.nEventProperties.toString (  ) 

Used to serialize this dictionary into a string format.

Use this string as a tag in a dbus publish call

Returns:
Serialized dictionay in string format

void j2meClient.nEventProperties.writeExternal ( fEventOutputStream  oos  )  throws IOException

Writes this dictionary object to an event stream (Internal Use).

Parameters:
oos <*Enter Parameter Description*>
Exceptions:
IOException <*Enter Exception Description*>