com.webobjects.eocontrol
Class EOAggregateEvent

java.lang.Object
  |
  +--com.webobjects.eocontrol.EOEvent
        |
        +--com.webobjects.eocontrol.EOAggregateEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EOAccountEvent

public class EOAggregateEvent

extends EOEvent

An instance of the EOAggregateEvent class is used to aggregate multiple EOEvent objects with the same aggregate signature into one event. This one aggregate event is typically used in a WOEventDisplay page in a WebObjects application to display the sum of all of the aggregated events' durations.

See Also:

Serialized Form

Fields inherited from class com.webobjects.eocontrol.EOEvent

BasicEventSignature, EventGroupName

Constructor Summary

EOAggregateEvent()

Method Summary

void	addEvent(EOEvent e) Adds e to the set of events that the receiver aggregates.
String	comment() Gets the comment from any member of the EOvents set aggregated by the receiver.
String	description() Gets the description of the family of events represented by the class.
String	displayComponentName() Returns the name of a WebObjects component to use to display the receiver's logging information.
long	durationWithoutSubevents() Gets the the sum of all of the aggregated events'durations excluding the receivers subevents.
NSArray	events() Typically, an EOAggregateEvent has at least one event, the event for which the event logging system created the aggregate event.
Object	info() Gets the info from any member of the EOvents set aggregated by the receiver.
String	signatureOfType(int tag) Used to group and aggregate the receiver with other events that have the same signature.
NSArray	subevents() For each EOEvent aggregated in the reciver this method gathers their subevents and return an array with them.The array is ordered ascending by duration.
String	title() Gets the title from any member of the EOvents set aggregated by the receiver.

Methods inherited from class com.webobjects.eocontrol.EOEvent

aggregateEvents, classDescription, compare, duration, eventTypeDescriptions, groupEvents, markAtomicWithInfo, markEnd, markStartWithInfo, parentEvent, setInfo, setType, startDate, toString, type

Methods inherited from class java.lang.Object

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

Constructor Detail

EOAggregateEvent

public EOAggregateEvent()

Method Detail

addEvent

public void addEvent(EOEvent e)

Adds e to the set of events that the receiver aggregates.

Parameters:

e - the EOEvent to be added to the receiver

comment

public String comment()

Gets the comment from any member of the EOvents set aggregated by the receiver.

Overrides:

comment in class EOEvent

Returns:

String representation of receiver's info

See Also:

EOEvent.comment()

description

public String description()

Gets the description of the family of events represented by the class.

Overrides:

description in class EOEvent

Returns:

the events aggregated by the reciver plus the description of the family of events represented by the class

See Also:

EOEvent.eventTypeDescriptions(Class aClass), EOEvent.description()

displayComponentName

public String displayComponentName()

Description copied from class: EOEvent

Returns the name of a WebObjects component to use to display the receiver's logging information. EOEvent's implementation uses the WOEventRow component, which is generally sufficient for subclasses.

Overrides:

displayComponentName in class EOEvent

Returns:

a String representing the name of WebObjects component to use in displaying the receiver's. The implementation of this method on EOAggregateEvent returns "WOAggregateEventRow"

durationWithoutSubevents

public long durationWithoutSubevents()

Gets the the sum of all of the aggregated events'durations excluding the receivers subevents.

Overrides:

durationWithoutSubevents in class EOEvent

Returns:

duration of receiver, in milliseconds, excluding subevents

events

public NSArray events()

Typically, an EOAggregateEvent has at least one event, the event for which the event logging system created the aggregate event.

Returns:

an array of events that the receiver aggregates

info

public Object info()

Gets the info from any member of the EOvents set aggregated by the receiver.

Overrides:

info in class EOEvent

Returns:

String representation of the customized info of the receiver

See Also:

EOEvent.info()

signatureOfType

public String signatureOfType(int tag)

Used to group and aggregate the receiver with other events that have the same signature. EOEvent defines one signature type, EOBasicEventSignature, which has the corresponding signature of the form, "title comment". If the specified signature type is unknown, EOEvent's implementation returns null.

Overrides:

signatureOfType in class EOEvent

Parameters:

tag - specifies signature type

Returns:

requested receiver's signature

See Also:

EOEvent.aggregateEvents(NSArray events,int tag), EOEvent.groupEvents(NSArray events,int tag)

subevents

public NSArray subevents()

For each EOEvent aggregated in the reciver this method gathers their subevents and return an array with them.The array is ordered ascending by duration.

Overrides:

subevents in class EOEvent

Returns:

an NSArray containg all the subevents for each EOEvent aggregated by the receiver

See Also:

EOEvent.subevents()

title

public String title()

Gets the title from any member of the EOvents set aggregated by the receiver.

Overrides:

title in class EOEvent

Returns:

a String representing the event type description corresponding to the receiver's type

See Also:

EOEvent.eventTypeDescriptions(Class aClass), EOEvent.title()