Niko Schmuck Quickstart

To read in an RSS feed you have to provide basically two things: a source from where to read the feed (URL, File, InputStream or Reader) and a ChannelBuilder which builds the news channel object model. Currently two ChannelBuilder are available: one in-memory (see de.nava.informa.impl.basic.ChannelBuilder) and the other one using the Hibernate O/R mapping mechansim to persist the data in a relational database (see de.nava.informa.impl.hibernate.ChannelBuilder). The following code fragment demonstrates the usage:

import java.io.File; import de.nava.informa.core.ChannelIF; import de.nava.informa.impl.basic.ChannelBuilder; import de.nava.informa.parsers.FeedParser; ... File inpFile = new File("javanews.xml"); ChannelIF channel = FeedParser.parse(new ChannelBuilder(), inpFile);

Further information about the channel object can be found in the JavaDoc for ChannelIF.

To read in a OPML (Outline processor markup language) you can use code as follows:

import de.nava.informa.parsers.OPMLParser; ... // parse inpFile file and return a collection of FeedIF objects Collection feeds = OPMLParser.parse(inpFile);

This provides a convenient facility to read in a collection of FeedIF objects which might be helpful for retrieving news channels.

For creating your own news channel object model in-memory, look at following example:

ChannelIF channel = builder.createChannel(chanName); channel.setDescription("Test Channel: " + chanName); ItemIF item1 = builder.createItem(channel, "Item 1 for " + chanName, "First in line", new URL("http://sf.net/rss2_projnews.php?group_id=52620")); ItemIF item2 = builder.createItem(channel, "Item 2 for " + chanName, "Second in line", new URL("http://sf.net/export/rss2_projfiles.php?group_id=52620"));

If you like to make use of the persistent backend using de.nava.informa.impl.hibernate.ChannelBuilder you can achieve the above with:

SessionHandler handler = SessionHandler.getInstance(); Session session = handler.getSession(); ChannelBuilder builder = new ChannelBuilder(session); Transaction tx = null; try { tx = session.beginTransaction(); ChannelIF channel = builder.createChannel(chanName); channel.setDescription("Test Channel: " + chanName); session.saveOrUpdate(channel); ItemIF item1 = builder.createItem(channel, "Item 1 for " + chanName, "First in line", new URL("http://sf.net/rss2_projnews.php?group_id=52620")); session.saveOrUpdate(item1); ItemIF item2 = builder.createItem(channel, "Item 2 for " + chanName, "Second in line", new URL("http://sf.net/export/rss2_projfiles.php?group_id=52620")); session.saveOrUpdate(item2); session.saveOrUpdate(channel); tx.commit(); } catch (HibernateException he) { logger.warn("trying to rollback the transaction"); if (tx != null) tx.rollback(); throw he; } finally { session.close(); }

Please look at ChannelIndexer and ChannelSearcher in the meantime or find more information about the usage inside the test cases (directory: test/src/de/nava/informa/search).

Some day you might want to export a news channel to a file. The informa library does support writing a news channel to RSS 0.91 and 1.0 formats. Please look at the following example:

import de.nava.informa.core.ChannelExporterIF; import de.nava.informa.exporters.RSS_1_0_Exporter; ... ChannelExporterIF exporter = new RSS_1_0_Exporter("myfeed.rdf"); // assuming you have a ChannelIF object available as channel exporter.write(channel);

Please see the question in the FAQ.

There are two utility classes provided by the Informa API which are

The Hibernate 2 library files are provided with the informa distribution. If you do not want to use the Hypersonic SQL database, you have to make sure that you include any files required for JDBC connectivity to the database in the classpath. The first file that to investigate is the hibernate.properties file. Place this file in your classpath so that Hibernate can find it at runtime. This file contains the runtime settings that Hibernate will use when it is started up. Here is an example:

hibernate.dialect=org.hibernate.dialect.HSQLDialect hibernate.connection.driver_class=org.hsqldb.jdbcDriver hibernate.connection.url=jdbc:hsqldb:informa hibernate.connection.username=sa hibernate.connection.password= hibernate.show_sql=true

There are also DDLs (for MySQL, PostgreSQL and HSQL) for the tables needed by Informa's hibernate backend provided with the distribution under the directory sql.