org.gedcomx.atom
Class Feed

java.lang.Object
  org.gedcomx.atom.CommonAttributes
      org.gedcomx.atom.ExtensibleElement
          org.gedcomx.atom.Feed

All Implemented Interfaces:

HasTransientProperties, SupportsLinks, SupportsExtensionElements

public class Feed
extends ExtensibleElement
implements SupportsLinks

The Atom data formats provide a format for web content and metadata syndication. The XML media type is defined by RFC 4287. The JSON data format is specific to GEDCOM X and is a translation to JSON from the XML.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.atom.ExtensibleElement

transientProperties

Constructor Summary

Feed()

Method Summary

void	accept(AtomModelVisitor visitor) Accept a visitor.
void	addLink(Link link) Add a hypermedia link.
void	addLink(String rel, URI href) Add a hypermedia link.
void	addTemplatedLink(String rel, String template) Add a templated link.
List<Person>	getAuthors() The author of the feed.
List<Person>	getContributors() information about a category associated with the feed
List<Entry>	getEntries() The entries in the feed.
List<Field>	getFacets() The list of facets for the feed, used for convenience in browsing and filtering.
Generator	getGenerator() identifies the agent used to generate the feed
URI	getIcon() identifies an image that provides iconic visual identification for the feed.
URI	getId() a permanent, universally unique identifier for the feed.
Integer	getIndex() The index of the first entry in this page of data, if this feed is supplying a page of data.
Link	getLink(String rel) Get a link by its rel.
List<Link>	getLinks() a reference from a feed to a Web resource.
List<Link>	getLinks(String rel) Get a list of links by rel.
URI	getLogo() identifies an image that provides visual identification for the feed.
Integer	getResults() The total number of results available, if this feed is supplying a subset of results, such as for a query.
String	getRights() information about rights held in and over the feed.
String	getSubtitle() a human-readable description or subtitle for the feed.
String	getTitle() a human-readable title for the feed
Date	getUpdated() the most recent instant in time when the feed was modified in a way the publisher considers significant.
void	setAuthors(List<Person> authors) The author of the feed.
void	setContributors(List<Person> contributors) information about a category associated with the feed
void	setEntries(List<Entry> entries) The entries in the feed.
void	setFacets(List<Field> facets) The list of facets for the feed, used for convenience in browsing and filtering.
void	setGenerator(Generator generator) identifies the agent used to generate the feed
void	setIcon(URI icon) identifies an image that provides iconic visual identification for the feed.
void	setId(URI id) a permanent, universally unique identifier for the feed.
void	setIndex(Integer index) The index of the first entry in this page of data, if this feed is supplying a page of data.
void	setLinks(List<Link> links) a reference from a feed to a Web resource.
void	setLogo(URI logo) identifies an image that provides visual identification for the feed.
void	setResults(Integer results) The total number of results available, if this feed is supplying a subset of results, such as for a query.
void	setRights(String rights) information about rights held in and over the feed.
void	setSubtitle(String subtitle) a human-readable description or subtitle for the feed.
void	setTitle(String title) a human-readable title for the feed
void	setUpdated(Date updated) the most recent instant in time when the feed was modified in a way the publisher considers significant.

Methods inherited from class org.gedcomx.atom.ExtensibleElement

addExtensionElement, findExtensionOfType, findExtensionsOfType, getExtensionElements, getTransientProperties, getTransientProperty, setExtensionElements, setTransientProperty

Methods inherited from class org.gedcomx.atom.CommonAttributes

getBase, getLang, setBase, setLang

Methods inherited from class java.lang.Object

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

Constructor Detail

Feed

public Feed()

Method Detail

getAuthors

public List<Person> getAuthors()

The author of the feed.

Returns:

The author of the feed.

setAuthors

public void setAuthors(List<Person> authors)

The author of the feed.

Parameters:

authors - The author of the feed.

getContributors

public List<Person> getContributors()

information about a category associated with the feed

Returns:

information about a category associated with the feed

setContributors

public void setContributors(List<Person> contributors)

information about a category associated with the feed

Parameters:

contributors - information about a category associated with the feed

getGenerator

public Generator getGenerator()

identifies the agent used to generate the feed

Returns:

identifies the agent used to generate the feed

setGenerator

public void setGenerator(Generator generator)

identifies the agent used to generate the feed

Parameters:

generator - identifies the agent used to generate the feed

getIcon

