JavaFX - Custom Feed Parsers


In one of my previous post I have described the use of RSS and ATOM Task to parse the feeds.

Unfortunately many feeds do not strictly comply with the RSS/ATOM format. Example: In some cases the date specified for pubDate element may be in wrong format, or its an invalid date or the information specified is embedded in CDATA instead of TEXT. The parser will fail for such scenarios. Hence we need to implement custom parsers so as to handle the situation.

Below sample reads engadget rss feed..

<script src="http://dl.javafx.com/1.2/dtfx.js"></script><script src="/rakeshmenonp/resource/CustomRssTask/CustomRssTask.js"></script>

For Applet mode, click on above image

Both RssTask and AtomTask API provide an attribute - factory - which can be used to specify custom implementation of RSS or ATOM Factory. Users may also customize various elements such as Channel, Item, Entry, Feed by overriding functions such as - fromXML, tryParseDate etc.

Example: In some cases the default parser fails to convert pubDate to valid DateTime instance. So a new attribute - pubDateText - is added so as to save the date as String.

/\*\*
 \* Customize Item so as to override fromXML
 \*/
class CustomItem extends Item {
    
    public-read var pubDateText : String;
    
    override function fromXML(parser: PullParser): Void {
        
        if(parser.event.qname == PUB_DATE) {
            if ((parser.event.type == PullParser.TEXTor
                (parser.event.type == PullParser.CDATA)) {
                pubDateText = stripCDATA(parser.event.text)
            }
        else if(parser.event.qname == TITLE) {
            title = stripCDATA(parser.event.text);
        else {
            super.fromXML(parser);
        }
    }
}

Now we need to implement a custom Factory which will instantiate and return the above CustomItem instance.

/\*\*
 \* Customize Factory so as to return CustomItem
 \*/
class CustomFactory extends Factory {
    public override function newItem(c: Channel: Item {
        CustomItem parent: c channel: c }
    }
}

Above Factory is set in factory attribute of RssTask as shown below.

var rssTask = RssTask {

    // set custom factory
    factory: CustomFactory { }

    location: "http://www.engadget.com/rss.xml"
    onChannel: function(channel) {  }
    onItem: function(item) { }
}
rssTask.start();

Update: Please refer to SpeedReaderFX by Jim Weaver for real world example.

Try it out and let me know feedback


<script type="text/javascript">var dzone_style = '2';</script> <script language="javascript" src="/rakeshmenonp/resource/CustomRssTask/zoneit.js"></script>

Comments:

I will definitely try it out and give you some feedback.

Posted by Emma Springer on September 15, 2009 at 10:17 PM IST #

Oh Rakesh great

Posted by Noushad T.M on September 16, 2009 at 04:08 AM IST #

@Emma, Noushad Thanks! :)

Posted by Rakesh Menon on September 17, 2009 at 08:51 AM IST #

It is really usefull. This documentation is missing in our API Docs.
These needs to goto our testbase.
Good post.

Posted by Raghu Nair on September 30, 2009 at 03:31 AM IST #

Post a Comment:
Comments are closed for this entry.
About


The views expressed on this blog are my own and do not necessarily reflect that of my organization

Search

Categories
Archives
« April 2014
SunMonTueWedThuFriSat
  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
   
       
Today