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 | |
bool | 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 If the input paramter is not of type String, returns null More... | |
bool | getBoolean (string key) |
Retrieves the data from the table based on the key as a bool More... | |
bool[] | getBooleanArray (string key) |
Retrieves a bool[] 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) |
Retrieves 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 | 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... | |
IEnumerator< string > | getKeys () |
Get an IEnumerator of keys More... | |
IEnumerator< string > | getKeysAsStrings () |
Get an IEnumerator of keys as Strings More... | |
long | getLong (string key) |
Retrieves 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) |
Retrieves the data from the table based on the key as a string More... | |
string[] | getStringArray (string key) |
Retrieves a String[] More... | |
IEnumerator< object > | getValues () |
Get an IEnumerator of values More... | |
bool | isValid () |
Returns true if the dictionary is consistent and contains no errors More... | |
void | merge (nEventProperties props, bool overwrite) |
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, bool 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) | |
Constructor using a string from the .toString() method 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 dictionary More... | |
void | put (string key, string[] value) |
Places a String[] into the properties More... | |
void | put (string key, short s) |
places a short into the properties More... | |
void | put (string key, short[] s) |
Places an array of 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, bool value) |
Places a key value pair into the dictionary More... | |
void | put (string key, bool[] value) |
Places a bool[] into the properties More... | |
void | put (string key, int value) |
Places a key value pair into the dictionary 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 dictionary 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 dictionary 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... | |
string | ToString () |
Converts this object into a string 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, |
bool | 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 | ) |
Constructor using a string from the .toString() method
serializedString | serialized string used to construct the nEventProperties |
bool com.pcbsys.nirvana.client.nEventProperties.containsKey | ( | string | key | ) |
Returns true if the key is contained within the dictionary
key | Name of the key to search 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 If the input paramter is not of type String, returns null
key | String key to return |
bool com.pcbsys.nirvana.client.nEventProperties.getBoolean | ( | string | key | ) |
Retrieves the data from the table based on the key as a bool
key | Key to reference the data |
bool [] com.pcbsys.nirvana.client.nEventProperties.getBooleanArray | ( | string | key | ) |
Retrieves a bool[] from the properties
key | Name of the bool[] |
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 | ) |
Retrieves 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 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[] |
IEnumerator<string> com.pcbsys.nirvana.client.nEventProperties.getKeys | ( | ) |
Get an IEnumerator of keys
IEnumerator<string> com.pcbsys.nirvana.client.nEventProperties.getKeysAsStrings | ( | ) |
Get an IEnumerator of keys as Strings
long com.pcbsys.nirvana.client.nEventProperties.getLong | ( | string | key | ) |
Retrieves 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 | ) |
Retrieves 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[] |
IEnumerator<object> com.pcbsys.nirvana.client.nEventProperties.getValues | ( | ) |
Get an IEnumerator of values
bool com.pcbsys.nirvana.client.nEventProperties.isValid | ( | ) |
Returns true if the dictionary is consistent and contains no errors
void com.pcbsys.nirvana.client.nEventProperties.merge | ( | nEventProperties | props, |
bool | 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 bool 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.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 dictionary
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 | s | ||
) |
places a short into the properties
key | name of the short |
s | short value |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | string | key, |
short[] | s | ||
) |
Places an array of 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, |
bool | value | ||
) |
Places a key value pair into the dictionary
key | Key to reference the data |
value | Data to be stored |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | string | key, |
bool[] | value | ||
) |
Places a bool[] into the properties
key | Name of the boolean[] |
value | bool[] |
void com.pcbsys.nirvana.client.nEventProperties.put | ( | string | key, |
int | value | ||
) |
Places a key value pair into the dictionary
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 dictionary
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 dictionary
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 |
string com.pcbsys.nirvana.client.nEventProperties.ToString | ( | ) |
Converts this object into a string