com.sapportals.wcm.repository.manager

Class AbstractResourceEventMapper

java.lang.Object

com.sapportals.wcm.util.events.AbstractEventMapper

com.sapportals.wcm.repository.manager.AbstractResourceEventMapper

All Implemented Interfaces:

IResourceEventMapper, IEventMapper

public abstract class AbstractResourceEventMapper
extends AbstractEventMapper
implements IResourceEventMapper

A base class to derive resource event mapper implementations.

Copyright 2004 SAP AG

Field Summary

Fields inherited from class com.sapportals.wcm.util.events.AbstractEventMapper

CONFIG_NAME_TAG, m_ID, m_Properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractResourceEventMapper(String id, Properties properties) Create a mapper with a specific id from the given properties.

Method Summary

Modifier and Type	Method and Description
IEventList	getEvents(IResourceEventBroker broker, IResource resource) Get a list of available mapped resource events for a given broker.
IEvent	map(IEvent event) Map an IEvent to another IEvent .
abstract IResourceEvent	map(IResourceEvent event) Map an IResourceEvent to another IResourceEvent .

Methods inherited from class com.sapportals.wcm.util.events.AbstractEventMapper

getDescription, getDescription, getEvents, getID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sapportals.wcm.util.events.IEventMapper

getDescription, getDescription, getEvents, getID

Constructor Detail

AbstractResourceEventMapper

protected AbstractResourceEventMapper(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

map

public 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

Specified by:

map in class AbstractEventMapper

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).

map

public abstract IResourceEvent map(IResourceEvent event)

Description copied from interface: IResourceEventMapper

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

Specified by:

map in interface IResourceEventMapper

Parameters:

event - the IResourceEvent to map.

Returns:

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

getEvents

public IEventList getEvents(IResourceEventBroker broker,
                            IResource resource)

Description copied from interface: IResourceEventMapper

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

Specified by:

getEvents in interface IResourceEventMapper

Parameters:

broker - the IResourceEventBroker to get the supported resource events for.

resource - the IResource with the template to get the events for.

Returns:

the IResource EventList with all available mapped resource events.