Apama API Reference for .NET  9.10.0.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Apama.Event.Parser.DictionaryFieldType Class Reference

Non-generic class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.IDictionary objects. More...

Inherits Apama.Event.Parser.FieldType.

Public Member Functions

 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 string ToString ()
 The string representation of the object More...
 
- Public Member Functions inherited from Apama.Event.Parser.FieldType
abstract object GetDefaultValue ()
 Get the default value for this field 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...
 
FieldType ValueType [get]
 Get the type of the values More...
 
- Properties inherited from Apama.Event.Parser.FieldType
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
 FieldType (string typeName, Type clazz)
 Create a new FieldType. More...
 

Detailed Description

Non-generic class that represents the Apama dictionary<key,item> type, for which values are specified as System.Collections.IDictionary objects.

See also
DictionaryFieldType<TKey,TValue>

The generic dictionary field type is recommended instead of this class for new applications.

Constructor & Destructor Documentation

Apama.Event.Parser.DictionaryFieldType.DictionaryFieldType ( FieldType  keyType,
FieldType  valueType 
)

Construct a new dictionary type whose keys and values are of the given types.

Parameters
keyTypeType of keys this dictionary contains
valueTypeType of values this dictionary contains

Member Function Documentation

override string Apama.Event.Parser.DictionaryFieldType.Format ( Object  value)
virtual

Format the given value in MonitorScript representation.

Parameters
valueThe value to format
Returns
The formatted value

Reimplemented from Apama.Event.Parser.FieldType.

IDictionary Apama.Event.Parser.DictionaryFieldType.Parse ( string  value)

Parse a token according to syntax rules of this type.

Parameters
valueThe value to parse
Returns
An object of a type that implements System.Collections.IDictionary
Exceptions
ParserRuntimeExceptionIf some problem occurs
override string Apama.Event.Parser.DictionaryFieldType.ToString ( )

The string representation of the object

Property Documentation

FieldType Apama.Event.Parser.DictionaryFieldType.KeyType
get

Get the type of the keys

Returns
The FieldType of the keys
FieldType Apama.Event.Parser.DictionaryFieldType.ValueType
get

Get the type of the values

Returns
The FieldType of the values
Submit a bug or feature
Copyright (c) 2013-2016 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors. Use, reproduction, transfer, publication or disclosure is prohibited except as specifically provided for in your License Agreement with Software AG.