dekoh.portal.syndication.aggregator.core
Interface AggregatedItemTransformer

All Known Implementing Classes:

AggregatedItemTransformer.Adapter, SummarizingTransformer

public interface AggregatedItemTransformer

AggregatedItemTransformer is an interface for Aggregator users who wish to modify/transform a feed entry before it becomes part of aggregation.

Some of the use cases will be if one wants to summarize the aggregated feed, Add a image for the feed or would filter out some feed-items(event summaries) from aggregation.

Since:

Oct 9, 2007

Nested Class Summary

static class	AggregatedItemTransformer.Adapter Implementations of the AggregatedItemTransformer can extend this class to override only specific methods.
static class	AggregatedItemTransformer.TransformationContext

Method Summary

void	begin(AggregatedItemTransformer.TransformationContext context) begin() method will signal to the transformer implementations of 'begin' of stream of feed-items(event summaries) downloaded for a perticular SubscriptionItem.
void	end(AggregatedItemTransformer.TransformationContext context) Signals the end of stream of feed-items (event summaries) from a perticular SubscriptionItem.
boolean	transform(AggregatedItemTransformer.TransformationContext context, Item rssFeedItem)

Method Detail

begin

void begin(AggregatedItemTransformer.TransformationContext context)

begin() method will signal to the transformer implementations of 'begin' of stream of feed-items(event summaries) downloaded for a perticular SubscriptionItem.

Until end() method is called, all the Items being transformed are downloaded from the same source.

Parameters:

context -

transform

boolean transform(AggregatedItemTransformer.TransformationContext context,
                  Item rssFeedItem)

Parameters:

context -

rssFeedItem -

Returns:

value of false will indicate that this item will not be made part of aggregation;

end

void end(AggregatedItemTransformer.TransformationContext context)

Signals the end of stream of feed-items (event summaries) from a perticular SubscriptionItem.

Parameters:

context -