com.espertech.esper.view.std
Class AddPropertyValueView

java.lang.Object
  com.espertech.esper.view.ViewSupport
      com.espertech.esper.view.std.AddPropertyValueView

All Implemented Interfaces:

CloneableView, EventCollection, StoppableView, View, Viewable, java.lang.Iterable<EventBean>

public final class AddPropertyValueView
extends ViewSupport
implements CloneableView, StoppableView

This view simply adds a property to the events posted to it. This is useful for the group-merge views.

Field Summary

Fields inherited from class com.espertech.esper.view.ViewSupport

EMPTY_VIEW_ARRAY, parent

Constructor Summary

AddPropertyValueView(AgentInstanceViewFactoryChainContext agentInstanceContext, java.lang.String[] propertyNames, java.lang.Object mergeValues, EventType mergedResultEventType)
Constructor.

Method Summary

protected static EventBean	addProperty(EventBean originalEvent, java.lang.String[] propertyNames, java.lang.Object propertyValues, EventType targetEventType, EventAdapterService eventAdapterService) Add a property to the event passed in.
View	cloneView() Duplicates the view.
EventType	getEventType() Provides metadata information about the type of object the event collection contains.
java.lang.String[]	getPropertyNames() Returns field name for which to set the merge value for.
java.lang.Object	getPropertyValues() Returns the value to set for the field.
java.util.Iterator<EventBean>	iterator() Allows iteration through all elements in this event collection.
void	setParent(Viewable parent) Called when the View is added to a Viewable object.
void	stopView()
java.lang.String	toString()
void	update(EventBean[] newData, EventBean[] oldData) Notify that data has been added or removed from the Viewable parent.

Methods inherited from class com.espertech.esper.view.ViewSupport

addView, addView, dumpChildViews, dumpUpdateParams, dumpUpdateParams, findDescendent, findViewIndex, getParent, getViews, hasViews, removeAllViews, removeView, removeView, updateChildren, updateChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AddPropertyValueView

public AddPropertyValueView(AgentInstanceViewFactoryChainContext agentInstanceContext,
                            java.lang.String[] propertyNames,
                            java.lang.Object mergeValues,
                            EventType mergedResultEventType)

Constructor.

Parameters:

propertyNames - is the name of the field that is added to any events received by this view.

mergeValues - is the values of the field that is added to any events received by this view.

mergedResultEventType - is the event type that the merge view reports to it's child views

agentInstanceContext - contains required view services

Method Detail

cloneView

public View cloneView()

Description copied from interface: CloneableView

Duplicates the view.

Expected to return a same view in initialized state for grouping.

Specified by:

cloneView in interface CloneableView

setParent

public void setParent(Viewable parent)

Description copied from interface: View

Called when the View is added to a Viewable object.

Specified by:

setParent in interface View

Overrides:

setParent in class ViewSupport

Parameters:

parent - is the parent that this view is a child of

getPropertyNames

public final java.lang.String[] getPropertyNames()

Returns field name for which to set the merge value for.

Returns:

field name to use to set value

getPropertyValues

public final java.lang.Object getPropertyValues()

Returns the value to set for the field.

Returns:

value to set

update

public final void update(EventBean[] newData,
                         EventBean[] oldData)

Description copied from interface: View

Notify that data has been added or removed from the Viewable parent. The last object in the newData array of objects would be the newest object added to the parent view. The first object of the oldData array of objects would be the oldest object removed from the parent view. If the call to update contains new (inserted) data, then the first argument will be a non-empty list and the second will be empty. Similarly, if the call is a notification of deleted data, then the first argument will be empty and the second will be non-empty. Either the newData or oldData will be non-null. This method won't be called with both arguments being null, but either one could be null. The same is true for zero-length arrays. Either newData or oldData will be non-empty. If both are non-empty, then the update is a modification notification. When update() is called on a view by the parent object, the data in newData will be in the collection of the parent, and its data structures will be arranged to reflect that. The data in oldData will not be in the parent's data structures, and any access to the parent will indicate that that data is no longer there.

Specified by:

update in interface View

Parameters:

newData - is the new data that has been added to the parent view

oldData - is the old data that has been removed from the parent view

getEventType

public final EventType getEventType()

Description copied from interface: EventCollection

Provides metadata information about the type of object the event collection contains.

Specified by:

getEventType in interface EventCollection

Returns:

metadata for the objects in the collection

iterator

public final java.util.Iterator<EventBean> iterator()

Description copied from interface: EventCollection

Allows iteration through all elements in this event collection. The iterator will return the elements in the collection in their natural order, or, if there is no natural ordering, in some unpredictable order.

Specified by:

iterator in interface EventCollection

Specified by:

iterator in interface java.lang.Iterable<EventBean>

Returns:

an iterator which will go through all current elements in the collection.

stopView

public void stopView()

Specified by:

stopView in interface StoppableView

addProperty

protected static EventBean addProperty(EventBean originalEvent,
                                       java.lang.String[] propertyNames,
                                       java.lang.Object propertyValues,
                                       EventType targetEventType,
                                       EventAdapterService eventAdapterService)

Add a property to the event passed in.

Parameters:

originalEvent - - event to add property to

propertyNames - - names of properties to add

propertyValues - - value of properties to add

targetEventType - - new event type

eventAdapterService - - service for generating events and handling event types

Returns:

event with added property

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object