01: /*
02: * Copyright 2001-2007 Geert Bevin <gbevin[remove] at uwyn dot com>
03: * Distributed under the terms of either:
04: * - the common development and distribution license (CDDL), v1.0; or
05: * - the GNU Lesser General Public License, v2.1 or later
06: * $Id: EntryProvider.java 3634 2007-01-08 21:42:24Z gbevin $
07: */
08: package com.uwyn.rife.feed;
09:
10: import com.uwyn.rife.engine.ElementSupport;
11: import com.uwyn.rife.feed.Feed;
12:
13: /**
14: * An <code>EntryProvider</code> is a way to get entries for a feed.
15: *
16: * @author JR Boyens (jboyens[remove] at uwyn dot com)
17: * @author Geert Bevin (gbevin[remove] at uwyn dot com)
18: * @version $Revision: 3634 $
19: * @see Feed
20: * @since 1.0
21: */
22: public interface EntryProvider {
23: /**
24: * Get a bean describing the <code>Feed</code> being outputted.
25: *
26: * @param element the context for this EntryProvider
27: * @return Feed a bean describing the feed currently being outputted
28: * @see Feed
29: * @since 1.0
30: */
31: public Feed getFeedDescriptor(ElementSupport element);
32:
33: /**
34: * Provide entries using {@link EntryProcessor#setEntry(Entry)} to set
35: * each entry to the feed
36: *
37: * @param element the context for this EntryProvider
38: * @param processor the processor creating this feed
39: * @see EntryProcessor
40: * @since 1.0
41: */
42: public void provideEntries(ElementSupport element,
43: EntryProcessor processor);
44: }
|