com.apama.utils
Event SingleParamsDataView


A helper event to create a 2 column DataView containing a row per Key:Value pair from the supplied Params event.
Since:
CMF 5.2.0
Version:
10.2
See Also:
com.apama.utils.Params - The Params event type this DataView can display.
com.apama.utils.SingleParamsDataViewConsts - The Constants to use for configuration.

Action summary
 voidclear()

Clear all items/rows from the DataView.
 voidcreate(context mainContext, com.apama.utils.Params config, com.apama.utils.Params display)

Create a new DataView containing a row per Key:Value pair from the supplied Params event.
 voiddelete()

Unregister and delete the DataView.
 voidonSpawn()

Must be called after spawning to clear out its instance state and register the context with the ScenarioService.
 voidupdate(com.apama.utils.Params display)

Update the current DataView to contain the entries from the supplied Params events.
 
Action detail

clear

void clear()
Clear all items/rows from the DataView.

create() must have been called to initialise the DataView before calling clear().

create

void create(context mainContext, com.apama.utils.Params config, com.apama.utils.Params display)
Create a new DataView containing a row per Key:Value pair from the supplied Params event.

Creates a new DataView named after the given NAME configuration populated with an item/row per Key:Value pair in the supplied Params display event. This will set each Value type to 'string', and will not display any contexts params set in the Params event. create() can only be called once per SingleParamsDataView until delete() is called. onSpawn() must be called after spawning to register the new context with the Scenario Service.
Parameters:
mainContext - The main context
config - The configuration for this DataView
display - The Params event to display
See Also:
com.apama.utils.Params - The Params event type this DataView can display.

delete

void delete()
Unregister and delete the DataView.

create() must have been called to initialise the DataView before calling delete().

onSpawn

void onSpawn()
Must be called after spawning to clear out its instance state and register the context with the ScenarioService.

create() must have been called to initialise the DataView before calling onSpawn().

update

void update(com.apama.utils.Params display)
Update the current DataView to contain the entries from the supplied Params events.

If OVERWRITE config is 'true' (default) the current entries will be cleared before adding the new values. If 'false', entries will be updated and new keys added, but missing keys will not be cleared from the DataView. create() must have been called to initialise the DataView before calling update().
Parameters:
display - The Params event to display
See Also:
com.apama.utils.Params - The Params event type this DataView can display.