Apama API Reference for .NET
10.0.0.2
|
Represents the definition of an Apama event type, for which values are specified as Apama.Event.Event objects. Each EventType consists of an event type name, and zero or more Field<T> objects. More...
Inherits Apama.Event.Parser.ReferenceFieldType< T >.
Public Member Functions | |
void | AddField (Field field) |
Method to append extra field to the EventType. More... | |
void | AddField (string name, FieldType fieldType) |
Method to append extra field to the EventType. More... | |
override Event | DefaultValue () |
Get the default value for Event field type. More... | |
override bool | Equals (Object obj) |
Determines whether two EventType objects are equal More... | |
EventType (string name, params Field[] fields) | |
Create a new Event Type by specifying the name of the event and the FieldType of each of the event parameter. More... | |
bool | FieldExists (string fieldName, FieldType fieldType) |
Method to check if this EventType contains a field with name fieldName AND type fieldType. More... | |
Field | GetField (string fieldName) |
Get a named field. More... | |
override int | GetHashCode () |
The hash function for EventType More... | |
override Event | Parse (string value) |
Parse a token according to syntax rules of this type. More... | |
override string | ToString () |
Returns a String representation of the event type. Note that this representation is not valid monitorscript. More... | |
Public Member Functions inherited from Apama.Event.Parser.FieldType< T > | |
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... | |
Public Member Functions inherited from Apama.Event.Parser.FieldType | |
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... | |
Properties | |
ReadOnlyCollection< string > | FieldNames [get] |
Method to retrieve the field names as a string array for the event. 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... | |
Represents the definition of an Apama event type, for which values are specified as Apama.Event.Event objects. Each EventType consists of an event type name, and zero or more Field<T> objects.
The EventType class is not fully thread-safe, but once it has been initialized with all the required fields it is safe to concurrently use it to parse and create event strings from any thread, provided fields are not added or removed from the event type (which would never happen in typical usage anyway).
Apama.Event.Parser.EventType.EventType | ( | string | name, |
params Field[] | fields | ||
) |
void Apama.Event.Parser.EventType.AddField | ( | Field | field | ) |
void Apama.Event.Parser.EventType.AddField | ( | string | name, |
FieldType | fieldType | ||
) |
Method to append extra field to the EventType.
name | Name of the field |
fieldType | Of the new field to be added New applications are recommended to use the generic FieldType<T> type, although the legacy FieldType is also supported for backwards compatibility reasons. |
|
virtual |
Get the default value for Event field type.
Implements Apama.Event.Parser.FieldType< T >.
override bool Apama.Event.Parser.EventType.Equals | ( | Object | obj | ) |
Determines whether two EventType objects are equal
obj | The object to compare for equality |
bool Apama.Event.Parser.EventType.FieldExists | ( | string | fieldName, |
FieldType | fieldType | ||
) |
Method to check if this EventType contains a field with name fieldName AND type fieldType.
fieldName | The fieldName to check |
fieldType | The fieldType to match |
Field Apama.Event.Parser.EventType.GetField | ( | string | fieldName | ) |
Get a named field.
fieldName | The fieldName to check |
override int Apama.Event.Parser.EventType.GetHashCode | ( | ) |
The hash function for EventType
override Event Apama.Event.Parser.EventType.Parse | ( | string | value | ) |
Parse a token according to syntax rules of this type.
value | The value to parse |
ParserRuntimeException | If some problem occurs |
override string Apama.Event.Parser.EventType.ToString | ( | ) |
Returns a String representation of the event type. Note that this representation is not valid monitorscript.
|
get |
Method to retrieve the field names as a string array for the event.