com.sapportals.wcm.util.events
Class AbstractEventMapper

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.framework_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.util.events.AbstractEventMapper

All Implemented Interfaces:

IEventMapper

Direct Known Subclasses:

AbstractResourceEventMapper

public abstract class AbstractEventMapper

extends java.lang.Object

implements IEventMapper

A base class to derive event mapper implementations.

Copyright (c) SAP AG 2001-2002

See Also:

IEventMapper

Field Summary

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

Constructor Summary

protected

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

Method Summary

java.lang.String	getDescription() Get the mapper's displayable name.
java.lang.String	getDescription(java.util.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.
java.lang.String	getID() Get the mapper's unique system id.
abstract IEvent	map(IEvent event) Map an IEvent to another IEvent . Note : It's a good idea, to pass the original (unmapped) event as the mapped event's parameter.

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 java.lang.String CONFIG_NAME_TAG

m_ID

protected java.lang.String m_ID

The system id for this mapper.

m_Properties

protected java.util.Properties m_Properties

The properties for this mapper.

Constructor Detail

AbstractEventMapper

protected AbstractEventMapper(java.lang.String id,
                              java.util.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 java.lang.String getID()

Description copied from interface: IEventMapper

Get the mapper's unique system id.

Specified by:

getID in interface IEventMapper

Following copied from interface: com.sapportals.wcm.util.events.IEventMapper

Returns:

a String with the mapper's system id.

getDescription

public java.lang.String getDescription()

Description copied from interface: IEventMapper

Get the mapper's displayable name.

Specified by:

getDescription in interface IEventMapper

Following copied from interface: com.sapportals.wcm.util.events.IEventMapper

Returns:

a String with the mapper's displayable name.

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Description copied from interface: IEventMapper

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

Specified by:

getDescription in interface IEventMapper

Following copied from interface: com.sapportals.wcm.util.events.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

Following copied from interface: com.sapportals.wcm.util.events.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

Following copied from interface: com.sapportals.wcm.util.events.IEventMapper

Parameters:

broker - the IEventBroker to get the supported events for.

Returns:

the IEventList with all available mapped events.