BaseNestableEventType (Esper API Documentation)

java.lang.Object
- com.espertech.esper.event.BaseNestableEventType

All Implemented Interfaces:

EventType, EventTypeSPI

Direct Known Subclasses:

MapEventType, ObjectArrayEventType
```
public abstract class BaseNestableEventType
extends Object
implements EventTypeSPI
```
Implementation of the EventType interface for handling name value pairs.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`endTimestampPropertyName`
`protected EventAdapterService`	`eventAdapterService`
`protected int`	`eventTypeId`
`protected EventTypeNestableGetterFactory`	`getterFactory`
`protected EventTypeMetadata`	`metadata`
`protected Map<String,Object>`	`nestableTypes`
`protected Set<EventType>`	`optionalDeepSupertypes`
`protected EventType[]`	`optionalSuperTypes`
`protected EventPropertyDescriptor[]`	`propertyDescriptors`
`protected Map<String,EventPropertyGetterSPI>`	`propertyGetterCache`
`protected Map<String,PropertySetDescriptorItem>`	`propertyItems`
`protected String[]`	`propertyNames`
`protected String`	`startTimestampPropertyName`
`protected String`	`typeName`

Constructor Summary

Constructors
Constructor and Description
`BaseNestableEventType(EventTypeMetadata metadata, String typeName, int eventTypeId, EventAdapterService eventAdapterService, Map<String,Object> propertyTypes, EventType[] optionalSuperTypes, Set<EventType> optionalDeepSupertypes, ConfigurationEventTypeWithSupertype typeConfig, EventTypeNestableGetterFactory getterFactory)` Constructor takes a type name, map of property names and types, for use with nestable Map events.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAdditionalProperties(Map<String,Object> typeMap, EventAdapterService eventAdapterService)` Adds additional properties that do not yet exist on the given type.
`boolean`	`equalsCompareType(EventType otherEventType)`
`Iterator<EventType>`	`getDeepSuperTypes()` Returns iterator over all super types to event type, going up the hierarchy and including all Java interfaces (and their extended interfaces) and superclasses as EventType instances.
`String`	`getEndTimestampPropertyName()` Returns the property name of the property providing the end timestamp value.
`String`	`getEqualsMessage(EventType otherType)` Returns a message if the type, compared to this type, is not compatible in regards to the property numbers and types.
`int`	`getEventTypeId()` Returns the event type id assigned to the event type.
`FragmentEventType`	`getFragmentType(String propertyName)` Returns the event type of the fragment that is the value of a property name or property expression.
`EventPropertyGetter`	`getGetter(String propertyName)` Get the getter of an event property or property expression: Getters are useful when an application receives events of the same event type multiple times and requires fast access to an event property or nested, indexed or mapped property.
`EventPropertyGetterIndexed`	`getGetterIndexed(String indexedPropertyName)` Get the getter of an event property that is a indexed event property: Getters are useful when an application receives events of the same event type multiple times and requires fast access to a indexed property.
`EventPropertyGetterIndexedSPI`	`getGetterIndexedSPI(String indexedPropertyName)`
`EventPropertyGetterMapped`	`getGetterMapped(String mappedPropertyName)` Get the getter of an event property that is a mapped event property: Getters are useful when an application receives events of the same event type multiple times and requires fast access to a mapped property.
`EventPropertyGetterMappedSPI`	`getGetterMappedSPI(String mappedPropertyName)`
`EventPropertyGetterSPI`	`getGetterSPI(String propertyName)`
`EventTypeMetadata`	`getMetadata()` Returns the type metadata.
`String`	`getName()` Returns the type name or null if no type name is assigned.
`EventPropertyDescriptor`	`getPropertyDescriptor(String propertyName)` Get the property descriptor for a given property of the event, or null if a property by that name was not found.
`EventPropertyDescriptor[]`	`getPropertyDescriptors()` Get property descriptors for the event type.
`String[]`	`getPropertyNames()` Get the property names for the event type.
`Class`	`getPropertyType(String propertyName)` Get the type of an event property.
`String`	`getStartTimestampPropertyName()` Returns the property name of the property providing the start timestamp value.
`EventType[]`	`getSuperTypes()` Returns an array of event types that are super to this event type, from which this event type inherited event properties.
`Map<String,Object>`	`getTypes()` Returns the name-type map of map properties, each value in the map can be a Class or a Map<String, Object> (for nested maps).
`static String`	`isDeepEqualsProperties(String otherName, Map<String,Object> setOne, Map<String,Object> setTwo)` Compares two sets of properties and determines if they are the same, allowing for boxed/unboxed types, and nested map types.
`boolean`	`isProperty(String propertyName)` Check that the given property name or property expression is valid for this event type, ie.
`protected abstract void`	`postUpdateNestableTypes()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.espertech.esper.event.EventTypeSPI
getCopyMethod, getReader, getWritableProperty, getWriteableProperties, getWriter, getWriter

