ipworks
Class AtomEntry

java.lang.Object
  |
  +--ipworks.AtomEntry

public class AtomEntry

extends java.lang.Object

An Atom entry as it is received from the Atom feed.

When an Atom feed is parsed by the component, each item is parsed into an ATOMENTRY type.

AuthorEmail: This field contains the email of the person.

AuthorName: This field contains the name of the person.

AuthorUri: This field contains the uri of the person.

CategoryLabel: This field identifies a human readable label for the category.

CategoryScheme: This field identifies a categorization scheme.

CategoryTerm: This field identifies the category to which the entry or feed belongs.

Content: This contains the text contents of an Atom entry.

ContentTextType: Text type of the content of the entry. Atom textual content can either be html, xhtml or text.

ContributorEmail: This field contains the email of the person.

ContributorName: This field contains the name of the person.

ContributorUri: This field contains the uri of the person.

EntryXML: The full XML contents of the entry. Unless the properties of the ATOMENTRY are modified, this value will contain the original XML from the Atom feed.

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

Id: The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC3987.

LinkHref: This field contains the location of the link.

LinkHrefLang: This field contains the language of the content at the link.

LinkLength: This field contains the length (in bytes) of the content at the link.

LinkRel: This field indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287.

• alternate
• related
• self
• enclosure
• via

LinkTitle: This field contains the title of the link.

LinkType: This field contains the MIME type of the content at the link.

Published: The date at which the entry was first created.

Rights: This field contains information about the rights of the given entry.

Source: This field is used when an entry has been copied from one feed to another feed. It preserves all child element of the feed other than entries.

Summary: Text description of an Atom entry. This contains a short description of the entry.

SummaryTextType: Text type of the summary of the entry. Atom textual content can either be html, xhtml or text.

Title: This contains the title of the current Atom Feed. Typically the title of the channel is similar to that of the web page where the Atom content is hosted.

TitleTextType: Text type of the title of the entry. Atom textual content can either be html, xhtml or text.

Updated: Date-time when the Feed was updated.

See Also:

Atom, Atom.AtomEntry

Field Summary

static int	ctHTML
static int	ctText
static int	ctXHTML
static int	stHTML
static int	stText
static int	stXHTML
static int	ttHTML
static int	ttText
static int	ttXHTML

Constructor Summary

AtomEntry()

Method Summary