public URI getIcon()

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

Returns:

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

setIcon

public void setIcon(URI icon)

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

Parameters:

icon - identifies an image that provides iconic visual identification for the feed.

getId

public URI getId()

a permanent, universally unique identifier for the feed.

Returns:

a permanent, universally unique identifier for the feed.

setId

public void setId(URI id)

a permanent, universally unique identifier for the feed.

Parameters:

id - a permanent, universally unique identifier for the feed.

getResults

public Integer getResults()

The total number of results available, if this feed is supplying a subset of results, such as for a query.

Returns:

The total number of results available, if this feed is supplying a subset of results, such as for a query.

setResults

public void setResults(Integer results)

The total number of results available, if this feed is supplying a subset of results, such as for a query.

Parameters:

results - The total number of results available, if this feed is supplying a subset of results, such as for a query.

getIndex

public Integer getIndex()

The index of the first entry in this page of data, if this feed is supplying a page of data.

Returns:

The index of the first entry in this page of data, if this feed is supplying a page of data.

setIndex

public void setIndex(Integer index)

The index of the first entry in this page of data, if this feed is supplying a page of data.

Parameters:

index - The index of the first entry in this page of data, if this feed is supplying a page of data.

getLinks

public List<Link> getLinks()

a reference from a feed to a Web resource.

Specified by:

getLinks in interface SupportsLinks

Returns:

a reference from a feed to a Web resource.

setLinks

public void setLinks(List<Link> links)

a reference from a feed to a Web resource.

Specified by:

setLinks in interface SupportsLinks

Parameters:

links - a reference from a feed to a Web resource.

addLink

public void addLink(Link link)

Add a hypermedia link.

Specified by:

addLink in interface SupportsLinks

Parameters:

link - The hypermedia link.

addLink

public void addLink(String rel,
                    URI href)

Add a hypermedia link.

Specified by:

addLink in interface SupportsLinks

Parameters:

rel - The link rel.

href - The target URI.

addTemplatedLink

public void addTemplatedLink(String rel,
                             String template)

Add a templated link.

Specified by:

addTemplatedLink in interface SupportsLinks

Parameters:

rel - The link rel.

template - The link template.

getLink

public Link getLink(String rel)

Get a link by its rel.

Specified by:

getLink in interface SupportsLinks

Parameters:

rel - The link rel.

Returns:

The link by rel.

getLinks

public List<Link> getLinks(String rel)

Get a list of links by rel.

Specified by:

getLinks in interface SupportsLinks

Parameters:

rel - The rel of the links.

Returns:

The link.

getLogo

public URI getLogo()

identifies an image that provides visual identification for the feed.

Returns:

identifies an image that provides visual identification for the feed.

setLogo

public void setLogo(URI logo)

identifies an image that provides visual identification for the feed.

Parameters:

logo - identifies an image that provides visual identification for the feed.

getRights

public String getRights()

information about rights held in and over the feed.

Returns:

information about rights held in and over the feed.

setRights

public void setRights(String rights)

information about rights held in and over the feed.

Parameters:

rights - information about rights held in and over the feed.

getSubtitle

public String getSubtitle()

a human-readable description or subtitle for the feed.

Returns:

a human-readable description or subtitle for the feed.

setSubtitle

public void setSubtitle(String subtitle)

a human-readable description or subtitle for the feed.

Parameters:

subtitle - a human-readable description or subtitle for the feed.

getTitle

public String getTitle()

a human-readable title for the feed

Returns:

a human-readable title for the feed

setTitle

public void setTitle(String title)

a human-readable title for the feed

Parameters:

title - a human-readable title for the feed

getUpdated

public Date getUpdated()

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

Returns:

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

setUpdated

public void setUpdated(Date updated)

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

Parameters:

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

getEntries

public List<Entry> getEntries()

The entries in the feed.

Returns:

The entries in the feed.

setEntries

public void setEntries(List<Entry> entries)

The entries in the feed.

Parameters:

entries - The entries in the feed.

getFacets

public List<Field> getFacets()

The list of facets for the feed, used for convenience in browsing and filtering.

Returns:

The list of facets for the feed, used for convenience in browsing and filtering.

setFacets

public void setFacets(List<Field> facets)

The list of facets for the feed, used for convenience in browsing and filtering.

Parameters:

facets - The list of facets for the feed, used for convenience in browsing and filtering.

accept

public void accept(AtomModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.