com.apama.utils
Event Params


Generic Parameter event.
Since:
CMF 5.1.0

Member Summary
 dictionary<string, string >config

A dictionary of configuration parameter names, and their corresponding value (as a string).
 dictionary<string, context >configCtxs

A dictionary of configuration parameter names, and the corresponding context information.
 
Action Summary
 voidaddBooleanParam(string paramName, boolean paramValue)

This function adds a parameter name and its corresponding value (as a boolean) to the list of configuration parameters.
 voidaddContextParam(string paramName, context paramValue)

This function adds a parameter name and its corresponding context value to the list of configuration parameters.
 voidaddDecimalParam(string paramName, decimal paramValue)

This function adds a parameter name and its corresponding value (as a decimal) to the list of configuration parameters.
 voidaddFloatParam(string paramName, float paramValue)

This function adds a parameter name and its corresponding value (as a float) to the list of configuration parameters.
 voidaddIntegerParam(string paramName, integer paramValue)

This function adds a parameter name and its corresponding value (as an integer) to the list of configuration parameters.
 voidaddParam(string paramName, string paramValue)

This function adds a parameter name and its corresponding value (as a string) to the list of configuration parameters.
 voidaddStringDictionaryParam(string paramName, dictionary<string, string > paramValue)

This function adds a parameter name and its corresponding value (as a dictionary<string,string>) to the list of configuration parameters.
 voidaddStringSequenceParam(string paramName, sequence<string > paramValue)

This function adds a parameter name and its corresponding value (as a sequence<string>) to the list of configuration parameters.
 voidclear()

This function clears any current set parameters from this event.
 booleangetBooleanParam(string paramName)

This function gets the value of a specified parameter name as a boolean type that has been added to this list of parameters.
 booleangetBooleanParamOr(string paramName, boolean alternative)

This function gets the value of a specified parameter name as a boolean type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
 contextgetContextParam(string paramName)

This function gets the value of a specified parameter name as a context type that has been added to this list of configuration parameters.
 contextgetContextParamOr(string paramName, context alternative)

This function gets the value of a specified parameter name as a context type that has been added to this list of configuration parameters.
 decimalgetDecimalParam(string paramName)

This function gets the value of a specified parameter name as a decimal type that has been added to this list of parameters.
 decimalgetDecimalParamOr(string paramName, decimal alternative)

This function gets the value of a specified parameter name as a decimal type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
 floatgetFloatParam(string paramName)

This function gets the value of a specified parameter name as a float type that has been added to this list of parameters.
 floatgetFloatParamOr(string paramName, float alternative)

This function gets the value of a specified parameter name as a float type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
 integergetIntegerParam(string paramName)

This function gets the value of a specified parameter name as a integer type that has been added to this list of parameters.
 integergetIntegerParamOr(string paramName, integer alternative)

This function gets the value of a specified parameter name as a integer type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
 stringgetParam(string paramName)

This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.
 stringgetParamOr(string paramName, string alternative)

This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.
 dictionary<string, string >getStringDictionaryParam(string paramName)

This function gets the value of a specified parameter name as a dictionary<string,string> type that has been added to this list of configuration parameters.
 dictionary<string, string >getStringDictionaryParamOr(string paramName, dictionary<string, string > alternative)

This function gets the value of a specified parameter name as a dictionary<string,string> type that has been added to this list of configuration parameters.
 sequence<string >getStringSequenceParam(string paramName)

This function gets the value of a specified parameter name as a sequence<string> type that has been added to this list of configuration parameters.
 sequence<string >getStringSequenceParamOr(string paramName, sequence<string > alternative)

This function gets the value of a specified parameter name as a sequence<string> type that has been added to this list of configuration parameters.
 booleanhasParam(string paramName)

This function allows the user to check whether the specified parameter name has been added to this list of configuration parameters.
 voidmergeParams(com.apama.utils.Params newParams)

This function merges a list of provided parameters with the existing list of parameters, overriding any that were previously set.
 voidremoveParam(string paramName)

This function removes the specified parameter name from the list of configuration parameters.
 
Member Detail

config

dictionary<string, string > config
A dictionary of configuration parameter names, and their corresponding value (as a string).

configCtxs

dictionary<string, context > configCtxs
A dictionary of configuration parameter names, and the corresponding context information.
Action Detail

addBooleanParam

void addBooleanParam(string paramName, boolean paramValue)
This function adds a parameter name and its corresponding value (as a boolean) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as a boolean) of the parameter to be added to the list

addContextParam

void addContextParam(string paramName, context paramValue)
This function adds a parameter name and its corresponding context value to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a non-context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The context value of the parameter to be added to the list

addDecimalParam

void addDecimalParam(string paramName, decimal paramValue)
This function adds a parameter name and its corresponding value (as a decimal) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as a decimal) of the parameter to be added to the list

addFloatParam

void addFloatParam(string paramName, float paramValue)
This function adds a parameter name and its corresponding value (as a float) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as a float) of the parameter to be added to the list

addIntegerParam

void addIntegerParam(string paramName, integer paramValue)
This function adds a parameter name and its corresponding value (as an integer) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as an integer) of the parameter to be added to the list

addParam

