WOEvent

Inherits from:
EOEvent : Object

Package:
com.webobjects.appserver

Class Description

WOEvent is a subclass of EOEvent (defined in the EOControl framework) that serves as the parent class for objects that gather information-such as duration-about various operations in WebObjects. You can see the results of this information gathering in your web browser by accessing a special "event display" page, and you can configure how the results are displayed by accessing a special "event setup" page. Both of these are accessed through special direct actions (WOEventDisplay and WOEventSetup, respectively). For example, if you've been running the ComponentElementsTour, the following URL will access the event display page:

http://localhost/cgi-bin/WebObjects/ComponentElementsTour.woa/wa/WOEventDisplay

WOEvent adds knowledge of pages and components to the EOEvent class. Events that are subclasses of WOEvent can be grouped or aggregated by page or by component. Although you can subclass WOEvent, in most cases the following private subclasses will be adequate for analyzing WebObjects applications:

Event Group	Logged Events
WOApplication Event	pageWithName
WOAssociation Event	valueForKeyPath, takeValueForKeyPath
WOComponent Event	takeValuesFromRequest, invokeAction, appendToResponse, awake, sleep
WOComponentReference Event	pushComponent

Constants

Constant	Description
`AssociationSignature`	Description forthcoming.
`ComponentSignature`	Description forthcoming.
`PageSignature`	Description forthcoming.

Constructors

WOEvent

public WOEvent()

Description forthcoming.

Instance Methods

comment

public String comment()

In the default implementation, this method returns the description of the "info" instance variable which is passed at log time. This method can be overridden by subclasses to provide information for the event display.

setComponentName

public void setComponentName(String componentName)

Sets the event's component name to componentName. Event data can be grouped or aggregated according to the component name.

setPageName

public void setPageName(String pageName)

Sets the event's page name to pageName. Event data can be grouped or aggregated according to the page name.

signatureOfType

public String signatureOfType(int type)

Returns a "signature" for the receiver of the specified type. These signatures are used to group or aggregate data on the WOEventDisplay page. WOEvent is able to generate signatures for the following types:

Type	Signature
EOBasicEventSignature	A combination of the event's type and the component name
WOComponentSignature	The component name
WOPageSignature	The page name
WOAssociationSignature	varies based upon the context

Override this method if you are creating a custom subclass of WOEvent and need to provide signatures for additional event types.

title

public String title()

The default implementation of this method returns the "title" value from the EventTypeDescriptions dictionary. This method is required for proper functioning of the event logging display.

toString

public String toString()

Returns a String containing a string representation of the receiver.