com.sap.netweaver.bc.rf.util.event
Class AbstractEventMapper

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

java.lang.Object
  |
  +--com.sap.netweaver.bc.rf.util.event.AbstractEventMapper

All Implemented Interfaces:

IEventMapper

public abstract class AbstractEventMapper

extends java.lang.Object

implements IEventMapper

Abstract base class implementation of an event mapper.

See Also:

IEventMapper

Field Summary

protected static java.lang.String	CONFIG_NAME_TAG
protected java.lang.String	m_ID
protected java.util.Properties	m_Properties

Constructor Summary

protected

AbstractEventMapper(java.lang.String id, java.util.Properties properties) Create a mapper with a specific id and the given custom 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 localized displayable name.
IEventList	getEvents(IEventBroker broker) Returns a list of mapped event templates for all possible events this mapper can send.
java.lang.String	getID() Get the mapper's unique system id.
abstract IEvent	map(IEvent event) Map or transform an event prior to sending it to the receiver from one kind to another which then is sent to the receiver.

Methods inherited from class java.lang.Object

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

Field Detail

m_ID

protected java.lang.String m_ID

m_Properties

protected java.util.Properties m_Properties

CONFIG_NAME_TAG

protected static final java.lang.String CONFIG_NAME_TAG

Constructor Detail

AbstractEventMapper

protected AbstractEventMapper(java.lang.String id,
                              java.util.Properties properties)
                       throws BaseException

Create a mapper with a specific id and the given custom properties.

Parameters:

id - id

properties - properties

Throws:

BaseException - Exception raised in failure situation

Method Detail

getID

public java.lang.String getID()

Get the mapper's unique system id.

Specified by:

getID in interface IEventMapper

Returns:

mapper's unique system id

getDescription

public java.lang.String getDescription()

Get the mapper's displayable name.

Specified by:

getDescription in interface IEventMapper

Returns:

mapper's displayable name

getDescription

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

Get the mapper's localized displayable name.

Specified by:

getDescription in interface IEventMapper

Parameters:

locale - locale

Returns:

mapper's localized displayable name

map

public abstract IEvent map(IEvent event)

Map or transform an event prior to sending it to the receiver from one kind to another which then is sent to the receiver. It might be a good idea to put the orginal event in the user defined parameter of the new mapped and sent event.

Specified by:

map in interface IEventMapper

Parameters:

event - event to be mapped

Returns:

mapped event

getEvents

public IEventList getEvents(IEventBroker broker)

Returns a list of mapped event templates for all possible events this mapper can send. The event instances contained in the list are "templates", that means the event parameter is not relevant. An implementation of this method should call the broker and ask it to call all its senders to get the list of all possible event templates which can possibly be handed over to a mapper/receiver. Then the mapper should check, which of these event templates are supported and can be mapped and should return these mapped event templates in a list.

Specified by:

getEvents in interface IEventMapper

Parameters:

broker - broker to be asked for all possible events of all of its senders

Returns:

list of event templates for all possible events this mapper can return in conjunction with the broker