void addParam(string paramName, string paramValue)
This function adds a parameter name and its corresponding value (as a string) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as a string) of the parameter to be added to the list

addStringDictionaryParam

void addStringDictionaryParam(string paramName, dictionary<string, string > paramValue)
This function adds a parameter name and its corresponding value (as a dictionary<string,string>) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as a dictionary<string,string>) of the parameter to be added to the list

addStringSequenceParam

void addStringSequenceParam(string paramName, sequence<string > paramValue)
This function adds a parameter name and its corresponding value (as a sequence<string>) to the list of configuration parameters.

If the parameter name already exists, it will be overwritten with this new value. An error will be logged if the parameter name was already used by a context type.
Parameters:
paramName - The name of the parameter to add to the list of configuration parameters
paramValue - The value (as a sequence<string>) of the parameter to be added to the list

clear

void clear()
This function clears any current set parameters from this event.

getBooleanParam

boolean getBooleanParam(string paramName)
This function gets the value of a specified parameter name as a boolean type that has been added to this list of parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The boolean if it has been added, or false if the parameter has not been added to the list

getBooleanParamOr

boolean getBooleanParamOr(string paramName, boolean alternative)
This function gets the value of a specified parameter name as a boolean type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The boolean if it has been added, otherwise the alternative value provided is returned

getContextParam

context getContextParam(string paramName)
This function gets the value of a specified parameter name as a context type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The context if it has been added, or a default context if the parameter has not been added to the list

getContextParamOr

context getContextParamOr(string paramName, context alternative)
This function gets the value of a specified parameter name as a context type that has been added to this list of configuration parameters.

If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The context if it has been added, otherwise the alternative value provided is returned

getDecimalParam

decimal getDecimalParam(string paramName)
This function gets the value of a specified parameter name as a decimal type that has been added to this list of parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The decimal if it has been added, or a value of 0.0d if the parameter has not been added to the list

getDecimalParamOr

decimal getDecimalParamOr(string paramName, decimal alternative)
This function gets the value of a specified parameter name as a decimal type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The decimal if it has been added, otherwise the alternative value provided is returned

getFloatParam

float getFloatParam(string paramName)
This function gets the value of a specified parameter name as a float type that has been added to this list of parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The float if it has been added, or a value of 0.0 if the parameter has not been added to the list

getFloatParamOr

float getFloatParamOr(string paramName, float alternative)
This function gets the value of a specified parameter name as a float type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The float if it has been added, otherwise the alternative value provided is returned

getIntegerParam

integer getIntegerParam(string paramName)
This function gets the value of a specified parameter name as a integer type that has been added to this list of parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The integer if it has been added, or -1 if the parameter has not been added to the list

getIntegerParamOr

integer getIntegerParamOr(string paramName, integer alternative)
This function gets the value of a specified parameter name as a integer type that has been added to this list of parameters If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The integer if it has been added, otherwise the alternative value provided is returned

getParam

string getParam(string paramName)
This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The value (as a string) if it has been added, or an empty string if the parameter has not been added to the list

getParamOr

string getParamOr(string paramName, string alternative)
This function gets the value of a specified parameter name as a string type that has been added to this list of configuration parameters.

If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The value (as a string) if it has been added, otherwise the alternative value provided is returned

getStringDictionaryParam

dictionary<string, string > getStringDictionaryParam(string paramName)
This function gets the value of a specified parameter name as a dictionary<string,string> type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The dictionary<string,string> if it has been added, or an empty dictionary<string,string> if the parameter has not been added to the list

getStringDictionaryParamOr

dictionary<string, string > getStringDictionaryParamOr(string paramName, dictionary<string, string > alternative)
This function gets the value of a specified parameter name as a dictionary<string,string> type that has been added to this list of configuration parameters.

If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The dictionary<string,string> if it has been added, otherwise the alternative value provided is returned

getStringSequenceParam

sequence<string > getStringSequenceParam(string paramName)
This function gets the value of a specified parameter name as a sequence<string> type that has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to get the value for from the list
Returns:
The sequence<string> if it has been added, or an empty sequence<string> if the parameter has not been added to the list

getStringSequenceParamOr

sequence<string > getStringSequenceParamOr(string paramName, sequence<string > alternative)
This function gets the value of a specified parameter name as a sequence<string> type that has been added to this list of configuration parameters.

If the specified parameter name is not in the dictionary, this action returns the alternative value provided.
Parameters:
paramName - The name of the parameter to get the value for from the list
alternative - The alternative value that should be returned if the parameter does not exist
Returns:
The sequence<string> if it has been added, otherwise the alternative value provided is returned

hasParam

boolean hasParam(string paramName)
This function allows the user to check whether the specified parameter name has been added to this list of configuration parameters.
Parameters:
paramName - The name of the parameter to check has been added to the list
Returns:
true if the configuration parameter exists, false otherwise

mergeParams

void mergeParams(com.apama.utils.Params newParams)
This function merges a list of provided parameters with the existing list of parameters, overriding any that were previously set.
Parameters:
newParams - The new list of parameters to merge with the existing parameter list

removeParam

void removeParam(string paramName)
This function removes the specified parameter name from the list of configuration parameters.
Parameters:
paramName - The name of the parameter to be removed from the list of configuration parameters