Apama API Reference for .NET  10.11.0.1
Apama.Event.Parser.FieldTypes Class Reference

Provides factory methods and constants for getting all supported Apama event field types. More...

Static Public Member Functions

static ReferenceFieldType< IDictionary< TKey, TValue > > Dictionary< TKey, TValue > (FieldType< TKey > keyType, FieldType< TValue > valueType)
 Create a new field type object for an Apama dictionary event field. More...
 
static FieldType< T?> Optional< T > (PrimitiveFieldType< T > containedType)
 Create an optional field type object with a primitive containedType Apama event field. More...
 
static FieldType< T > Optional< T > (ReferenceFieldType< T > containedType)
 Create an optional field type with a referenced containedType Apama event field. More...
 
static ReferenceFieldType< IList< E > > Sequence< E > (FieldType< E > elementType)
 Create a new field type object for an Apama sequence event field. More...
 

Static Public Attributes

static readonly PrimitiveFieldType< Boolean > Boolean = BooleanFieldType.Type
 Get the singleton field type object for the Apama boolean type, for which values are specified as .NET Boolean objects. More...
 
static readonly ReferenceFieldType< StringChannel = ChannelFieldType.Type
 Get the singleton field type object for the Apama string type, for which values are specified as .NET Channel objects. More...
 
static readonly FieldType< StringContext = ContextFieldType.Type
 Get the singleton field type object for the Apama string type, for which values are specified as .NET Context objects. More...
 
static readonly ReferenceFieldType< DecimalFieldValueDecimal = DecimalFieldType.Type
 Get the singleton field type object for the Apama decimal type, for which values are specified as .NET DecimalFieldValue objects. More...
 
static readonly PrimitiveFieldType< Double > Float = FloatFieldType.Type
 Get the singleton field type object for the Apama float type, for which values are specified as .NET Double objects. More...
 
static readonly PrimitiveFieldType< Int64 > Integer = IntegerFieldType.Type
 Get the singleton field type object for the Apama integer type, for which values are specified as .NET Int64 objects. More...
 
static readonly ReferenceFieldType< LocationTypeLocation = LocationFieldType.Type
 Get the singleton field type object for the Apama location type, for which values are specified as .NET LocationType objects. More...
 
static readonly ReferenceFieldType< String > String = StringFieldType.Type
 Get the singleton field type object for the Apama string type, for which values are specified as .NET String objects. More...
 

Detailed Description

Provides factory methods and constants for getting all supported Apama event field types.

The following example shows how it is possible to create a field object whose type is an Apama sequence of integers:

var myField = FieldTypes.Sequence(FieldTypes.Integer).NewField("myField");

Member Function Documentation

◆ Dictionary< TKey, TValue >()

static ReferenceFieldType<IDictionary<TKey, TValue> > Apama.Event.Parser.FieldTypes.Dictionary< TKey, TValue > ( FieldType< TKey >  keyType,
FieldType< TValue >  valueType 
)
static

Create a new field type object for an Apama dictionary event field.

Template Parameters
TKeyThe .NET type used to represent the key of items in this dictionary.
TValueThe .NET type used to represent the value of items in this dictionary.
Parameters
keyTypeThe event field type for the key of items in this dictionary.
valueTypeThe event field type for the value of items in this dictionary.
Returns
A new object representing this field type, which can be used in the constructor to EventType.

◆ Optional< T >() [1/2]

static FieldType<T?> Apama.Event.Parser.FieldTypes.Optional< T > ( PrimitiveFieldType< T >  containedType)
static

Create an optional field type object with a primitive containedType Apama event field.

To create an optional event field of Integer, Boolean and Float fieldTypes with field names of "intField", "boolField" and "doubleField" respectively:

<para />Field<long?> intField = FieldTypes.Optional(FieldTypes.Integer).NewField("intField");
<para />Field<bool?> boolField = FieldTypes.Optional(FieldTypes.Boolean).NewField("boolField");
<para />Field<double?> dblField = FieldTypes.Optional(FieldTypes.Float).NewField("doubleField");
Template Parameters
TThe .NET type used to represent the value contained in this optional field.
Parameters
containedTypeThe event field type for the contained element in this field.
Returns
A new object representing this field type, which can be used in the constructor to EventType.
Type Constraints
T :struct 

◆ Optional< T >() [2/2]

static FieldType<T> Apama.Event.Parser.FieldTypes.Optional< T > ( ReferenceFieldType< T >  containedType)
static

Create an optional field type with a referenced containedType Apama event field.

To create an optional event field of Decimal, Sequence of Integer and an EventType type with field names of "decField", "seqIntField" and "evtField" respectively:

<para />Field<DecimalFieldValue> decField = FieldTypes.Optional(FieldTypes.Decimal).NewField("decField");
<para />Field<IList<long>> optSeqIntField = FieldTypes.Optional(FieldTypes.Sequence(FieldTypes.Integer)).NewField("seqIntField");
<para />Field<Event> optSubEventField = FieldTypes.Optional(subEventType).NewField("evtField");
Template Parameters
TThe .NET type used to represent the value contained in this optional field.
Parameters
containedTypeThe event field type for the contained element in this field.
Returns
A new object representing this field type, which can be used in the constructor to EventType.
Type Constraints
T :class 

◆ Sequence< E >()

static ReferenceFieldType<IList<E> > Apama.Event.Parser.FieldTypes.Sequence< E > ( FieldType< E >  elementType)
static

Create a new field type object for an Apama sequence event field.

Template Parameters
EThe .NET type used to represent values in this sequence.
Parameters
elementTypeThe event field type for the elements in this sequence.
Returns
A new object representing this field type, which can be used in the constructor to EventType.

Member Data Documentation

◆ Boolean

readonly PrimitiveFieldType<Boolean> Apama.Event.Parser.FieldTypes.Boolean = BooleanFieldType.Type
static

Get the singleton field type object for the Apama boolean type, for which values are specified as .NET Boolean objects.

◆ Channel

readonly ReferenceFieldType<String> Apama.Event.Parser.FieldTypes.Channel = ChannelFieldType.Type
static

Get the singleton field type object for the Apama string type, for which values are specified as .NET Channel objects.

◆ Context

readonly FieldType<String> Apama.Event.Parser.FieldTypes.Context = ContextFieldType.Type
static

Get the singleton field type object for the Apama string type, for which values are specified as .NET Context objects.

◆ Decimal

readonly ReferenceFieldType<DecimalFieldValue> Apama.Event.Parser.FieldTypes.Decimal = DecimalFieldType.Type
static

Get the singleton field type object for the Apama decimal type, for which values are specified as .NET DecimalFieldValue objects.

◆ Float

readonly PrimitiveFieldType<Double> Apama.Event.Parser.FieldTypes.Float = FloatFieldType.Type
static

Get the singleton field type object for the Apama float type, for which values are specified as .NET Double objects.

◆ Integer

readonly PrimitiveFieldType<Int64> Apama.Event.Parser.FieldTypes.Integer = IntegerFieldType.Type
static

Get the singleton field type object for the Apama integer type, for which values are specified as .NET Int64 objects.

◆ Location

readonly ReferenceFieldType<LocationType> Apama.Event.Parser.FieldTypes.Location = LocationFieldType.Type
static

Get the singleton field type object for the Apama location type, for which values are specified as .NET LocationType objects.

◆ String

readonly ReferenceFieldType<String> Apama.Event.Parser.FieldTypes.String = StringFieldType.Type
static

Get the singleton field type object for the Apama string type, for which values are specified as .NET String objects.

Submit a bug or feature
Copyright (c) 2013-2021 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.