Methods inherited from interface com.espertech.esper.client.EventType
getUnderlyingType

- Field Detail
  - metadata
```
protected final EventTypeMetadata metadata
```
  - typeName
```
protected final String typeName
```
  - eventAdapterService
```
protected final EventAdapterService eventAdapterService
```
  - optionalSuperTypes
```
protected final EventType[] optionalSuperTypes
```
  - optionalDeepSupertypes
```
protected final Set<EventType> optionalDeepSupertypes
```
  - eventTypeId
```
protected final int eventTypeId
```
  - getterFactory
```
protected final EventTypeNestableGetterFactory getterFactory
```
  - propertyNames
```
protected String[] propertyNames
```
  - propertyDescriptors
```
protected EventPropertyDescriptor[] propertyDescriptors
```
  - propertyItems
```
protected final Map<String,PropertySetDescriptorItem> propertyItems
```
  - propertyGetterCache
```
protected Map<String,EventPropertyGetterSPI> propertyGetterCache
```
  - nestableTypes
```
protected Map<String,Object> nestableTypes
```
  - startTimestampPropertyName
```
protected String startTimestampPropertyName
```
  - endTimestampPropertyName
```
protected String endTimestampPropertyName
```
- Constructor Detail
  - BaseNestableEventType
```
public BaseNestableEventType(EventTypeMetadata metadata,
                             String typeName,
                             int eventTypeId,
                             EventAdapterService eventAdapterService,
                             Map<String,Object> propertyTypes,
                             EventType[] optionalSuperTypes,
                             Set<EventType> optionalDeepSupertypes,
                             ConfigurationEventTypeWithSupertype typeConfig,
                             EventTypeNestableGetterFactory getterFactory)
```
    Constructor takes a type name, map of property names and types, for use with nestable Map events.
    
    Parameters:
    
    typeName - is the event type name used to distinquish map types that have the same property types, empty string for anonymous maps, or for insert-into statements generating map events the stream name
    
    propertyTypes - is pairs of property name and type
    
    eventAdapterService - is required for access to objects properties within map values
    
    optionalSuperTypes - the supertypes to this type if any, or null if there are no supertypes
    
    optionalDeepSupertypes - the deep supertypes to this type if any, or null if there are no deep supertypes
    
    metadata - event type metadata
    
    typeConfig - type config
    
    eventTypeId - tye id
    
    getterFactory - getter factory
- Method Detail
  - postUpdateNestableTypes
```
protected abstract void postUpdateNestableTypes()
```
  - getName
```
public String getName()
```
    Description copied from interface: EventType
    
    Returns the type name or null if no type name is assigned.
    A type name is available for application-configured event types and for event types that represent events of a stream populated by insert-into.
    No type name is available for anonymous statement-specific event type.
    
    Specified by:
    
    getName in interface EventType
    
    Returns:
    
    type name or null if none assigned
  - getEventTypeId
```
public int getEventTypeId()
```
    Description copied from interface: EventType
    
    Returns the event type id assigned to the event type.
    
    Specified by:
    
    getEventTypeId in interface EventType
    
    Returns:
    
    event type id
  - getStartTimestampPropertyName
```
public String getStartTimestampPropertyName()
```
    Description copied from interface: EventType
    
    Returns the property name of the property providing the start timestamp value.
    
    Specified by:
    
    getStartTimestampPropertyName in interface EventType
    
    Returns:
    
    start timestamp property name
  - getEndTimestampPropertyName
```
public String getEndTimestampPropertyName()
```
    Description copied from interface: EventType
    
    Returns the property name of the property providing the end timestamp value.
    
    Specified by:
    
    getEndTimestampPropertyName in interface EventType
    
    Returns:
    
    end timestamp property name
  - getPropertyType
```
public final Class getPropertyType(String propertyName)
```
    Description copied from interface: EventType
    
    Get the type of an event property.
    Returns null if the property name or property expression is not valid against the event type. Can also return null if a select-clause selects a constant null value.
    The method takes a property name or property expression as a parameter. Property expressions may include indexed properties via the syntax "name[index]", mapped properties via the syntax "name('key')", nested properties via the syntax "outer.inner" or combinations thereof.
    Returns unboxed (such as 'int.class') as well as boxed (java.lang.Integer) type.
    
    Specified by:
    
    getPropertyType in interface EventType
    
    Parameters:
    
    propertyName - is the property name or property expression
    
    Returns:
    
    type of the property, the unboxed or the boxed type.
  - getGetterSPI
```
public EventPropertyGetterSPI getGetterSPI(String propertyName)
```
    Specified by:
    
    getGetterSPI in interface EventTypeSPI
  - getGetter
