dekoh.portal.syndication.aggregator.core
Class AggregatorWrapper

java.lang.Object
  dekoh.portal.syndication.aggregator.core.AggregatorWrapper

All Implemented Interfaces:

Aggregator

public class AggregatorWrapper
extends Object
implements Aggregator

Since:

Oct 16, 2007

Constructor Summary

AggregatorWrapper(Aggregator aggregator)

Method Summary

void	addAggregatedItemTransformer(AggregatedItemTransformer[] transformers)
void	destroy() Stops the scheduler if started , and if required cleans up the aggregated files and all the individual feeds that has been downloaded by the aggregator
List	getAggregatedItemTransformers()
File	getAggregatedRSSFeedXml()
Aggregator	getAggregator()
String	getId()
File	getItemRSSFeedXml(String itemId) The location of the file where the downloaded subscription item feed will be available.
long	getLastAggregatedTime()
long	getLastModifiedTime()
int	getMaxItemsToAggregate()
long	getSchedulerFrequency()
SubscriptionList	getSubscriptionList()
boolean	isScheduled()
void	scheduleAggregation() Triggers a periodic aggregation that becomes enabled now, and subsequently repeats itself after a frequency.Implementatin can chose to have a defualt frequency or take in the the constructor Generally this will be a one time call, However it can be used to start aggregation "now", to check for latest feeds
void	scheduleAggregation(long frequency) Triggers a periodic aggregation that becomes enabled now, and subsequently repeats itself after the specified frequency.
void	setMaxItemsToAggregate(int maxItemsToAggregate)
void	stopScheduler() Stops the scheduling of aggregator.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregatorWrapper

public AggregatorWrapper(Aggregator aggregator)

Method Detail

getAggregatedItemTransformers

public List getAggregatedItemTransformers()

Specified by:

getAggregatedItemTransformers in interface Aggregator

Returns:

the transformer which will be given a callback before a new feed entry is made part of aggregated item

getMaxItemsToAggregate

public int getMaxItemsToAggregate()

Specified by:

getMaxItemsToAggregate in interface Aggregator

Returns:

maximum feed entries that will be part of aggregation

destroy

public void destroy()

Description copied from interface: Aggregator

Stops the scheduler if started , and if required cleans up the aggregated files and all the individual feeds that has been downloaded by the aggregator

Specified by:

destroy in interface Aggregator

getAggregatedRSSFeedXml

public File getAggregatedRSSFeedXml()

Specified by:

getAggregatedRSSFeedXml in interface Aggregator

Returns:

the file representing aggregated feed

getItemRSSFeedXml

public File getItemRSSFeedXml(String itemId)

Description copied from interface: Aggregator

The location of the file where the downloaded subscription item feed will be available. This can be used if the applications desire to display each individual feeds

Specified by:

getItemRSSFeedXml in interface Aggregator

Parameters:

itemId - id of a subscription item in the list

Returns:

the downloaded feed for the subscription item

getId

public String getId()

Specified by:

getId in interface Aggregator

Returns:

An id which can be used to find this aggregator instance

getLastAggregatedTime

public long getLastAggregatedTime()

Specified by:

getLastAggregatedTime in interface Aggregator

Returns:

time in milliseconds when the aggragation las happened

getLastModifiedTime

public long getLastModifiedTime()

Specified by:

getLastModifiedTime in interface Aggregator

Returns:

time in millisecond when the aggregated feed was las modified

getSubscriptionList

public SubscriptionList getSubscriptionList()

Specified by:

getSubscriptionList in interface Aggregator

Returns:

SubscriptionList which is scheduked for aggregation

addAggregatedItemTransformer

public void addAggregatedItemTransformer(AggregatedItemTransformer[] transformers)

Specified by:

addAggregatedItemTransformer in interface Aggregator

Parameters:

transformers - which will be given a callback before a new feed entry is made part of aggregated item

setMaxItemsToAggregate

public void setMaxItemsToAggregate(int maxItemsToAggregate)

Specified by:

setMaxItemsToAggregate in interface Aggregator

Parameters:

maxItemsToAggregate - maximum items that will be aggregated byu this aggregater. Aggregators may choose a policy to remove items from the aggregated feed if the total no of aggregated items exceeds this limit.

scheduleAggregation

public void scheduleAggregation()

Description copied from interface: Aggregator

Triggers a periodic aggregation that becomes enabled now, and subsequently repeats itself after a frequency.Implementatin can chose to have a defualt frequency or take in the the constructor

Generally this will be a one time call, However it can be used to start aggregation "now", to check for latest feeds

Specified by:

scheduleAggregation in interface Aggregator

See Also:

Aggregator.scheduleAggregation(long)

scheduleAggregation

public void scheduleAggregation(long frequency)

Description copied from interface: Aggregator

Triggers a periodic aggregation that becomes enabled now, and subsequently repeats itself after the specified frequency.

Generally this will be a one time call, However it can be used to reschedule the aggregation with a different frequency, or to wake up the aggregator from sleep and start aggrating now. After this is called any calls to scheduleAggregation() should happen with this new frequency

Specified by:

scheduleAggregation in interface Aggregator

Parameters:

frequency - frequency with which aggregation will happen

stopScheduler

public void stopScheduler()

Description copied from interface: Aggregator

Stops the scheduling of aggregator. The subscription items in the list will not be downloaded and aggregated any more

Specified by:

stopScheduler in interface Aggregator

See Also:

Aggregator.scheduleAggregation(long)

isScheduled

public boolean isScheduled()

Specified by:

isScheduled in interface Aggregator

Returns:

true if the aggregator is scheduled
false if aggregator was never scheduled or is stopped

getSchedulerFrequency

public long getSchedulerFrequency()

Specified by:

getSchedulerFrequency in interface Aggregator

Returns:

frequency in milliseconds at which the aggregator is scheduled, value of zero indicate that the aggregator was never scheduled or is stopeed.

getAggregator

public Aggregator getAggregator()