[译文]了解用于读取RSS和Atom新闻推送的JavaFX API(二)
Atom API概述
相比于RSS,Atom API由位于javafx.data.feed.atom包中的12个类组成,包的核心是AtomTask类。
API支持的Atom版本 |
Atom API处理符合Atom规范1.0版(撰写本文时的最新版本)的新闻推送。 |
AtomTask这一入口点类扩展了FeddTask,提供了以下变量,这些变量用来安装自定义工厂,报告新闻推送的feed元素的非entry内容,以及报告推送元素的每个entry元素的内容:
Factory(类型为Factory)标识了被用来创建代表新闻推送元素的对象的工厂,在创建自定义推送解析器的时候,只需要安装你自己的工厂就可以了。
onFeed(类型为function(:Feed):Void)标识了被调用来报告feed元素的非entry元素的函数,Atom feed元素包含了entry和非entry元素,其自身是顶层元素,该变量的缺省值为null。
onEntry(类型为function(:Entry):Void)标识了被调用来报告当前entry元素的函数,该变量的缺省值为null。
类Feed扩展了抽象类Atom(继承了一些成员,用以访问新闻推送的基本URI、创建对象的工厂等),Atom则是扩展了Base。
Feed还提供了以下这些变量,用以访问面向feed(非entry特有的)的内容:
authors(类型为Person[])标识了该feed的作者(涉及电子邮件地址、名称、附加的个人特有的文本资料,以及个人的国际化资源标识符(Internationalized Resource Identifier,IRI)等)。
categories(类型为Category[])标识了该feed所属的类别(涉及可读的标签、分类名称以及类别方案IRI等)。
contributors(类型为Persion[])标识捐助该feed的人。
generator(类型为Generator)标识了被用来生产该feed的程序(涉及可读的名称、程序URI,以及程序版本号等)。这些信息可用于调试Atom新闻推送。
icon(类型为Id)标识了该feed的图标图像(以图像的URI来描述)。
id(类型为Id)为该feed指定了一个全局唯一的和永久的标识符(以URI来描述)。
links(类型为Link[])指定了该feed到Web资源的链接(涉及href、hreflang、length、rel、title及type等XML属性,以及与链接相关的文本内容)。
logo(类型为Id)标识了该feed的非图标图形。
rights(类型为Content)指明了该feed的持有权和拥有权(涉及src、text和type等XML属性)。
subtitle(类型为Content)提供了该feed的副标题。
title(类型为Content)提供了该feed的标题。
updated(类型为Date)指明了该feed内容的最后修改时间。
与Feed一样,描述feed的单个entry元素的Entry类也扩展了Atom,除了共享与Feed相同的那些变量之外,Entry提供了以下独有的变量:
content(类型为Content)指定了该entry的内容。
published(类型为Date)指明了该entry发布的日期。
source(类型为Feed)标识该entry的feed来源。
summary(类型Content)指明了该entry的一个简短小结、摘要或者摘录。
我创建了一个AtomDemo NetBeans工程用以说明AtomTask,该工程的Main.fx源代码与RSSDemo的Main.fx源代码非常相似。
/* * Main.fx */
package atomdemo;
import java.lang.Exception;
import javafx.data.feed.atom.AtomTask; import javafx.data.feed.atom.Entry; import javafx.data.feed.atom.Feed;
import javafx.data.pull.Event;
def MAX_POLLS = 3;
var counter = 0;
def task:AtomTask = AtomTask { interval: 15s
//下面的location说明了一个基本的Atom新闻推送。
location: "http://photos.dailycamera.com/hack/feed.mg?Type=gallery&Data=9573834_9ysrR&format=atom10"
//下面的location说明了onForeignEvent().
// location: "http://blogsearch.google.com/blogsearch/feeds?bc_lang=en&hl=en&output=atom"
//下面的location说明了IllegalArgumentException (必须使用 // RssTask获取RSS推送)。
// location: "http://javajeff.mb.ca/rss/javajeff.xml"
onStart: function (): Void { println ("Task is starting");
if (++counter > MAX_POLLS) { task.stop (); FX.exit () } }
onFeed: function (f: Feed): Void { println ("Feed: {f}") }
onEntry: function (e: Entry): Void { println ("Entry: {e}") }
onException: function (e: Exception): Void { println ("Exception: {e}"); task.stop (); FX.exit () }
onForeignEvent: function (e: Event): Void { println ("Event: {e}") }
onDone: function (): Void { println ("Completed poll #{counter}") } } task.start () |
这个简单的框架可以作为研究Atom API的起始点,考虑一下,扩充onFeed()和onEntry()来输出他们的Feed和Entry参数的各个变量的值。