com.pcbsys.nirvana.client.nEventProperties

Package	com.pcbsys.nirvana.client
Class	public class nEventProperties
Inheritance	nEventProperties Object

This class contains a collection of key-value pairs, defining event meta data which can be used to create filter rules.

Public Methods

	Method		Defined By
		nEventProperties(properties:nEventProperties = null) Default constructor	nEventProperties
		contains(key:String):Boolean Returns true if the key is contained within the dictionary	nEventProperties
		getArray(key:String):Array Get the value as an Array	nEventProperties
		getBoolean(key:String):Boolean Get the value as an Boolean	nEventProperties
		getByte(key:String):int Get the value of a byte as an int	nEventProperties
		getByteArray(key:String):ByteArray Get the value as an ByteArray	nEventProperties
		getChar(key:String):String Get the value of a char as an String	nEventProperties
		getDouble(key:String):Number Get the value as an Number	nEventProperties
		getFloat(key:String):Number Get the value of a Float as an Number	nEventProperties
		getInt(key:String):int Get the value as an int	nEventProperties
		getKeys():Array Get an array of keys as Strings	nEventProperties
		getLong(key:String):Long Get the value as an Long	nEventProperties
		getObject(key:String):Object Get the value as an Object	nEventProperties
		getProperties(key:String):nEventProperties Get the value as an nEventProperties	nEventProperties
		getShort(key:String):int Get the value of a short as an int	nEventProperties
		getString(key:String):String Get the value as an String	nEventProperties
		getValues():Array Get an Array of values as Objects	nEventProperties
		merge(props:nEventProperties, overwrite:Boolean):void Adds the values from the supplied properties to this object.	nEventProperties
		put(key:String, value:Object):void Put an Object into this property	nEventProperties
		remove(key:String):void Removes the value index by the key	nEventProperties

Constructor Detail

nEventProperties

()

Constructor

public function nEventProperties(properties:nEventProperties = null)

Default constructor

Parameters

properties:nEventProperties (default = null)

Method Detail

contains

()

method

public function contains(key:String):Boolean

Returns true if the key is contained within the dictionary

Parameters
key:String — Name of the key to search for

Returns

Boolean — True if the properties contains the key

getArray

()

method

public function getArray(key:String):Array

Get the value as an Array

Parameters
key:String — String key to return

Returns

Array — Array of the value

getBoolean

()

method

public function getBoolean(key:String):Boolean

Get the value as an Boolean

Parameters
key:String — String key to return

Returns

Boolean — Boolean of the value

getByte

()

method

public function getByte(key:String):int

Get the value of a byte as an int

Parameters
key:String — String key to return

Returns

int — int of the byte value

Throws

nIllegalArgumentError —

getByteArray

()

method

public function getByteArray(key:String):ByteArray

Get the value as an ByteArray

Parameters
key:String — String key to return

Returns

ByteArray — ByteArray of the value

getChar

()

method

public function getChar(key:String):String

Get the value of a char as an String

Parameters
key:String — String key to return

Returns

String — String of the value

getDouble

()

method

public function getDouble(key:String):Number

Get the value as an Number

Parameters
key:String — String key to return

Returns

Number — Number of the value

getFloat

()

method

public function getFloat(key:String):Number

Get the value of a Float as an Number

Parameters
key:String — String key to return

Returns

Number — Number of the value

getInt

()

method

public function getInt(key:String):int

Get the value as an int

Parameters
key:String — String key to return

Returns

int — int of the value

Throws

nIllegalArgumentError —

getKeys

()

method

public function getKeys():Array

Get an array of keys as Strings

Returns

Array — Array of String objects representing the keys

getLong

()

method

public function getLong(key:String):Long

Get the value as an Long

Parameters
key:String — String key to return

Returns

Long — Long of the value

getObject

()

method

public function getObject(key:String):Object

Get the value as an Object

Parameters
key:String — String key to return

Returns

Object — Object of the value

getProperties

()

method

public function getProperties(key:String):nEventProperties

Get the value as an nEventProperties

Parameters
key:String — String key to return

Returns

nEventProperties — nEventProperties of the value

getShort

()

method

public function getShort(key:String):int

Get the value of a short as an int

Parameters
key:String — String key to return

Returns

int — int of the value

getString

()

method

public function getString(key:String):String

Get the value as an String

Parameters
key:String — String key to return

Returns

String — String of the value

getValues

()

method

public function getValues():Array

Get an Array of values as Objects

Returns

Array — Array of Objects

merge

()

method

public function merge(props:nEventProperties, overwrite:Boolean):void

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.

Parameters
props:nEventProperties — The nEventProperties object to merge with this copy

overwrite:Boolean — If true then duplicate values will take the new value

put

()

method

public function put(key:String, value:Object):void

Put an Object into this property

Parameters
key:String — name of this value

value:Object — object to insert

remove

()

method

public function remove(key:String):void

Removes the value index by the key

Parameters
key:String — Key to remove

	`props:nEventProperties` — The nEventProperties object to merge with this copy

	`overwrite:Boolean` — If true then duplicate values will take the new value

	`key:String` — name of this value

	`value:Object` — object to insert