org.gedcomx.atom
Class Entry

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

All Implemented Interfaces:

HasTransientProperties, SupportsLinks, SupportsExtensionElements

public class Entry
extends ExtensibleElement
implements SupportsLinks

The "atom:entry" element represents an individual entry, acting as a container for metadata and data associated with the entry.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.atom.ExtensibleElement

transientProperties

Constructor Summary

Entry()

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 entry.
List<Category>	getCategories() information about a category associated with an entry.
ResultConfidence	getConfidence() The confidence of the result, if this entry represents a search result.
Content	getContent() The content of the entry.
List<Person>	getContributors() information about a category associated with the entry
Map<QName,String>	getExtensionAttributes()
URI	getId() a permanent, universally unique identifier for the entry.
Link	getLink(String rel) Get a link by its rel.
List<Link>	getLinks() a reference from a entry to a Web resource.
List<Link>	getLinks(String rel) Get a list of links by rel.
Date	getPublished() instant in time associated with an event early in the life cycle of the entry.
String	getRights() information about rights held in and over the entry.
Float	getScore() The relevance score, if this entry represents a search result.
String	getTitle() a human-readable title for the entry
Date	getUpdated() the most recent instant in time when the entry was modified in a way the publisher considers significant.
void	setAuthors(List<Person> authors) The author of the entry.
void	setCategories(List<Category> categories) information about a category associated with an entry.
void	setConfidence(ResultConfidence confidence) The confidence of the result, if this entry represents a search result.
void	setContent(Content content) The content of the entry.
void	setContributors(List<Person> contributors) information about a category associated with the entry
void	setExtensionAttributes(Map<QName,String> extensionAttributes)
void	setId(URI id) a permanent, universally unique identifier for the entry.
void	setLinks(List<Link> links) a reference from a entry to a Web resource.
void	setPublished(Date published) instant in time associated with an event early in the life cycle of the entry.
void	setRights(String rights) information about rights held in and over the entry.
void	setScore(Float score) The relevance score, if this entry represents a search result.
void	setTitle(String title) a human-readable title for the entry
void	setUpdated(Date updated) the most recent instant in time when the entry 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

Entry

public Entry()

Method Detail

getAuthors

public List<Person> getAuthors()

The author of the entry.

Returns:

The author of the entry.

setAuthors

public void setAuthors(List<Person> authors)

The author of the entry.

Parameters:

authors - The author of the entry.

getCategories

public List<Category> getCategories()

information about a category associated with an entry.

Returns:

information about a category associated with an entry.

setCategories

public void setCategories(List<Category> categories)

information about a category associated with an entry.

Parameters:

categories - information about a category associated with an entry.

getContent

public Content getContent()

The content of the entry.

Returns:

The content of the entry.

setContent

public void setContent(Content content)

The content of the entry.

Parameters:

content - The content of the entry.

getContributors

public List<Person> getContributors()

information about a category associated with the entry

Returns:

information about a category associated with the entry

setContributors

public void setContributors(List<Person> contributors)

information about a category associated with the entry

Parameters:

contributors - information about a category associated with the entry

getId

public URI getId()

a permanent, universally unique identifier for the entry.

Returns:

a permanent, universally unique identifier for the entry.

setId

public void setId(URI id)

a permanent, universally unique identifier for the entry.

Parameters:

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

getScore

public Float getScore()

The relevance score, if this entry represents a search result. The value of this score is implementation-specific.

Returns:

The relevance score.

setScore

public void setScore(Float score)

The relevance score, if this entry represents a search result. The value of this score is implementation-specific.

Parameters:

score - The relevance score.

getConfidence

public ResultConfidence getConfidence()

The confidence of the result, if this entry represents a search result.

Returns:

The confidence of the result, if this entry represents a search result.

setConfidence

public void setConfidence(ResultConfidence confidence)

The confidence of the result, if this entry represents a search result.

Parameters:

confidence - The confidence of the result, if this entry represents a search result.

getLinks

public List<Link> getLinks()

a reference from a entry to a Web resource.

Specified by:

getLinks in interface SupportsLinks

Returns:

a reference from a entry to a Web resource.

setLinks

public void setLinks(List<Link> links)

a reference from a entry to a Web resource.

Specified by:

setLinks in interface SupportsLinks

Parameters:

links - a reference from a entry 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.

getPublished

public Date getPublished()

instant in time associated with an event early in the life cycle of the entry.

Returns:

instant in time associated with an event early in the life cycle of the entry.

setPublished

public void setPublished(Date published)

instant in time associated with an event early in the life cycle of the entry.

Parameters:

published - instant in time associated with an event early in the life cycle of the entry.

getRights

public String getRights()

information about rights held in and over the entry.

Returns:

information about rights held in and over the entry.

setRights

public void setRights(String rights)

information about rights held in and over the entry.

Parameters:

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

getTitle

public String getTitle()

a human-readable title for the entry

Returns:

a human-readable title for the entry

setTitle

public void setTitle(String title)

a human-readable title for the entry

Parameters:

title - a human-readable title for the entry

getUpdated

public Date getUpdated()

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

Returns:

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

setUpdated

public void setUpdated(Date updated)

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

Parameters:

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

getExtensionAttributes

public Map<QName,String> getExtensionAttributes()

setExtensionAttributes

public void setExtensionAttributes(Map<QName,String> extensionAttributes)

accept

public void accept(AtomModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor to accept.