christophedelory.atom
Class Source

java.lang.Object
  christophedelory.atom.Common
      christophedelory.atom.Source

Direct Known Subclasses:

Feed

public class Source
extends Common

This element is designed to allow the aggregation of entries from different feeds while retaining information about an entry's source feed. For this reason, Atom processors that are performing such aggregation should include at least the required feed-level metadata elements (id, title, and updated) in the source element.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Source()

Method Summary

void	addAuthor(Person author) Adds a feed's author.
void	addCategory(Category category) Adds a category to this feed.
void	addContributor(Person contributor) Adds a person or other entity who contributed to the feed.
void	addLink(Link link) Adds a reference from this feed to a Web resource.
List<Person>	getAuthors() Returns the list of feed's authors.
List<Category>	getCategories() Returns the list of categories associated with the feed.
List<Person>	getContributors() Returns the list of persons or other entities who contributed to the feed.
Generator	getGenerator() Returns the identification of the agent used to generate the feed.
URIContainer	getIcon() Returns the URI that identifies an image that provides iconic visual identification for this feed.
URIContainer	getId() Returns a permanent, universally unique identifier for the feed.
List<Link>	getLinks() Returns the list of references from this feed to a Web resource.
URIContainer	getLogo() Returns an URI reference that identifies an image that provides visual identification for this feed.
TextContainer	getRights() Returns information about rights held in and over this feed.
TextContainer	getSubtitle() Returns a human-readable description or subtitle for this feed.
TextContainer	getTitle() Returns a human-readable title for this feed.
Date	getUpdated() Returns the most recent instant in time when this feed was modified in a way the publisher considers significant.
void	setGenerator(Generator generator) Initializes the identification of the agent used to generate the feed.
void	setIcon(URIContainer icon) Initializes the URI that identifies an image that provides iconic visual identification for this feed.
void	setId(URIContainer id) Initializes the permanent, universally unique identifier for the feed.
void	setLogo(URIContainer logo) Initializes the URI reference that identifies an image that provides visual identification for this feed.
void	setRights(TextContainer rights) Initializes information about rights held in and over this feed.
void	setSubtitle(TextContainer subtitle) Initializes a human-readable description or subtitle for this feed.
void	setTitle(TextContainer title) Initializes the human-readable title for this feed.
void	setUpdated(Date updated) Initializes the most recent instant in time when this feed was modified in a way the publisher considers significant.

Methods inherited from class christophedelory.atom.Common

getBaseString, getLang, setBaseString, setLang

Methods inherited from class java.lang.Object

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

Constructor Detail

Source

public Source()

Method Detail

getAuthors

public List<Person> getAuthors()

Returns the list of feed's authors. The list is initially empty.

Returns:

a list of authors. May be empty but not null.

See Also:

addAuthor(christophedelory.atom.Person)

addAuthor

public void addAuthor(Person author)

Adds a feed's author.

Parameters:

author - an author. Shall not be null.

Throws:

NullPointerException - if author is null.

See Also:

getAuthors()

getCategories

public List<Category> getCategories()

Returns the list of categories associated with the feed. The list is initially empty.

Returns:

a list of categories. May be empty but not null.

See Also:

addCategory(christophedelory.atom.Category)

addCategory

public void addCategory(Category category)

Adds a category to this feed.

Parameters:

category - a category. Shall not be null.

Throws:

NullPointerException - if category is null.

See Also:

getCategories()

getContributors

public List<Person> getContributors()

Returns the list of persons or other entities who contributed to the feed. The list is initially empty.

Returns:

a list of contributors. May be empty but not null.

See Also:

addContributor(christophedelory.atom.Person)

addContributor

public void addContributor(Person contributor)

Adds a person or other entity who contributed to the feed.

Parameters:

contributor - a contributor. Shall not be null.

Throws:

NullPointerException - if contributor is null.

See Also:

getContributors()

getGenerator

public Generator getGenerator()

Returns the identification of the agent used to generate the feed.

Returns:

an agent identification. May be null.

See Also:

setGenerator(christophedelory.atom.Generator)

setGenerator

public void setGenerator(Generator generator)

Initializes the identification of the agent used to generate the feed.

Parameters:

generator - an agent identification. May be null.

See Also:

getGenerator()

getIcon

public URIContainer getIcon()

Returns the URI that identifies an image that provides iconic visual identification for this feed. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.

Returns:

an URI container. May be null.

See Also:

setIcon(christophedelory.atom.URIContainer)

setIcon

public void setIcon(URIContainer icon)

Initializes the URI that identifies an image that provides iconic visual identification for this feed.

Parameters:

icon - an URI container. May be null.

See Also:

getIcon()

getId

public URIContainer getId()

Returns a permanent, universally unique identifier for the feed.

Returns:

an URI container. May be null.

See Also:

setId(christophedelory.atom.URIContainer)

setId

public void setId(URIContainer id)

Initializes the permanent, universally unique identifier for the feed.

Parameters:

id - an URI container. May be null.

See Also:

getId()

getLinks

public List<Link> getLinks()

Returns the list of references from this feed to a Web resource. The list is initially empty.

Returns:

a list of links. May be empty but not null.

See Also:

addLink(christophedelory.atom.Link)

addLink

public void addLink(Link link)

Adds a reference from this feed to a Web resource.

Parameters:

link - a link. Shall not be null.

Throws:

NullPointerException - if link is null.

See Also:

getLinks()

getLogo

public URIContainer getLogo()

Returns an URI reference that identifies an image that provides visual identification for this feed. The image should have an aspect ratio of 2 (horizontal) to 1 (vertical).

Returns:

an URI container. May be null.

See Also:

setLogo(christophedelory.atom.URIContainer)

setLogo

public void setLogo(URIContainer logo)

Initializes the URI reference that identifies an image that provides visual identification for this feed.

Parameters:

logo - an URI container. May be null.

See Also:

getLogo()

getRights

public TextContainer getRights()

Returns information about rights held in and over this feed. This element should not be used to convey machine-readable licensing information.

Returns:

a text container. May be null.

See Also:

setRights(christophedelory.atom.TextContainer)

setRights

public void setRights(TextContainer rights)

Initializes information about rights held in and over this feed.

Parameters:

rights - a text container. May be null.

See Also:

getRights()

getSubtitle

public TextContainer getSubtitle()

Returns a human-readable description or subtitle for this feed.

Returns:

a text container. May be null.

See Also:

setSubtitle(christophedelory.atom.TextContainer)

setSubtitle

public void setSubtitle(TextContainer subtitle)

Initializes a human-readable description or subtitle for this feed.

Parameters:

subtitle - a text container. May be null.

See Also:

getSubtitle()

getTitle

public TextContainer getTitle()

Returns a human-readable title for this feed.

Returns:

a text container. May be null.

See Also:

setTitle(christophedelory.atom.TextContainer)

setTitle

public void setTitle(TextContainer title)

Initializes the human-readable title for this feed.

Parameters:

title - a text container. May be null.

See Also:

getTitle()

getUpdated

public Date getUpdated()

Returns the most recent instant in time when this feed was modified in a way the publisher considers significant. Therefore, not all modifications necessarily result in a changed updated value.

Returns:

a date. May be null.

See Also:

setUpdated(java.util.Date)

setUpdated

public void setUpdated(Date updated)

Initializes the most recent instant in time when this feed was modified in a way the publisher considers significant.

Parameters:

updated - a date. May be null.

See Also:

getUpdated()