public abstract class BaseConfigurableEventType extends Object implements EventTypeSPI
| Modifier and Type | Field and Description |
|---|---|
protected Map<String,EventPropertyDescriptor> |
propertyDescriptorMap
Descriptors for each known property.
|
protected Map<String,EventPropertyGetterSPI> |
propertyGetters
Getters for each known property.
|
| Modifier | Constructor and Description |
|---|---|
protected |
BaseConfigurableEventType(EventAdapterService eventAdapterService,
EventTypeMetadata metadata,
int eventTypeId,
Class underlyngType)
Ctor.
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract FragmentEventType |
doResolveFragmentType(String property)
Subclasses must implement this and return a fragment type for a property.
|
protected abstract EventPropertyGetterSPI |
doResolvePropertyGetter(String property)
Subclasses must implement this and supply a getter to a given property.
|
protected abstract Class |
doResolvePropertyType(String property)
Subclasses must implement this and return a type for a property.
|
EventAdapterService |
getEventAdapterService()
Returns the event adapter service.
|
int |
getEventTypeId()
Returns the event type id assigned to the event type.
|
FragmentEventType |
getFragmentType(String property)
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.
|
EventPropertyGetterIndexedSPI |
getGetterIndexed(String indexedProperty)
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 propertyName) |
EventPropertyGetterMapped |
getGetterMapped(String mappedProperty)
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 mappedProperty) |
EventPropertyGetterSPI |
getGetterSPI(String propertyExpression) |
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 propertyExpression)
Get the type of an event property.
|
Class |
getUnderlyingType()
Get the class that represents the Java type of the event type.
|
protected void |
initialize(List<ExplicitPropertyDescriptor> explicitProperties)
Sets explicit properties using a map of event property name and getter instance for each property.
|
boolean |
isProperty(String property)
Check that the given property name or property expression is valid for this event type, ie.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitequalsCompareType, getCopyMethod, getReader, getWritableProperty, getWriteableProperties, getWriter, getWritergetDeepSuperTypes, getEndTimestampPropertyName, getStartTimestampPropertyName, getSuperTypesprotected Map<String,EventPropertyGetterSPI> propertyGetters
protected Map<String,EventPropertyDescriptor> propertyDescriptorMap
protected BaseConfigurableEventType(EventAdapterService eventAdapterService, EventTypeMetadata metadata, int eventTypeId, Class underlyngType)
underlyngType - is the underlying type returned by the event typemetadata - event type metadataeventAdapterService - for dynamic event type creationeventTypeId - type idpublic int getEventTypeId()
EventTypegetEventTypeId in interface EventTypeprotected abstract EventPropertyGetterSPI doResolvePropertyGetter(String property)
property - is the property expressionprotected abstract Class doResolvePropertyType(String property)
property - is the property expressionprotected abstract FragmentEventType doResolveFragmentType(String property)
property - is the property expressionpublic String getName()
EventTypeA 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.
public EventAdapterService getEventAdapterService()
protected void initialize(List<ExplicitPropertyDescriptor> explicitProperties)
explicitProperties - property descriptors for explicit propertiespublic Class getPropertyType(String propertyExpression)
EventTypeReturns 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.
getPropertyType in interface EventTypepropertyExpression - is the property name or property expressionpublic Class getUnderlyingType()
EventTypegetUnderlyingType in interface EventTypepublic EventPropertyGetterSPI getGetterSPI(String propertyExpression)
getGetterSPI in interface EventTypeSPIpublic EventPropertyGetter getGetter(String propertyName)
EventTypeReturns 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.
public EventPropertyGetterMapped getGetterMapped(String mappedProperty)
EventTypeReturns 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.
getGetterMapped in interface EventTypemappedProperty - is the property namepublic EventPropertyGetterMappedSPI getGetterMappedSPI(String mappedProperty)
getGetterMappedSPI in interface EventTypeSPIpublic EventPropertyGetterIndexedSPI getGetterIndexedSPI(String propertyName)
getGetterIndexedSPI in interface EventTypeSPIpublic EventPropertyGetterIndexedSPI getGetterIndexed(String indexedProperty)
EventTypeReturns 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.
getGetterIndexed in interface EventTypeindexedProperty - is the property namepublic FragmentEventType getFragmentType(String property)
EventTypeReturns 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.
getFragmentType in interface EventTypeproperty - is the name of the property to return the fragment event typepublic String[] getPropertyNames()
EventTypeNote 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.
getPropertyNames in interface EventTypepublic boolean isProperty(String property)
EventTypeThe 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.
isProperty in interface EventTypeproperty - is the property name or property expression to checkpublic EventPropertyDescriptor[] getPropertyDescriptors()
EventTypeNote 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.
getPropertyDescriptors in interface EventTypepublic EventTypeMetadata getMetadata()
EventTypeSPIgetMetadata in interface EventTypeSPIpublic EventPropertyDescriptor getPropertyDescriptor(String propertyName)
EventTypeThe 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.
getPropertyDescriptor in interface EventTypepropertyName - property name