java.lang.String	getAuthorEmail()
java.lang.String	getAuthorName()
java.lang.String	getAuthorUri()
java.lang.String	getCategoryLabel()
java.lang.String	getCategoryScheme()
java.lang.String	getCategoryTerm()
java.lang.String	getContent()
int	getContentTextType()
java.lang.String	getContributorEmail()
java.lang.String	getContributorName()
java.lang.String	getContributorUri()
java.lang.String	getEntryXML()
java.lang.String	getId()
java.lang.String	getLinkHref()
java.lang.String	getLinkHrefLang()
java.lang.String	getLinkLength()
java.lang.String	getLinkRel()
java.lang.String	getLinkTitle()
java.lang.String	getLinkType()
java.lang.String	getPublished()
java.lang.String	getRights()
java.lang.String	getSource()
java.lang.String	getSummary()
int	getSummaryTextType()
java.lang.String	getTitle()
int	getTitleTextType()
java.lang.String	getUpdated()
void	setAuthorEmail(java.lang.String value)
void	setAuthorName(java.lang.String value)
void	setAuthorUri(java.lang.String value)
void	setCategoryLabel(java.lang.String value)
void	setCategoryScheme(java.lang.String value)
void	setCategoryTerm(java.lang.String value)
void	setContent(java.lang.String value)
void	setContentTextType(int value)
void	setContributorEmail(java.lang.String value)
void	setContributorName(java.lang.String value)
void	setContributorUri(java.lang.String value)
void	setEntryXML(java.lang.String value)
void	setId(java.lang.String value)
void	setLinkHref(java.lang.String value)
void	setLinkHrefLang(java.lang.String value)
void	setLinkLength(java.lang.String value)
void	setLinkRel(java.lang.String value)
void	setLinkTitle(java.lang.String value)
void	setLinkType(java.lang.String value)
void	setPublished(java.lang.String value)
void	setRights(java.lang.String value)
void	setSource(java.lang.String value)
void	setSummary(java.lang.String value)
void	setSummaryTextType(int value)
void	setTitle(java.lang.String value)
void	setTitleTextType(int value)
void	setUpdated(java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ctText

public static final int ctText

See Also:

Constant Field Values

ctHTML

public static final int ctHTML

See Also:

Constant Field Values

ctXHTML

public static final int ctXHTML

See Also:

Constant Field Values

stText

public static final int stText

See Also:

Constant Field Values

stHTML

public static final int stHTML

See Also:

Constant Field Values

stXHTML

public static final int stXHTML

See Also:

Constant Field Values

ttText

public static final int ttText

See Also:

Constant Field Values

ttHTML

public static final int ttHTML

See Also:

Constant Field Values

ttXHTML

public static final int ttXHTML

See Also:

Constant Field Values

Constructor Detail

AtomEntry

public AtomEntry()

Method Detail

getAuthorEmail

public java.lang.String getAuthorEmail()

setAuthorEmail

public void setAuthorEmail(java.lang.String value)

getAuthorName

public java.lang.String getAuthorName()

setAuthorName

public void setAuthorName(java.lang.String value)

getAuthorUri

public java.lang.String getAuthorUri()

setAuthorUri

public void setAuthorUri(java.lang.String value)

getCategoryLabel

public java.lang.String getCategoryLabel()

setCategoryLabel

public void setCategoryLabel(java.lang.String value)

getCategoryScheme

public java.lang.String getCategoryScheme()

setCategoryScheme

public void setCategoryScheme(java.lang.String value)

getCategoryTerm

public java.lang.String getCategoryTerm()

setCategoryTerm

public void setCategoryTerm(java.lang.String value)

getContent

public java.lang.String getContent()

setContent

public void setContent(java.lang.String value)

getContentTextType

public int getContentTextType()

setContentTextType

public void setContentTextType(int value)

getContributorEmail

public java.lang.String getContributorEmail()

setContributorEmail

public void setContributorEmail(java.lang.String value)

getContributorName

public java.lang.String getContributorName()

setContributorName

public void setContributorName(java.lang.String value)

getContributorUri

public java.lang.String getContributorUri()

setContributorUri

public void setContributorUri(java.lang.String value)

getEntryXML

public java.lang.String getEntryXML()

setEntryXML

public void setEntryXML(java.lang.String value)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String value)

getLinkHref

public java.lang.String getLinkHref()

setLinkHref

public void setLinkHref(java.lang.String value)

getLinkHrefLang

public java.lang.String getLinkHrefLang()

setLinkHrefLang

public void setLinkHrefLang(java.lang.String value)

getLinkLength

public java.lang.String getLinkLength()

setLinkLength

public void setLinkLength(java.lang.String value)

getLinkRel

public java.lang.String getLinkRel()

setLinkRel

public void setLinkRel(java.lang.String value)

getLinkTitle

public java.lang.String getLinkTitle()

setLinkTitle

public void setLinkTitle(java.lang.String value)

getLinkType

public java.lang.String getLinkType()

setLinkType

public void setLinkType(java.lang.String value)

getPublished

public java.lang.String getPublished()

setPublished

public void setPublished(java.lang.String value)

getRights

public java.lang.String getRights()

setRights

public void setRights(java.lang.String value)

getSource

public java.lang.String getSource()

setSource

public void setSource(java.lang.String value)

getSummary

public java.lang.String getSummary()

setSummary

public void setSummary(java.lang.String value)

getSummaryTextType

public int getSummaryTextType()

setSummaryTextType

public void setSummaryTextType(int value)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String value)

getTitleTextType

public int getTitleTextType()

setTitleTextType

public void setTitleTextType(int value)

getUpdated

public java.lang.String getUpdated()

setUpdated

public void setUpdated(java.lang.String value)