IP*Works! V9

ipworks
Class RSSItem

java.lang.Object
  extended by ipworks.RSSItem

public class RSSItem
extends java.lang.Object

An RSS item as it is received from the RSS feed.

When an RSS feed is parsed by the component, each item is parsed into an rssitem type. This type contains field value pairs for standard RSS 2.0 elements.

Author: This field contains the email address or contact information for the current item's author.

Category: This field contains the location of the current item within a hierarchy. The value of this field is a forward-slash-separated string that identifies a hierarchic location in a particular hierarchy. The conventions used to interpret an RSS item's category depend upon the processor.

CategoryDomain: This field contains the URL indicating the definition of the current item's category. This points to a location that defines the category indicated by the Category which is provided in the Items collection .

Comments: If present, this field should point to a URL location of a page for comments related to the current item.

Description: This field contains the description of the content of the current item. For abstracts, Link should point to the complete text of the item.

This field is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either Title or Description defined.

EnclosureLength: This field indicates how large the enclosure is in bytes.

An enclosure specifies a media object which is attached to the item. The fields EnclosureLength , EnclosureType , and EnclosureUrl all are required when specifying an enclosure.

EnclosureType: This field specifies the type of enclosure. This field must contain a standard MIME type such as "audio/mpeg".

An enclosure specifies a media object which is attached to the item. The fields EnclosureLength , EnclosureType , and EnclosureUrl all are required when specifying an enclosure.

EnclosureUrl: This field contains the URL where the enclosure is located.

An enclosure specifies a media object which is attached to the item. The fields EnclosureLength , EnclosureType , and EnclosureUrl all are required when specifying an enclosure.

Guid: This field contains the globally unique identifier for the current item. It is a string that uniquely identifies the item. Aggregators can use this field to determine whether or not an item is new.

Aggregators should view this value as a string, but it is up to the source of the feed to guarantee its uniqueness. The value may be the URL link to the full text of the item in order to help guarantee that it is unique.

GuidIsPermaLink: When this field is set to true, the reader may assume that the guid is a permalink to the item. A permalink is a url that can be opened in a Web browser, which contains the full item contents from the original RSS feed.

ItemXML: This field contains the full XML contents of the item. Unless the properties of the RSSItem are modified, this value will contain the original XML from the RSS feed.

NOTE: When setting this field, the entire contents of the item must be supplied including the item tags. All previous item values will be lost.

Link: For headline or abstract items, this field should be the location of the full text of the item.

PubDate: This field contains the date of the current item's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either 2 or 4 characters long.

Source: This field contains the name of the RSS feed in which the item was originally published, derived from the feed's title. If this field or SourceURL are empty, they should be filled with the values contained in Title and Link fields of the Channel before forwarding the feed from a news aggregator to a weblog.

SourceURL: This field contains the URL location of the XML-version of the current item's source. This is required if Source is defined. It is a URL that points to the XML representation of the source of the current item.

Title: This field contains the title or headline of the current item. This field is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either Title or Description defined.

This field should contain a short description of the item, or a headline if Description is defined.

See Also:
Atom, Atom.RSSItem

Constructor Summary
RSSItem()
           
RSSItem(java.lang.String title, java.lang.String description)
           
 
Method Summary
 java.lang.String getAuthor()
           
 java.lang.String getCategory()
           
 java.lang.String getCategoryDomain()
           
 java.lang.String getComments()
           
 java.lang.String getDescription()
           
 java.lang.String getEnclosureLength()
           
 java.lang.String getEnclosureType()
           
 java.lang.String getEnclosureUrl()
           
 java.lang.String getGuid()
           
 boolean getGuidIsPermaLink()
           
 java.lang.String getItemXML()
           
 java.lang.String getLink()
           
 java.lang.String getPubDate()
           
 java.lang.String getSource()
           
 java.lang.String getSourceURL()
           
 java.lang.String getTitle()
           
 void setAuthor(java.lang.String value)
           
 void setCategory(java.lang.String value)
           
 void setCategoryDomain(java.lang.String value)
           
 void setComments(java.lang.String value)
           
 void setDescription(java.lang.String value)
           
 void setEnclosureLength(java.lang.String value)
           
 void setEnclosureType(java.lang.String value)
           
 void setEnclosureUrl(java.lang.String value)
           
 void setGuid(java.lang.String value)
           
 void setGuidIsPermaLink(boolean value)
           
 void setItemXML(java.lang.String value)
           
 void setLink(java.lang.String value)
           
 void setPubDate(java.lang.String value)
           
 void setSource(java.lang.String value)
           
 void setSourceURL(java.lang.String value)
           
 void setTitle(java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RSSItem

public RSSItem()

RSSItem

public RSSItem(java.lang.String title,
               java.lang.String description)
Method Detail

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String value)

getCategory

public java.lang.String getCategory()

setCategory

public void setCategory(java.lang.String value)

getCategoryDomain

public java.lang.String getCategoryDomain()

setCategoryDomain

public void setCategoryDomain(java.lang.String value)

getComments

public java.lang.String getComments()

setComments

public void setComments(java.lang.String value)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String value)

getEnclosureLength

public java.lang.String getEnclosureLength()

setEnclosureLength

public void setEnclosureLength(java.lang.String value)

getEnclosureType

public java.lang.String getEnclosureType()

setEnclosureType

public void setEnclosureType(java.lang.String value)

getEnclosureUrl

public java.lang.String getEnclosureUrl()

setEnclosureUrl

public void setEnclosureUrl(java.lang.String value)

getGuid

public java.lang.String getGuid()

setGuid

public void setGuid(java.lang.String value)

getGuidIsPermaLink

public boolean getGuidIsPermaLink()

setGuidIsPermaLink

public void setGuidIsPermaLink(boolean value)

getItemXML

public java.lang.String getItemXML()

setItemXML

public void setItemXML(java.lang.String value)

getLink

public java.lang.String getLink()

setLink

public void setLink(java.lang.String value)

getPubDate

public java.lang.String getPubDate()

setPubDate

public void setPubDate(java.lang.String value)

getSource

public java.lang.String getSource()

setSource

public void setSource(java.lang.String value)

getSourceURL

public java.lang.String getSourceURL()

setSourceURL

public void setSourceURL(java.lang.String value)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String value)

IP*Works! V9

Copyright (c) 2013 /n software inc. - All rights reserved.