|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.myjavatools.xml.BasicXmlData
com.myjavatools.xml.Rss
public class Rss
Title: MyJavaTools: Rss Class
Description: Defines a container for RSS, Real Simple Syndication data format.
Copyright: This is public domain; The right of people to use, distribute, copy or improve the contents of the following may not be restricted.
The following RSS formats are suppored for reading: 0.91, 0.92, 1.0, 2.0. Output is always 2.0. The version of original document can be retrieved using getOriginalVersion().
Nested Class Summary | |
---|---|
static class |
Rss.Image
Image, Rss member class |
static class |
Rss.Item
Item, Rss member class |
static class |
Rss.Member
incorporates general purpose RSS member element functionality |
static class |
Rss.TextInput
TextInput, Rss member class |
Nested classes/interfaces inherited from class com.myjavatools.xml.BasicXmlData |
---|
BasicXmlData.Expression, BasicXmlData.Function<X,Y>, BasicXmlData.Policy |
Nested classes/interfaces inherited from interface com.myjavatools.xml.XmlData |
---|
XmlData.Condition |
Field Summary | |
---|---|
static java.lang.String |
LATEST_VERSION
Current RSS version "2.0" |
Fields inherited from class com.myjavatools.xml.BasicXmlData |
---|
XmlDataClass |
Constructor Summary | |
---|---|
Rss()
creates empty Rss instance |
|
Rss(java.io.File file)
reads Rss contents from a file |
|
Rss(java.io.InputStream is)
reads Rss from input stream |
|
Rss(java.net.URL url)
reads Rss from a URL |
|
Rss(XmlData source)
creates an instance of Rss based on data from XmlData |
Method Summary | |
---|---|
void |
addItem(Rss.Item item)
adds an item to RSS |
void |
addItem(java.lang.String title,
java.lang.String link,
java.lang.String description)
adds a new item to RSS |
Rss.Item |
findItemByDescription(java.lang.String description)
finds RSS item by its description |
Rss.Item |
findItemByGuid(java.lang.String guid)
finds an item by its guid |
Rss.Item |
findItemByUrl(java.lang.String url)
finds item by its url |
java.lang.String |
getCategory()
gets category |
XmlData |
getCloud()
gets RSS cloud |
java.lang.String |
getCopyright()
gets copyright |
java.lang.String |
getDescription()
gets RSS description |
java.lang.String |
getDocs()
gets docs value |
java.lang.String |
getGenerator()
gets RSS generator |
Rss.Image |
getImage()
gets RSS image |
Rss.Item |
getItem(java.lang.String title)
gets RSS item by title |
Rss.Item |
getItemByDescription(java.lang.String description)
gets RSS item by description |
int |
getItemCount()
Returns number of items in RSS |
java.util.Collection<Rss.Item> |
getItems()
gets a collection of all items in RSS |
java.lang.String |
getLanguage()
gets RSS language |
java.lang.String |
getLastBuildDate()
gets last build date |
java.lang.String |
getLink()
gets RSS link |
java.lang.String |
getManagingEditor()
gets managing editor |
java.lang.String |
getOriginalVersion()
gets original version Original version is the RSS version of source data |
java.lang.String |
getPubDate()
gets publication date |
java.lang.String |
getRating()
gets RSS rating |
java.lang.String |
getSkipDays()
gets skip days |
java.lang.String |
getSkipHours()
gets skip hours |
Rss.TextInput |
getTextInput()
gets RSS textinput |
java.lang.String |
getTitle()
gets RSS title |
java.lang.String |
getTtl()
gets RSS TTL (Time-To-Live, number of days RSS is valid) |
java.lang.String |
getVersion()
gets RSS version (which is 2.0) |
java.lang.String |
getWebMaster()
gets webmaster |
void |
setCategory(java.lang.String category)
sets RSS category |
void |
setCloud(XmlData cloud)
sets RSS cloud |
void |
setCopyright(java.lang.String copyright)
sets copyright string |
void |
setDescription(java.lang.String description)
sets RSS description |
void |
setDocs(java.lang.String docs)
sets docs value |
void |
setGenerator(java.lang.String generator)
sets RSS generator |
void |
setImage(Rss.Image image)
|
void |
setImage(java.lang.String title,
java.lang.String description,
java.lang.String url,
java.lang.String link,
java.lang.String width,
java.lang.String height)
sets RSS Image element |
void |
setLanguage(java.lang.String language)
sets RSS langauge |
void |
setLastBuildDate(java.lang.String lastBuildDate)
sets last build date |
void |
setLink(java.lang.String link)
sets RSS link |
void |
setManagingEditor(java.lang.String managingEditor)
sets managing editor |
void |
setPubDate(java.lang.String pubDate)
sets publication date |
void |
setRating(java.lang.String rating)
sets RSS rating |
void |
setSkipDays(java.lang.String skipDays)
sets skip days |
void |
setSkipHours(java.lang.String skipHours)
sets skip hours |
void |
setTextInput(Rss.TextInput textInput)
sets RSS textinput element |
void |
setTextInput(java.lang.String title,
java.lang.String description,
java.lang.String name,
java.lang.String link)
sets RSS textinput element |
void |
setTitle(java.lang.String title)
sets RSS title |
void |
setTtl(java.lang.String ttl)
sets RSS TTL (Time-To-Live, number of days RSS is valid) |
void |
setWebMaster(java.lang.String webMaster)
|
Methods inherited from class com.myjavatools.xml.BasicXmlData |
---|
addKid, addKids, addKids, cast, cast, castKids, castToPackage, castToPackage, cleanAttributes, clone, debug, deepCopy, equal, equals, getAllKids, getAttribute, getAttribute, getAttributes, getId, getInputStream, getKid, getKid, getKid, getKid, getKidAttribute, getKidCount, getKids, getKidTypes, getKidValue, getName, getType, getValue, getXmlContent, hashCode, indexOf, insertKid, insertKid, removeKid, removeKids, replaceKid, satisfies, satisfies, save, save, save, selectTree, selectTree, setAttribute, setAttributes, setAttributes, setAttributes, setKidAttribute, setKids, setKidValue, setType, setValue, setXmlContent, trim |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String LATEST_VERSION
Constructor Detail |
---|
public Rss() throws java.lang.InstantiationException
java.lang.InstantiationException
- it should notpublic Rss(java.io.File file) throws java.io.FileNotFoundException, java.io.IOException, java.lang.InstantiationException
file
- File data source
java.io.FileNotFoundException
- if file not found
java.io.IOException
- if could not read
java.lang.InstantiationException
- if could not parse the contentspublic Rss(java.io.InputStream is) throws java.io.IOException, java.lang.InstantiationException
is
- InputStream data source
java.io.IOException
- if could not read
java.lang.InstantiationException
- if could not parse the datapublic Rss(XmlData source) throws java.lang.InstantiationException
source
- XmlData data source
java.lang.InstantiationException
- if could not extract datapublic Rss(java.net.URL url) throws java.lang.InstantiationException, java.io.IOException
url
- URL data source
java.io.IOException
- if could not read data
java.lang.InstantiationException
- if could not parse dataMethod Detail |
---|
public java.lang.String getOriginalVersion()
public java.lang.String getVersion()
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- Stringpublic java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- Stringpublic java.lang.String getLink()
public void setLink(java.lang.String link)
link
- Stringpublic java.lang.String getLanguage()
public void setLanguage(java.lang.String language)
language
- Stringpublic java.lang.String getRating()
public void setRating(java.lang.String rating)
rating
- Stringpublic java.lang.String getCopyright()
public void setCopyright(java.lang.String copyright)
copyright
- Stringpublic java.lang.String getPubDate()
public void setPubDate(java.lang.String pubDate)
pubDate
- Stringpublic java.lang.String getLastBuildDate()
public void setLastBuildDate(java.lang.String lastBuildDate)
lastBuildDate
- Stringpublic java.lang.String getManagingEditor()
public void setManagingEditor(java.lang.String managingEditor)
managingEditor
- Stringpublic java.lang.String getWebMaster()
public void setWebMaster(java.lang.String webMaster)
public java.lang.String getSkipHours()
public void setSkipHours(java.lang.String skipHours)
skipHours
- Stringpublic java.lang.String getSkipDays()
public void setSkipDays(java.lang.String skipDays)
skipDays
- Stringpublic java.lang.String getDocs()
public void setDocs(java.lang.String docs)
docs
- Stringpublic void setImage(Rss.Image image)
public void setImage(java.lang.String title, java.lang.String description, java.lang.String url, java.lang.String link, java.lang.String width, java.lang.String height)
title
- String image titledescription
- String image descriptionurl
- String image urllink
- String image linkwidth
- String image widthheight
- String image heightpublic Rss.Image getImage()
public void setTextInput(Rss.TextInput textInput)
textInput
- TextInputpublic void setTextInput(java.lang.String title, java.lang.String description, java.lang.String name, java.lang.String link)
title
- String textinput titledescription
- String textinput descriptionname
- String textinput namelink
- String textinput linkpublic Rss.TextInput getTextInput()
public void addItem(Rss.Item item)
item
- Itempublic void addItem(java.lang.String title, java.lang.String link, java.lang.String description)
title
- String item titlelink
- String item linkdescription
- String item descriptionpublic java.util.Collection<Rss.Item> getItems()
public int getItemCount()
public Rss.Item getItem(java.lang.String title)
title
- String item title to look for
public Rss.Item getItemByDescription(java.lang.String description)
description
- String item title to look for
public void setGenerator(java.lang.String generator)
generator
- Stringpublic java.lang.String getGenerator()
public void setCategory(java.lang.String category)
category
- Stringpublic java.lang.String getCategory()
public void setTtl(java.lang.String ttl)
ttl
- Stringpublic java.lang.String getTtl()
public XmlData getCloud()
public void setCloud(XmlData cloud)
cloud
- XmlDatapublic Rss.Item findItemByDescription(java.lang.String description)
description
- String
public Rss.Item findItemByGuid(java.lang.String guid)
guid
- String
public Rss.Item findItemByUrl(java.lang.String url)
url
- String
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |