Generic class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.Generic.IDictionary<K,V> objects.
More...
Inherits ReferenceFieldType< IDictionary< TKey, TValue >>, and Apama.Event.Parser.FieldType< T >.
Public Member Functions | |
| override IDictionary< TKey, TValue > | DefaultValue () |
| Get the default value for Dictionary field type. More... | |
| DictionaryFieldType (FieldType keyType, FieldType valueType) | |
| Construct a new dictionary type whose keys and values are of the given types. More... | |
| override string | Format (Object value) |
| Format the given value in MonitorScript representation. More... | |
| IDictionary | Parse (string value) |
| Parse a token according to syntax rules of this type. More... | |
| override IDictionary< TKey, TValue > | Parse (string value) |
| Parse a token according to syntax rules of this type. More... | |
| override string | ToString () |
| The string representation of the object More... | |
| override string | ToString () |
| The string representation of the object More... | |
 Public Member Functions inherited from Apama.Event.Parser.FieldType< T > | |
| abstract object | GetDefaultValue () |
| Get the default value for this field type. More... | |
| Field< T > | NewField (string name) |
| Creates a new Field object with the specified name, using this field type. More... | |
| abstract T | Parse (String value) |
| Parse a token according to syntax rules of this type. More... | |
| abstract object | ParseObject (String value) |
| Parse a value from this type's Apama event string representation into the .NET object representation of the value. More... | |
| override string | ToString () |
| For Internal use only More... | |
Properties | |
| FieldType | KeyType [get] |
| Get the type of the keys More... | |
| override string | Name [get] |
| Return the name of this type. More... | |
| override string? | Name [get] |
| Return the name of this type. More... | |
| FieldType | ValueType [get] |
| Get the type of the values More... | |
| Properties inherited from Apama.Event.Parser.FieldType< T > | |
| virtual string | Name [get] |
| Return the name of this type. More... | |
| Type | TypeClass [get] |
| Return the .NET type used to express values of this Apama field type. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Apama.Event.Parser.FieldType< T > | |
| FieldType (string typeName, Type clazz) | |
| Create a new FieldType. More... | |
Detailed Description
Generic class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.Generic.IDictionary<K,V> objects.
Non-generic class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.IDictionary objects.
Use this factory method to create a new sequence field type.
- See also
- DictionaryFieldType<TKey,TValue>
The generic dictionary field type is recommended instead of this class for new applications.
Constructor & Destructor Documentation
◆ DictionaryFieldType()
| Apama.Event.Parser.DictionaryFieldType< TKey, TValue >.DictionaryFieldType | ( | FieldType | keyType, |
| FieldType | valueType | ||
| ) |
Construct a new dictionary type whose keys and values are of the given types.
- Parameters
-
keyType Type of keys this dictionary contains valueType Type of values this dictionary contains
Member Function Documentation
◆ DefaultValue()
|
virtual |
Get the default value for Dictionary field type.
- Returns
- An empty Map
Implements Apama.Event.Parser.FieldType< T >.
◆ Format()
|
virtual |
Format the given value in MonitorScript representation.
- Parameters
-
value The value to format
- Returns
- The formatted value
Reimplemented from Apama.Event.Parser.FieldType< T >.
◆ Parse() [1/2]
| IDictionary Apama.Event.Parser.DictionaryFieldType< TKey, TValue >.Parse | ( | string | value | ) |
Parse a token according to syntax rules of this type.
- Parameters
-
value The value to parse
- Returns
- An object of a type that implements System.Collections.IDictionary
- Exceptions
-
ParserRuntimeException If some problem occurs
◆ Parse() [2/2]
| override IDictionary<TKey, TValue> Apama.Event.Parser.DictionaryFieldType< TKey, TValue >.Parse | ( | string | value | ) |
Parse a token according to syntax rules of this type.
- Parameters
-
value The value to parse
- Returns
- An object of a type that implements System.Collections.Generic.IDictionary<TKey,TValue>.
- Exceptions
-
ParserRuntimeException If some problem occurs
◆ ToString() [1/2]
| override string Apama.Event.Parser.DictionaryFieldType< TKey, TValue >.ToString | ( | ) |
The string representation of the object
◆ ToString() [2/2]
| override string Apama.Event.Parser.DictionaryFieldType< TKey, TValue >.ToString | ( | ) |
The string representation of the object
Property Documentation
◆ KeyType
|
get |
Get the type of the keys
- Returns
- The FieldType of the keys
◆ Name [1/2]
|
get |
Return the name of this type.
- Returns
- The type name
◆ Name [2/2]
|
get |
Return the name of this type.
- Returns
- The type name
◆ ValueType
|
get |
Get the type of the values
- Returns
- The FieldType of the values