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: EntryProcessor.java 3634 2007-01-08 21:42:24Z gbevin $
07: */
08: package com.uwyn.rife.feed;
09:
10: import com.uwyn.rife.feed.Entry;
11:
12: /**
13: * An <code>EntryProcessor</code> is a class that knows how to create a section of a feed
14: * for output.
15: * <p>This interface is generally implemented by an <code>Element</code> which then passes
16: * itself into an <code>EntryProvider</code> to allow the <code>EntryProvider</fcode> to stream results
17: * straight into the feed instead of dumping a large collection.</p>
18: *
19: * @author JR Boyens (jboyens[remove] at uwyn dot com)
20: * @author Geert Bevin (gbevin[remove] at uwyn dot com)
21: * @version $Revision: 3634 $
22: * @see com.uwyn.rife.feed.EntryProvider
23: * @see com.uwyn.rife.engine.Element
24: * @since 1.0
25: */
26: public interface EntryProcessor {
27: /**
28: * Sets an entry to the feed being constructed.
29: * <p>Generally called by an <code>EntryProvider</code> while streaming results from the
30: * DB to the feed provider/outputter.
31: *
32: * @param entry the Entry to be written to the feed
33: * @see Entry
34: * @see EntryProvider
35: * @since 1.0
36: */
37: public void setEntry(Entry entry);
38: }
|