Apama.Event.Parser.FieldType Class Reference

Non-generic abstract base class representing an Apama type (with reduced compile-time type safety). More...

Inherited by Apama.Event.Parser.DictionaryFieldType, Apama.Event.Parser.FieldType< T >, and Apama.Event.Parser.SequenceFieldType.

Public Member Functions
virtual string	Format (Object value)
	Format the given value in MonitorScript representation. More...
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...

Protected Member Functions
	FieldType (string typeName, Type clazz)
	Create a new FieldType. More...

Properties
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...

Detailed Description

Non-generic abstract base class representing an Apama type (with reduced compile-time type safety).

For most applications, it is better to use the generic FieldType<T> class instead of this one, unless there is a specific requirement to process fields from Event objects without access to the corresponding generic FieldType<T> object.

Constructor & Destructor Documentation

Apama.Event.Parser.FieldType.FieldType ( string  typeName, Type  clazz  )

protected

Create a new FieldType.

Parameters

typeName	the name of the fieldtype
clazz	the underlying type of the fieldtype

Member Function Documentation

virtual string Apama.Event.Parser.FieldType.Format ( Object  value )

virtual

Format the given value in MonitorScript representation.

Parameters

value

The value to format

Returns

The formatted value

Reimplemented in Apama.Event.Parser.DictionaryFieldType, and Apama.Event.Parser.SequenceFieldType.

abstract object Apama.Event.Parser.FieldType.GetDefaultValue ( )

pure virtual

Get the default value for this field type.

Returns

abstract object Apama.Event.Parser.FieldType.ParseObject ( String  value )

pure virtual

Parse a value from this type's Apama event string representation into the .NET object representation of the value.

Usually it is better to use the Parse method instead of ParseObject, since Parse indicates the return type in its method signature, providing better usability and type safety than ParseObject.

Parameters

value

The value to parse

Returns

A .NET object representing the parsed value.

override string Apama.Event.Parser.FieldType.ToString

(

)

For Internal use only

Property Documentation

string Apama.Event.Parser.FieldType.Name

get

Return the name of this type.

Returns

The type name

Type Apama.Event.Parser.FieldType.TypeClass

get

Return the .NET type used to express values of this Apama field type.

Returns

The class representation of the field