com.sapportals.wcm.util.events

Class AbstractEventMapper

java.lang.Object
  com.sapportals.wcm.util.events.AbstractEventMapper

All Implemented Interfaces:

IEventMapper

Direct Known Subclasses:

AbstractResourceEventMapper

public abstract class AbstractEventMapper

extends Object

implements IEventMapper

A base class to derive event mapper implementations.

Copyright (c) SAP AG 2001-2002

See Also:

IEventMapper

Field Summary

protected static String	CONFIG_NAME_TAG
protected String	m_ID The system id for this mapper.
protected Properties	m_Properties The properties for this mapper.

Constructor Summary

protected

AbstractEventMapper(String id, Properties properties) Create a mapper with a specific id from the given properties.

Method Summary

String	getDescription() Get the mapper's displayable name.
String	getDescription(Locale locale) Get the mapper's displayable name for a specific locale.
IEventList	getEvents(IEventBroker broker) Get a list of available mapped events for a given broker.
String	getID() Get the mapper's unique system id.
abstract IEvent	map(IEvent event) Map an IEvent to another IEvent .

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_NAME_TAG

protected static final String CONFIG_NAME_TAG

See Also:

Constant Field Values

m_ID

protected String m_ID

The system id for this mapper.

m_Properties

protected Properties m_Properties

The properties for this mapper.

Constructor Detail

AbstractEventMapper

protected AbstractEventMapper(String id,
                              Properties properties)
                       throws WcmException

Create a mapper with a specific id from the given properties.

Parameters:

id - TBD: Description of the incoming method parameter

properties - TBD: Description of the incoming method parameter

Throws:

WcmException - Exception raised in failure situation

Method Detail

getID

public String getID()

Description copied from interface: IEventMapper

Get the mapper's unique system id.

Specified by:

getID in interface IEventMapper

Returns:

a String with the mapper's system id.

getDescription

public String getDescription()

Description copied from interface: IEventMapper

Get the mapper's displayable name.

Specified by:

getDescription in interface IEventMapper

Returns:

a String with the mapper's displayable name.

getDescription

public String getDescription(Locale locale)

Description copied from interface: IEventMapper

Get the mapper's displayable name for a specific locale.

Specified by:

getDescription in interface IEventMapper

Parameters:

locale - a Locale defining the language to get the name for.

Returns:

a String with the mapper's displayable name in the given locale.

map

public abstract IEvent map(IEvent event)

Description copied from interface: IEventMapper

Map an IEvent to another IEvent .
Note : It's a good idea, to pass the original (unmapped) event as the mapped event's parameter.

Specified by:

map in interface IEventMapper

Parameters:

event - the IEvent to map.

Returns:

the mapped IEvent corresponding to the given event or null , if the event is to be ignored (not mapped).

getEvents

public IEventList getEvents(IEventBroker broker)

Description copied from interface: IEventMapper

Get a list of available mapped events for a given broker.

Specified by:

getEvents in interface IEventMapper

Parameters:

broker - the IEventBroker to get the supported events for.

Returns:

the IEventList with all available mapped events.