org.hawkular.btm.server.api.task

Interface Processor<T,R>

All Known Implementing Classes:

AbstractProcessor

public interface Processor<T,R>

This interface represents a processor.

Author:

gbrown

Method Summary

Modifier and Type	Method and Description
void	cleanup(String tenantId, List<T> items) This method is called once all of the items in the list of been processed to generate new information.
void	initialise(String tenantId, List<T> items) This method enables the processor to perform some initialisation tasks before processing the items individually to generate new information.
boolean	isMultiple() This method determines whether the processor results in multiple results per item.
List<R>	processMultiple(String tenantId, T item) This method processes the supplied item to generate zero or more resulting values.
R	processSingle(String tenantId, T item) This method processes the supplied item to optionally generated a new resulting value.

Method Detail

initialise

void initialise(String tenantId,
                List<T> items)

This method enables the processor to perform some initialisation tasks before processing the items individually to generate new information.

Parameters:

tenantId - The optional tenant id

items -

isMultiple

boolean isMultiple()

This method determines whether the processor results in multiple results per item.

Returns:

processSingle

R processSingle(String tenantId,
                T item)
         throws Exception

This method processes the supplied item to optionally generated a new resulting value.

Parameters:

tenantId - The optional tenant id

item - The item

Returns:

The optional value

Throws:

Exception - Failed to process the item

processMultiple

List<R> processMultiple(String tenantId,
                        T item)
                 throws Exception

This method processes the supplied item to generate zero or more resulting values.

Parameters:

tenantId - The optional tenant id

item - The item

Returns:

The list of values

Throws:

Exception - Failed to process the item

cleanup

void cleanup(String tenantId,
             List<T> items)

This method is called once all of the items in the list of been processed to generate new information. It can be used to clean up any information managed by the processor related to those items. Generally the processor should not store any state outside the processing of the individual items.

Parameters:

tenantId - The optional tenant id

items -