net.esper.view.std
Class AddPropertyValueView

java.lang.Object
  extended by net.esper.view.ViewSupport
      extended by net.esper.view.std.AddPropertyValueView
All Implemented Interfaces:
Iterable<EventBean>, ContextAwareView, EventCollection, View, Viewable

public final class AddPropertyValueView
extends ViewSupport
implements ContextAwareView

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 net.esper.view.ViewSupport
parent
 
Constructor Summary
AddPropertyValueView()
          Empty constructor - required for Java bean.
AddPropertyValueView(String[] fieldNames, Object[] mergeValues)
          Constructor.
 
Method Summary
protected static EventBean addProperty(EventBean originalEvent, String[] propertyNames, Object[] propertyValues, EventType targetEventType, EventAdapterService eventAdapterService)
          Add a property to the event passed in.
 String attachesTo(Viewable object)
          Return null if the view will accept being attached to a particular object.
 EventType getEventType()
          Provides metadata information about the type of object the event collection contains.
 String[] getPropertyNames()
          Returns field name for which to set the merge value for.
 Object[] getPropertyValues()
          Returns the value to set for the field.
 ViewServiceContext getViewServiceContext()
          Returns the context instances used by the view.
 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 setPropertyNames(String[] propertyNames)
          Sets the field name for which to set the merge value for.
 void setPropertyValues(Object[] propertyValue)
          Sets the value for the field to merge into the events coming into this view.
 void setViewServiceContext(ViewServiceContext viewServiceContext)
          Set the services context containing service handles.
 String toString()
           
 void update(EventBean[] newData, EventBean[] oldData)
          Notify that data has been added or removed from the Viewable parent.
 
Methods inherited from class net.esper.view.ViewSupport
addView, dumpChildViews, dumpUpdateParams, findDescendent, getParent, getViews, hasViews, removeView, shallowCopyView, updateChildren, updateChildren
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AddPropertyValueView

public AddPropertyValueView()
Empty constructor - required for Java bean.


AddPropertyValueView

public AddPropertyValueView(String[] fieldNames,
                            Object[] mergeValues)
Constructor.

Parameters:
fieldNames - 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.
Method Detail

getViewServiceContext

public ViewServiceContext getViewServiceContext()
Description copied from interface: ContextAwareView
Returns the context instances used by the view.

Specified by:
getViewServiceContext in interface ContextAwareView
Returns:
context instance

setViewServiceContext

public void setViewServiceContext(ViewServiceContext viewServiceContext)
Description copied from interface: ContextAwareView
Set the services context containing service handles.

Specified by:
setViewServiceContext in interface ContextAwareView
Parameters:
viewServiceContext - with service handles

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

attachesTo

public final String attachesTo(Viewable object)
Description copied from interface: View
Return null if the view will accept being attached to a particular object.

Specified by:
attachesTo in interface View
Parameters:
object - is the potential parent for this view
Returns:
null if this view can successfully attach to the parent, an error message if it cannot.

getPropertyNames

public final String[] getPropertyNames()
Returns field name for which to set the merge value for.

Returns:
field name to use to set value

setPropertyNames

public final void setPropertyNames(String[] propertyNames)
Sets the field name for which to set the merge value for.

Parameters:
propertyNames - to set

getPropertyValues

public final Object[] getPropertyValues()
Returns the value to set for the field.

Returns:
value to set

setPropertyValues

public final void setPropertyValues(Object[] propertyValue)
Sets the value for the field to merge into the events coming into this view.

Parameters:
propertyValue - is the value to merge in

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 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 Iterable<EventBean>
Specified by:
iterator in interface EventCollection
Returns:
an iterator which will go through all current elements in the collection.

addProperty

protected static EventBean addProperty(EventBean originalEvent,
                                       String[] propertyNames,
                                       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 String toString()
Overrides:
toString in class Object