- com
- pcbsys
- nirvana
- client
- nEventProperties
This class contains a collection of key-value pairs, defining event meta data which can be used to create filter rules. More...
Public Member Functions | |
boolean | containsKey (String key) |
Returns true if the key is contained within the dictionary. More... | |
void | copy (nEventProperties p_dictionary) |
Copies the properties from one to this. More... | |
Object | get (String key) |
Get the value as an Object. More... | |
Object | get (Object key) |
Get the value as an Object. More... | |
boolean | getBoolean (String key) |
Retreives the data from the table based on the key as a boolean. More... | |
boolean[] | getBooleanArray (String key) |
Retrieves a boolean[] from the properties. More... | |
byte | getByte (String key) |
Retrieves a byte by the name given. More... | |
byte[] | getByteArray (String key) |
Retrieves a byte[] from the dictionary. More... | |
char | getChar (String key) |
Retrieves a char from the properties. More... | |
char[] | getCharArray (String key) |
Retrieves a char[] from the properties. More... | |
String | getClass (String key) |
Get the class name of the value represented by the key. More... | |
nEventProperties | getDictionary (String key) |
Retrieve a nEventProperty from this one. More... | |
nEventProperties[] | getDictionaryArray (String key) |
Return an array of nEventProperties. More... | |
double | getDouble (String key) |
Retreives the data from the table based on the key as a double. More... | |
double[] | getDoubleArray (String key) |
Retrieves a double[] from the properties. More... | |
nEventPropertiesIterator < Map.Entry< fStringEntry, Object > > | getEntrySet () |
Get an iterator of the key and values in an Map.Entry. More... | |
float | getFloat (String key) |
Retrieves a float from the properties. More... | |
float[] | getFloatArray (String key) |
Retrieves a float[] from the properties. More... | |
int | getInt (String key) |
Retrieves an int from the properties. More... | |
int[] | getIntArray (String key) |
Gets an int[] from the properties. More... | |
nEventPropertiesIterator< String > | getKeyIterator () |
Get an iterator of the keys. More... | |
Enumeration | getKeys () |
Get an enumeration of keys. More... | |
Enumeration | getKeysAsStrings () |
Get an enumeration of keys as Strings. More... | |
long | getLong (String key) |
Retreives the data from the table based on the key as a long. More... | |
long[] | getLongArray (String key) |
Retrieves a long[] from the properties. More... | |
short | getShort (String key) |
Retrieves a short from the properties. More... | |
short[] | getShortArray (String key) |
Retrieves an array of shorts. More... | |
int | getSize () |
Return the number of properties held. More... | |
String | getString (String key) |
Retreives the data from the table based on the key as a string. More... | |
String[] | getStringArray (String key) |
Retrieves a String[]. More... | |
nEventPropertiesIterator< Object > | getValueIterator () |
Get an iterator of the values. More... | |
Enumeration | getValues () |
Get an enumeration of values. More... | |
boolean | isValid () |
Returns true if the dictionary is consistant and contains no errors. More... | |
void | merge (nEventProperties props, boolean overwrite) |
Adds the values from the supplied properties to this object. More... | |
void | merge (nEventProperties props, boolean overwrite, boolean removeDuplicates) |
Adds the values from the supplied properties to this object. More... | |
nEventProperties () | |
Default constructor. | |
nEventProperties (nEventProperties ed) | |
Constructs an event properties object that is a copy of the specified event properties. More... | |
nEventProperties (nEventProperties ed, boolean copyNew) | |
Constructs an event properties object that is a copy of the specified event properties, but depending on the copyNew, will construct new dictionary entries to prevent dictionary entries being overwritten by subsequent uses of the event object and event properties. More... | |
nEventProperties (String serializedString) | |
Unsupported function. More... | |
nEventProperties (fEventDictionary ed) | |
Constructs an event properties object that contains a copy of the input dictionary. More... | |
void | put (String key, nEventProperties value) |
Put an nEventproperties into this one to enable nested properties. More... | |
void | put (String key, nEventProperties[] value) |
Put an nEventProperies[] into this property to enable nested properties. More... | |
void | put (String key, String value) |
Places a key value pair into the hashtable. More... | |
void | put (String key, String[] value) |
Places a String[] into the properties. More... | |
void | put (String key, short value) |
places a short into the properties More... | |
void | put (String key, short[] s) |
Places an array og shorts into the properties. More... | |
void | put (String key, byte b) |
Places a byte into the properties. More... | |
void | put (String key, byte[] b) |
Places a byte[] into the properties. More... | |
void | put (String key, char c) |
Puts a char into the properties. More... | |
void | put (String key, char[] c) |
Puts an array of chars into the properties. More... | |
void | put (String key, boolean value) |
Places a key value pair into the hashtable. More... | |
void | put (String key, boolean[] value) |
Places a boolean[] into the properties. More... | |
void | put (String key, int value) |
Places a key value pair into the hashtable. More... | |
void | put (String key, int[] value) |
Places a int[] into the properties. More... | |
void | put (String key, long value) |
Places a key value pair into the hashtable. More... | |
void | put (String key, long[] value) |
Places a long[] into the properties. More... | |
void | put (String key, float value) |
Places a key value pair into the properties. More... | |
void | put (String key, float[] value) |
Puts a float[] into the properties. More... | |
void | put (String key, double value) |
Places a key value pair into the hashtable. More... | |
void | put (String key, double[] value) |
Places a double[] into the properties. More... | |
void | remove (String key) |
Removes the value index by the key. More... | |
This class contains a collection of key-value pairs, defining event meta data which can be used to create filter rules.
com.pcbsys.nirvana.client.nEventProperties.nEventProperties | ( | nEventProperties | ed | ) |
Constructs an event properties object that is a copy of the specified event properties.
ed | the event properties object to be copied |
com.pcbsys.nirvana.client.nEventProperties.nEventProperties | ( | nEventProperties | ed, |
boolean | copyNew | ||
) |
Constructs an event properties object that is a copy of the specified event properties, but depending on the copyNew, will construct new dictionary entries to prevent dictionary entries being overwritten by subsequent uses of the event object and event properties.
ed | the event properties object to be copied |
copyNew | re-construct the entries rather than copying the references to the new event properties |
com.pcbsys.nirvana.client.nEventProperties.nEventProperties | ( | String | serializedString | ) |
com.pcbsys.nirvana.client.nEventProperties.nEventProperties | ( | fEventDictionary | ed | ) |
Constructs an event properties object that contains a copy of the input dictionary.
ed | the event dictionary object to be copied |
boolean com.pcbsys.nirvana.client.nEventProperties.containsKey | ( | String | key | ) |
Returns true if the key is contained within the dictionary.
key | Name of the key to seatch for |
void com.pcbsys.nirvana.client.nEventProperties.copy | ( | nEventProperties | p_dictionary | ) |
Copies the properties from one to this.
p_dictionary | dictionary to copy |
Object com.pcbsys.nirvana.client.nEventProperties.get | ( | String | key | ) |
Get the value as an Object.
key | String key to return |
Object com.pcbsys.nirvana.client.nEventProperties.get | ( | Object | key | ) |
Get the value as an Object.
key | object key to return |
boolean com.pcbsys.nirvana.client.nEventProperties.getBoolean | ( | String | key | ) |
Retreives the data from the table based on the key as a boolean.
key | Key to reference the data |
boolean [] com.pcbsys.nirvana.client.nEventProperties.getBooleanArray | ( | String | key | ) |
Retrieves a boolean[] from the properties.
key | Name of the boolean[] |
byte com.pcbsys.nirvana.client.nEventProperties.getByte | ( | String | key | ) |
Retrieves a byte by the name given.
key | Name for the byte |
byte [] com.pcbsys.nirvana.client.nEventProperties.getByteArray | ( | String | key | ) |
Retrieves a byte[] from the dictionary.
key | name for the byte[] |
char com.pcbsys.nirvana.client.nEventProperties.getChar | ( | String | key | ) |
Retrieves a char from the properties.
key | name of the char |
char [] com.pcbsys.nirvana.client.nEventProperties.getCharArray | ( | String | key | ) |
Retrieves a char[] from the properties.
key | name of the char array |
String com.pcbsys.nirvana.client.nEventProperties.getClass | ( | String | key | ) |
Get the class name of the value represented by the key.
key | String value to lookup |
nEventProperties com.pcbsys.nirvana.client.nEventProperties.getDictionary | ( | String | key | ) |
Retrieve a nEventProperty from this one.
key | Name of the nEventProperty |
nEventProperties [] com.pcbsys.nirvana.client.nEventProperties.getDictionaryArray | ( | String | key | ) |
Return an array of nEventProperties.
key | name of the array to return |
double com.pcbsys.nirvana.client.nEventProperties.getDouble | ( | String | key | ) |
Retreives the data from the table based on the key as a double.
key | Key to reference the data |
double [] com.pcbsys.nirvana.client.nEventProperties.getDoubleArray | ( | String | key | ) |
Retrieves a double[] from the properties.
key | Name of the double[] |
nEventPropertiesIterator<Map.Entry<fStringEntry, Object> > com.pcbsys.nirvana.client.nEventProperties.getEntrySet | ( | ) |
Get an iterator of the key and values in an Map.Entry.
Allows the user to get both the key and value from one iteration of the nEventProperties.
float com.pcbsys.nirvana.client.nEventProperties.getFloat | ( | String | key | ) |
Retrieves a float from the properties.
key | Name of the float |
float [] com.pcbsys.nirvana.client.nEventProperties.getFloatArray | ( | String | key | ) |
Retrieves a float[] from the properties.
key | Name of the float[] |
int com.pcbsys.nirvana.client.nEventProperties.getInt | ( | String | key | ) |
Retrieves an int from the properties.
key | Name of the int |
int [] com.pcbsys.nirvana.client.nEventProperties.getIntArray | ( | String | key | ) |
Gets an int[] from the properties.
key | Name of the int[] |
nEventPropertiesIterator<String> com.pcbsys.nirvana.client.nEventProperties.getKeyIterator | ( | ) |
Get an iterator of the keys.
Enumeration com.pcbsys.nirvana.client.nEventProperties.getKeys | ( | ) |
Get an enumeration of keys.
Enumeration com.pcbsys.nirvana.client.nEventProperties.getKeysAsStrings | ( | ) |
Get an enumeration of keys as Strings.
long com.pcbsys.nirvana.client.nEventProperties.getLong | ( | String | key | ) |
Retreives the data from the table based on the key as a long.
key | Key to reference the data |
long [] com.pcbsys.nirvana.client.nEventProperties.getLongArray | ( | String | key | ) |
Retrieves a long[] from the properties.
key | Name of the long[] |
short com.pcbsys.nirvana.client.nEventProperties.getShort | ( | String | key | ) |
Retrieves a short from the properties.
key | name of the short |
short [] com.pcbsys.nirvana.client.nEventProperties.getShortArray | ( | String | key | ) |
Retrieves an array of shorts.
key | name of the short array |
int com.pcbsys.nirvana.client.nEventProperties.getSize | ( | ) |
Return the number of properties held.
String com.pcbsys.nirvana.client.nEventProperties.getString | ( | String | key | ) |
Retreives the data from the table based on the key as a string.
key | Key to reference the data |
String [] com.pcbsys.nirvana.client.nEventProperties.getStringArray | ( | String | key | ) |
Retrieves a String[].
key | Name of the String[] |
nEventPropertiesIterator<Object> com.pcbsys.nirvana.client.nEventProperties.getValueIterator | ( | ) |
Get an iterator of the values.
Enumeration com.pcbsys.nirvana.client.nEventProperties.getValues | ( | ) |
Get an enumeration of values.
boolean com.pcbsys.nirvana.client.nEventProperties.isValid | ( | ) |
Returns true if the dictionary is consistant and contains no errors.
void com.pcbsys.nirvana.client.nEventProperties.merge | ( | nEventProperties | props, |
boolean | overwrite | ||
) |
Adds the values from the supplied properties to this object.
If this object already has keys with the same name then the behaviour is driven by the boolean overwrite.
props | The nEventProperties object to merge with this copy |
overwrite | If true then duplicate values will take the new value |
void com.pcbsys.nirvana.client.nEventProperties.merge | ( | nEventProperties | props, |
boolean | overwrite, | ||
boolean | removeDuplicates | ||
) |
Adds the values from the supplied properties to this object.
If this object already has keys with the same name then the behaviour is driven by the boolean overwrite.
props | The nEventProperties object to merge with this copy |
overwrite | If true then duplicate values will take the new value |
removeDuplicates | If true then duplicate with the same value are removed |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
nEventProperties | value | ||
) |
Put an nEventproperties into this one to enable nested properties.
key | name of this value |
value | nEventProperty to insert |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
nEventProperties[] | value | ||
) |
Put an nEventProperies[] into this property to enable nested properties.
key | Name to call this |
value | Array of nEventProperties |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
String | value | ||
) |
Places a key value pair into the hashtable.
key | Key to reference the data |
value | Data to be stored |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
String[] | value | ||
) |
Places a String[] into the properties.
key | Name for the value |
value | String[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
short | value | ||
) |
places a short into the properties
key | name of the short |
value | short value |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
short[] | s | ||
) |
Places an array og shorts into the properties.
key | Name for the array |
s | short[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
byte | b | ||
) |
Places a byte into the properties.
key | name for the byte |
b | byte |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
byte[] | b | ||
) |
Places a byte[] into the properties.
key | name for the byte[] |
b | byte[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
char | c | ||
) |
Puts a char into the properties.
key | Name of the char |
c | char value |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
char[] | c | ||
) |
Puts an array of chars into the properties.
key | Name of the char[] |
c | char[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
boolean | value | ||
) |
Places a key value pair into the hashtable.
key | Key to reference the data |
value | Data to be stored |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
boolean[] | value | ||
) |
Places a boolean[] into the properties.
key | Name of the bboolean[] |
value | boolean[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
int | value | ||
) |
Places a key value pair into the hashtable.
key | Key to reference the data |
value | Data to be stored |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
int[] | value | ||
) |
Places a int[] into the properties.
key | Name of the key |
value | int[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
long | value | ||
) |
Places a key value pair into the hashtable.
key | Key to reference the data |
value | Data to be stored |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
long[] | value | ||
) |
Places a long[] into the properties.
key | name of the long[] |
value | long[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
float | value | ||
) |
Places a key value pair into the properties.
key | Key to reference the data |
value | Data to be stored |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
float[] | value | ||
) |
Puts a float[] into the properties.
key | Name of the float[] |
value | float[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
double | value | ||
) |
Places a key value pair into the hashtable.
key | Key to reference the data |
value | Data to be stored |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | String | key, |
double[] | value | ||
) |
Places a double[] into the properties.
key | Name of the double[] |
value | double[] |
void com.pcbsys.nirvana.client.nEventProperties.remove | ( | String | key | ) |
Removes the value index by the key.
key | Key to remove |