com.neurosys.notification.service

Class UserNotificationGenerator<M>

java.lang.Object

com.neurosys.notification.service.UserNotificationGenerator<M>

All Implemented Interfaces:

org.apache.commons.collections.Transformer

public class UserNotificationGenerator<M>
extends Object
implements org.apache.commons.collections.Transformer

For a given input criteria generate a Collection of UserNotifications

Author:

Arjun Dhar TODO: Add unit test case

See Also:

#createNotification(Object)}

Constructor Summary

Constructors

Constructor and Description
UserNotificationGenerator()

Method Summary

Modifier and Type	Method and Description
protected UserNotification<M>	createNotification(Object m) The input can be a Single Object or a Collection of Objects. If the input element is a List or Array, {count String, message Object, recipient, status, severity, tags} ..
org.apache.commons.collections.Transformer	getSource() A Transformer that takes in the input and generates a raw Collection of M of Data or a Message Object
UserNotification<M>	getTemplate() A template to Construct Notification messages from
boolean	isReturnMultiple() If true and the input is a Collection then each element in the input Collection is a candidate for a separate UserNotification
void	setReturnMultiple(boolean returnMultiple) If true and the input is a Collection then each element in the input Collection is a candidate for a separate UserNotification
void	setSource(org.apache.commons.collections.Transformer source) A Transformer that takes in the input and generates a raw Collection of M of Data or a Message Object
void	setTemplate(UserNotification<M> template) A template to Construct Notification messages from
Object	transform(Object input) Use the source to convert the input into a List of UserNotifications using template as a template to fill the rest of the Notification related Data If the input is a single entity then 1 UserNotification is returned else a Collection of UserNotifications

Methods inherited from class java.lang.Object

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

Constructor Detail

UserNotificationGenerator

public UserNotificationGenerator()

Method Detail

createNotification

protected UserNotification<M> createNotification(Object m)
                                          throws Exception

The input can be a Single Object or a Collection of Objects.
If the input element is a List or Array, {count String, message Object, recipient, status, severity, tags} .. rest ignored.

Additionally, if a template Message is provided, template.getMessage() is not null then it will set that in the resultant notification object.
One can substitute the dynamic message in the template message String using a variable ${0}, ${1} .. etc denoting the element to substitute from the raw input List or Array. Incase of a single entity as input $0 will represent the input itself.

Parameters:

m - as Raw payload

Returns:

UserNotification

Throws:

Exception

transform

public Object transform(Object input)

Use the source to convert the input into a List of UserNotifications using template as a template to fill the rest of the Notification related Data
If the input is a single entity then 1 UserNotification is returned else a Collection of UserNotifications

Specified by:

transform in interface org.apache.commons.collections.Transformer

Returns:

UserNotification or Collection of UserNotifications

isReturnMultiple

public boolean isReturnMultiple()

If true and the input is a Collection then each element in the input Collection is a candidate for a separate UserNotification

Default value:

false

setReturnMultiple

public void setReturnMultiple(boolean returnMultiple)

If true and the input is a Collection then each element in the input Collection is a candidate for a separate UserNotification

Default value:

false

getSource

public org.apache.commons.collections.Transformer getSource()

A Transformer that takes in the input and generates a raw Collection of M of Data or a Message Object

Can be null:

true

setSource

public void setSource(org.apache.commons.collections.Transformer source)

A Transformer that takes in the input and generates a raw Collection of M of Data or a Message Object

Can be null:

true

getTemplate

public UserNotification<M> getTemplate()

A template to Construct Notification messages from

setTemplate

public void setTemplate(UserNotification<M> template)

A template to Construct Notification messages from