org.apache.cocoon.portal.event
Interface EventConverter

All Known Implementing Classes:
DefaultEventConverter, PageLabelEventConverter

public interface EventConverter

This component converts Event objects from and into strings. If the event is a ConvertableEvent the event itself does the converting, if not it's up to the implementation of this component to do the conversion.

Version:
$Id: EventConverter.java 327143 2005-10-21 10:12:49Z cziegeler $

Field Summary
static String ROLE
           
 
Method Summary
 Event decode(String value)
          Decode an event.
 String encode(Event event)
          Encode an event.
 void finish()
          This notifies the converter that an event processing phase ends.
 void start()
          This notifies the converter that a new event processing phase starts.
 

Field Detail

ROLE

public static final String ROLE
Method Detail

encode

public String encode(Event event)
Encode an event. This is used to "activate" events using a link

Parameters:
event - The event to encode
Returns:
A unique string representation for this event

decode

public Event decode(String value)
Decode an event. This is used to "activate" events using a link

Parameters:
value - The string representation created using encode(Event)
Returns:
The event or null

start

public void start()
This notifies the converter that a new event processing phase starts.


finish

public void finish()
This notifies the converter that an event processing phase ends.



Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.