```
public EventPropertyGetter getGetter(String propertyName)
```
    Description copied from interface: EventType
    
    Get the getter of an event property or property expression: Getters are useful when an application receives events of the same event type multiple times and requires fast access to an event property or nested, indexed or mapped property.
    Returns null if the property name or property expression is not valid against the event type.
    The method takes a property name or property expression as a parameter. Property expressions may include indexed properties via the syntax "name[index]", mapped properties via the syntax "name('key')", nested properties via the syntax "outer.inner" or combinations thereof.
    
    Specified by:
    
    getGetter in interface EventType
    
    Parameters:
    
    propertyName - is the property name or property expression
    
    Returns:
    
    a getter that can be used to obtain property values for event instances of the same event type
  - getGetterMapped
```
public EventPropertyGetterMapped getGetterMapped(String mappedPropertyName)
```
    Description copied from interface: EventType
    
    Get the getter of an event property that is a mapped event property: Getters are useful when an application receives events of the same event type multiple times and requires fast access to a mapped property.
    Returns null if the property name is not valid against the event type or the property is not a mapped property.
    The method takes a mapped property name (and not a property expression) as a parameter.
    
    Specified by:
    
    getGetterMapped in interface EventType
    
    Parameters:
    
    mappedPropertyName - is the property name
    
    Returns:
    
    a getter that can be used to obtain property values for event instances of the same event type
  - getGetterMappedSPI
```
public EventPropertyGetterMappedSPI getGetterMappedSPI(String mappedPropertyName)
```
    Specified by:
    
    getGetterMappedSPI in interface EventTypeSPI
  - getGetterIndexed
```
public EventPropertyGetterIndexed getGetterIndexed(String indexedPropertyName)
```
    Description copied from interface: EventType
    
    Get the getter of an event property that is a indexed event property: Getters are useful when an application receives events of the same event type multiple times and requires fast access to a indexed property.
    Returns null if the property name is not valid against the event type or the property is not an indexed property.
    The method takes a indexed property name (and not a property expression) as a parameter.
    
    Specified by:
    
    getGetterIndexed in interface EventType
    
    Parameters:
    
    indexedPropertyName - is the property name
    
    Returns:
    
    a getter that can be used to obtain property values for event instances of the same event type
  - getGetterIndexedSPI
```
public EventPropertyGetterIndexedSPI getGetterIndexedSPI(String indexedPropertyName)
```
    Specified by:
    
    getGetterIndexedSPI in interface EventTypeSPI
  - getPropertyNames
```
public String[] getPropertyNames()
```
    Description copied from interface: EventType
    
    Get the property names for the event type.
    Note that properties do not have a defined order. Your application should not rely on the order of properties returned by this method.
    The method does not return property names of inner or nested types.
    
    Specified by:
    
    getPropertyNames in interface EventType
    
    Returns:
    
    A string array containing the property names of this typed event data object.
  - isProperty
```
public boolean isProperty(String propertyName)
```
    Description copied from interface: EventType
    
    Check that the given property name or property expression is valid for this event type, ie. that the property exists on the event type.
    The method takes a property name or property expression as a parameter. Property expressions may include indexed properties via the syntax "name[index]", mapped properties via the syntax "name('key')", nested properties via the syntax "outer.inner" or combinations thereof.
    
    Specified by:
    
    isProperty in interface EventType
    
    Parameters:
    
    propertyName - is the property name or property expression to check
    
    Returns:
    
    true if exists, false if not
  - getSuperTypes
```
public EventType[] getSuperTypes()
```
    Description copied from interface: EventType
    
    Returns an array of event types that are super to this event type, from which this event type inherited event properties.
    For Java bean instances underlying the event this method returns the event types for all superclasses extended by the Java bean and all interfaces implemented by the Java bean.
    
    Specified by:
    
    getSuperTypes in interface EventType
    
    Returns:
    
    an array of event types
  - getDeepSuperTypes
```
public Iterator<EventType> getDeepSuperTypes()
```
    Description copied from interface: EventType
    
    Returns iterator over all super types to event type, going up the hierarchy and including all Java interfaces (and their extended interfaces) and superclasses as EventType instances.
    
    Specified by:
    
    getDeepSuperTypes in interface EventType
    
    Returns:
    
    iterator of event types represeting all superclasses and implemented interfaces, all the way up to java.lang.Object but excluding java.lang.Object itself
  - getTypes
```
public Map<String,Object> getTypes()
```
    Returns the name-type map of map properties, each value in the map can be a Class or a Map<String, Object> (for nested maps).
    
    Returns:
    
    is the property name and types
  - addAdditionalProperties
