##### Rome

- Overview
- How Rome Works
  - Read a syndication feed
  - Create and write a syndication feed
  - Convert a syndication feed
  - Aggregate many syndication feeds
  - Common classes and interfaces
  - Defining a Custom Module
- Tutorials And Articles
- Releases
- ROME Development Proposals

##### Project Documentation

- Project Information
- Project Reports

## Rome v0.4 Tutorial, Using Rome to aggregate many syndication feeds into a single one

Software requirements: J2SE 1.4+, JDOM 1.0 and Rome 0.4.

Rome represents syndication feeds (RSS and Atom) as instances of the com.sun.syndication.synd.SyndFeed interface. The SyndFeed interfaces and its properties follow the Java Bean patterns. The default implementations provided with Rome are all lightweight classes.

Rome includes parsers to process syndication feeds into SyndFeed instances. The SyndFeedInput class handles the parsers using the correct one based on the syndication feed being processed. The developer does not need to worry about selecting the right parser for a syndication feed, the SyndFeedInput will take care of it by peeking at the syndication feed structure. All it takes to read a syndication feed using Rome are the following 2 lines of code:

    SyndFeedInput input = new SyndFeedInput();
    SyndFeed feed = input.build(new XmlReader(feedUrl));

The first line creates a SyndFeedInput instance that will work with any syndication feed type (RSS and Atom versions). The second line instructs the SyndFeedInput to read the syndication feed from the InputStream of a URL pointing to the feed. The XmlReader is a character based Reader that resolves the encoding following the HTTP MIME types and XML rules for it. The SyndFeedInput.build() method returns a SyndFeed instance that can be easily processed.

Rome also includes generators to create syndication feeds out of SyndFeed instances. The SyndFeedOutput class does this generation. The SyndFeedOutput will generate a syndication feed of the feed type indicated by the SyndFeed object being output. The following two lines of code show how to create a syndication feed output from a SyndFeed instance:

    SyndFeedOutput output = new SyndFeedOutput();
    output.output(feed,new PrintWriter(System.out));

The first line creates a SyndFeedOutput instance that will produce syndication feeds. It can output feeds of any type (rss_0.9, rss_0.91, rss_0.92, rss_0.93, rss_0.94, rss_1.0, rss_2.0 & atom_0.3), the SyndFeed feedType property indicates the type. The second line writes the SyndFeed as a syndication feed into the application's output.

SyndFeed instances can also be created and populated within the code. For example:

    SyndFeed aggrFeed = new SyndFeedImpl();
    aggrFeed.setFeedType("rss_1.0");
    aggrFeed.setTitle("Aggregated Feed");
    aggrFeed.setDescription("Anonymous Aggregated Feed");
    aggrFeed.setAuthor("anonymous");
    aggrFeed.setLink("http://www.anonymous.com");

The snipped of code above creates a SyndFeed instance using the default implementation provided by Rome, sets the feed type to RSS 1.0, sets the title, description, author and link properties of the feed.

SyndFeed properties can be modified, assigned to other SyndFeed instances, removed, etc. It's important to remember that the getters/setters semantics defined for all SyndFeed properties (and properties of its properties) is a copy by reference, not by value. In other words if you alter the property of a SyndFeed property you are altering the SyndFeed. Or, another example, if you assign the list of entries of one SyndFeed instance to another SyndFeed isntance and then you modify the list or any of the entries in the list, you are modifying the entries of both SyndFeed instances.

The following lines of code show how to copy the entries of a SyndFeed instance being read (inFeed) into a SyndFeed instance being created within the application (feed):

    package com.sun.syndication.samples;

    import java.net.URL;
    import java.io.InputStreamReader;
    import java.io.PrintWriter;
    import java.util.List;
    import java.util.ArrayList;

    import com.sun.syndication.feed.synd.SyndFeed;
    import com.sun.syndication.feed.synd.SyndFeedImpl;
    import com.sun.syndication.io.SyndFeedOutput;
    import com.sun.syndication.io.SyndFeedInput;
    import com.sun.syndication.io.XmlReader;

    /**
     * It aggregates a list of RSS/Atom feeds (they can be of different types)
     * into a single feed of the specified type.
     * <p>
     * @author Alejandro Abdelnur
     *
     */
    public class FeedAggregator {

        public static void main(String[] args) {
            boolean ok = false;
            if (args.length>=2) {
                try {
                    String outputType = args[0];

                    SyndFeed feed = new SyndFeedImpl();
                    feed.setFeedType(outputType);

                    feed.setTitle("Aggregated Feed");
                    feed.setDescription("Anonymous Aggregated Feed");
                    feed.setAuthor("anonymous");
                    feed.setLink("http://www.anonymous.com");

                    List entries = new ArrayList();
                    feed.setEntries(entries);

                    for (int i=1;i<args.length;i++) {
                        URL inputUrl = new URL(args[i]);

                        SyndFeedInput input = new SyndFeedInput();
                        SyndFeed inFeed = input.build(new XmlReader(inputUrl));

                        entries.addAll(inFeed.getEntries());

                    }

                    SyndFeedOutput output = new SyndFeedOutput();
                    output.output(feed,new PrintWriter(System.out));

                    ok = true;
                }
                catch (Exception ex) {
                    System.out.println("ERROR: "+ex.getMessage());
                }
            }

            if (!ok) {
                System.out.println();
                System.out.println("FeedAggregator aggregates different feeds into a single one.");
                System.out.println("The first parameter must be the feed type for the aggregated feed.");
                System.out.println(" [valid values are: rss_0.9, rss_0.91, rss_0.92, rss_0.93, ]");
                System.out.println(" [                  rss_0.94, rss_1.0, rss_2.0 & atom_0.3  ]");
                System.out.println("The second to last parameters are the URLs of feeds to aggregate.");
                System.out.println();
            }
        }

    }