com.tivoli.zce.actions.libs
Class TECSummary

java.lang.Object
  |
  +--com.tivoli.zce.actions.DefaultActionHandler
        |
        +--com.tivoli.zce.actions.libs.TECSummary
All Implemented Interfaces:
IAction, com.tivoli.zce.IEventProcessor, com.tivoli.zce.IEventSender

public class TECSummary
extends DefaultActionHandler

An example action object that summarizes a given list of events, reconstructs a new event and forwards it to TEC. This object includes the methods for processing the event list as well as the parse plug-in for parsing the action arguments (SET and IGNORE).


Fields inherited from class com.tivoli.zce.actions.DefaultActionHandler
aloneEventProcessor, aloneEventProcessorId, eventProcessors
 
Fields inherited from interface com.tivoli.zce.IEventProcessor
IBM_Copyright
 
Fields inherited from interface com.tivoli.zce.IEventSender
IBM_Copyright
 
Constructor Summary
TECSummary()
           
 
Method Summary
 java.lang.Object doParse(IRule rule, java.lang.String paramSz)
          doParse method perform the parsing of the action part, it can throw Exception, but this exception will be convert in ParseException @see com.tivoli.correlator.parser.ParserException
 void processEvent(Event event)
          doAction method perform a summary function on a single event as described in doAction(EventList)
 void processEvents(EventList elist)
          doAction method performs the summary function as specified below: The summary event which is forwarded at the end of the state machine has the same attribute (slot) values as the last matching event, except for the following: (1) All attributes in the Ignore Attribute List are assigned no value and are not forwarded.
 java.lang.String toString()
           
 
Methods inherited from class com.tivoli.zce.actions.DefaultActionHandler
addEventProcessor, banner, forward, forward, getEventProcessor, IBM_Copyright, removeEventProcessor
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TECSummary

public TECSummary()
Method Detail

processEvents

public void processEvents(EventList elist)
                   throws java.lang.Exception
doAction method performs the summary function as specified below: The summary event which is forwarded at the end of the state machine has the same attribute (slot) values as the last matching event, except for the following: (1) All attributes in the Ignore Attribute List are assigned no value and are not forwarded. (2) All attributes in the Set Attribute List are assigned the values specified by the rule. (3) Core event attribute repeat_count is assigned the value of the length of the eventList.
Parameters:
elist - Eventlist, the list of matching events sent from the correlation engine

processEvent

public void processEvent(Event event)
                  throws java.lang.Exception
doAction method perform a summary function on a single event as described in doAction(EventList)
Following copied from interface: com.tivoli.zce.IEventProcessor
Parameters:
event - - event that cause the fire from the correlator

doParse

public java.lang.Object doParse(IRule rule,
                                java.lang.String paramSz)
                         throws ParserException
doParse method perform the parsing of the action part, it can throw Exception, but this exception will be convert in ParseException @see com.tivoli.correlator.parser.ParserException

example of syntax: SET:msg=

Following copied from interface: com.tivoli.zce.actions.IAction
Parameters:
rule - the rule to which this action is attached to
actionString - the String representing the parameters for initializing this action.
Returns:
the action itself
Throws:
com.tivoli.zce.CorrelatorException - exception thrown when the parsing of parameters is not successfull. The handling and the raising of exception is determined by the developer of actions.

toString

public java.lang.String toString()
Overrides:
toString in class DefaultActionHandler
Following copied from class: com.tivoli.zce.actions.DefaultActionHandler
See Also:
Object.toString()