```
public void addAdditionalProperties(Map<String,Object> typeMap,
                                    EventAdapterService eventAdapterService)
```
    Adds additional properties that do not yet exist on the given type. Ignores properties already present. Allows nesting.
    
    Parameters:
    
    typeMap - properties to add
    
    eventAdapterService - for resolving further map event types that are property types
  - getPropertyDescriptors
```
public EventPropertyDescriptor[] getPropertyDescriptors()
```
    Description copied from interface: EventType
    
    Get property descriptors for the event type.
    Note that properties do not have a defined order. Your application should not rely on the order of properties returned by this method.
    The method does not return property information of inner or nested types.
    
    Specified by:
    
    getPropertyDescriptors in interface EventType
    
    Returns:
    
    descriptors for all known properties of the event type.
  - isDeepEqualsProperties
```
public static String isDeepEqualsProperties(String otherName,
                                            Map<String,Object> setOne,
                                            Map<String,Object> setTwo)
```
    Compares two sets of properties and determines if they are the same, allowing for boxed/unboxed types, and nested map types.
    
    Parameters:
    
    setOne - is the first set of properties
    
    setTwo - is the second set of properties
    
    otherName - name of the type compared to
    
    Returns:
    
    null if the property set is equivalent or message if not
  - getPropertyDescriptor
```
public EventPropertyDescriptor getPropertyDescriptor(String propertyName)
```
    Description copied from interface: EventType
    
    Get the property descriptor for a given property of the event, or null if a property by that name was not found.
    The property name parameter does accept a property expression. It therefore does not allow the indexed, mapped or nested property expression syntax and only returns the descriptor for the event type's known properties.
    The method does not return property information of inner or nested types.
    For returning a property descriptor for nested, indexed or mapped properties use EventTypeUtility.
    
    Specified by:
    
    getPropertyDescriptor in interface EventType
    
    Parameters:
    
    propertyName - property name
    
    Returns:
    
    descriptor for the named property
  - getMetadata
```
public EventTypeMetadata getMetadata()
```
    Description copied from interface: EventTypeSPI
    
    Returns the type metadata.
    
    Specified by:
    
    getMetadata in interface EventTypeSPI
    
    Returns:
    
    type metadata
  - getFragmentType
```
public FragmentEventType getFragmentType(String propertyName)
```
    Description copied from interface: EventType
    
    Returns the event type of the fragment that is the value of a property name or property expression.
    Returns null if the property name or property expression is not valid or does not return a fragment for the event type.
    The EventPropertyDescriptor provides a flag that indicates which properties provide fragment events.
    This is useful for navigating properties that are itself events or other well-defined types that the underlying event representation may represent as an event type. It is up to each event representation to determine what properties can be represented as event types themselves.
    The method takes a property name or property expression as a parameter. Property expressions may include indexed properties via the syntax "name[index]", mapped properties via the syntax "name('key')", nested properties via the syntax "outer.inner" or combinations thereof.
    The underlying event representation may not support providing fragments or therefore fragment event types for any or all properties, in which case the method returns null.
    Use the EventType.getPropertyDescriptors() method to obtain a list of properties for which a fragment event type may be retrieved by this method.
    
    Specified by:
    
    getFragmentType in interface EventType
    
    Parameters:
    
    propertyName - is the name of the property to return the fragment event type
    
    Returns:
    
    fragment event type of the property
  - getEqualsMessage
```
public String getEqualsMessage(EventType otherType)
```
    Returns a message if the type, compared to this type, is not compatible in regards to the property numbers and types.
    
    Parameters:
    
    otherType - to compare to
    
    Returns:
    
    message
  - equalsCompareType
```
public boolean equalsCompareType(EventType otherEventType)
```
    Specified by:
    
    equalsCompareType in interface EventTypeSPI

Class BaseNestableEventType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.espertech.esper.event.EventTypeSPI

Methods inherited from interface com.espertech.esper.client.EventType

Field Detail

metadata

typeName

eventAdapterService

optionalSuperTypes

optionalDeepSupertypes

eventTypeId

getterFactory

propertyNames

propertyDescriptors

propertyItems

propertyGetterCache

nestableTypes

startTimestampPropertyName

endTimestampPropertyName

Constructor Detail

BaseNestableEventType

Method Detail

postUpdateNestableTypes

getName

getEventTypeId

getStartTimestampPropertyName

getEndTimestampPropertyName

getPropertyType

getGetterSPI

getGetter

getGetterMapped

getGetterMappedSPI

getGetterIndexed

getGetterIndexedSPI

getPropertyNames

isProperty

getSuperTypes

getDeepSuperTypes

getTypes

addAdditionalProperties

getPropertyDescriptors

isDeepEqualsProperties

getPropertyDescriptor

getMetadata

getFragmentType

getEqualsMessage

equalsCompareType