org.restlet.ext.atom
Class Entry

java.lang.Object
  org.restlet.representation.Variant
      org.restlet.representation.RepresentationInfo
          org.restlet.representation.Representation
              org.restlet.representation.CharacterRepresentation
                  org.restlet.representation.WriterRepresentation
                      org.restlet.ext.xml.XmlRepresentation
                          org.restlet.ext.xml.SaxRepresentation
                              org.restlet.ext.atom.Entry

All Implemented Interfaces:

NamespaceContext

public class Entry
extends SaxRepresentation

Represents an individual entry, acting as a component for metadata and data associated with the entry.

Author:

Jerome Louvel

Field Summary

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

Entry()
Constructor.

Entry(Client clientDispatcher, String entryUri)
Constructor.

Entry(Context context, String entryUri)
Constructor.

Entry(Representation xmlEntry)
Constructor.

Entry(Representation xmlEntry, EntryReader entryReader)
Constructor.

Entry(String entryUri)
Constructor.

Method Summary

List<Person>	getAuthors() Returns the authors of the entry.
List<Category>	getCategories() Returns the categories associated with the entry.
Content	getContent() Returns the content of the entry or links to it.
List<Person>	getContributors() Returns the contributors to the entry.
String	getId() Returns the permanent, universally unique identifier for the entry.
Link	getLink(Relation rel) Returns the first available link with a given relation type.
List<Link>	getLinks() Returns the references from the entry to Web resources.
Date	getPublished() Returns the moment associated with an event early in the life cycle of the entry.
Text	getRights() Returns the information about rights held in and over an entry.
Source	getSource() Returns the source feed's metadata if the entry was copied from another feed.
String	getSummary() Returns the short summary, abstract, or excerpt of the entry.
Text	getTitle() Returns the human-readable title for the entry.
Date	getUpdated() Returns the most recent moment when the entry was modified in a significant way.
void	setContent(Content content) Sets the content of the entry or links to it.
void	setId(String id) Sets the permanent, universally unique identifier for the entry.
void	setPublished(Date published) Sets the moment associated with an event early in the life cycle of the entry.
void	setRights(Text rights) Sets the information about rights held in and over an entry.
void	setSource(Source source) Sets the source feed's metadata if the entry was copied from another feed.
void	setSummary(String summary) Sets the short summary, abstract, or excerpt of the entry.
void	setTitle(String title) Sets the human-readable title for the entry.
void	setTitle(Text title) Sets the human-readable title for the entry.
void	setUpdated(Date updated) Sets the most recent moment when the entry was modified in a significant way.
void	write(XmlWriter writer) Writes the representation to a XML writer.
void	writeElement(XmlWriter writer) Writes the current object as an XML element using the given SAX writer.
void	writeInlineContent(XmlWriter writer) Allow to write extra content inside the entry.

Methods inherited from class org.restlet.ext.xml.SaxRepresentation

getInputSource, getSaxSource, isSecureProcessing, parse, release, setSaxSource, setSecureProcessing, write

Methods inherited from class org.restlet.ext.xml.XmlRepresentation

evaluate, getBoolean, getDocument, getDocumentBuilder, getDomSource, getEntityResolver, getErrorHandler, getNamespaces, getNamespaceURI, getNode, getNodes, getNumber, getPrefix, getPrefixes, getSaxSource, getSchema, getStreamSource, getText, isCoalescing, isExpandingEntityRefs, isIgnoringComments, isIgnoringExtraWhitespaces, isNamespaceAware, isValidatingDtd, isXIncludeAware, setCoalescing, setEntityResolver, setErrorHandler, setExpandingEntityRefs, setIgnoringComments, setIgnoringExtraWhitespaces, setNamespaceAware, setNamespaces, setSchema, setSchema, setValidatingDtd, setXIncludeAware, validate, validate, validate, validate

Methods inherited from class org.restlet.representation.WriterRepresentation

getReader

Methods inherited from class org.restlet.representation.CharacterRepresentation

getChannel, getStream, write, write

Methods inherited from class org.restlet.representation.Representation

append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient

Methods inherited from class org.restlet.representation.RepresentationInfo

getModificationDate, getTag, setModificationDate, setTag

Methods inherited from class org.restlet.representation.Variant

createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Entry

public Entry()

Constructor.

Entry

public Entry(Client clientDispatcher,
             String entryUri)
      throws IOException

Constructor.

Parameters:

clientDispatcher - The client HTTP dispatcher.

entryUri - The entry URI.

Throws:

IOException

Entry

public Entry(Context context,
             String entryUri)
      throws IOException

Constructor.

Parameters:

context - The context from which the client dispatcher will be retrieved.

entryUri - The entry URI.

Throws:

IOException

Entry

public Entry(Representation xmlEntry)
      throws IOException

Constructor.

Parameters:

xmlEntry - The XML entry document.

Throws:

IOException

Entry

public Entry(Representation xmlEntry,
             EntryReader entryReader)
      throws IOException

Constructor.

Parameters:

xmlEntry - The XML entry document.

entryReader - Custom entry reader.

Throws:

IOException

Entry

public Entry(String entryUri)
      throws IOException

Constructor.

Parameters:

entryUri - The entry URI.

Throws:

IOException

Method Detail

getAuthors

public List<Person> getAuthors()

Returns the authors of the entry.

Returns:

The authors of the entry.

getCategories

public List<Category> getCategories()

Returns the categories associated with the entry.

Returns:

The categories associated with the entry.

getContent

public Content getContent()

Returns the content of the entry or links to it.

Returns:

The content of the entry or links to it.

getContributors

public List<Person> getContributors()

Returns the contributors to the entry.

Returns:

The contributors to the entry.

getId

public String getId()

Returns the permanent, universally unique identifier for the entry.

Returns:

The permanent, universally unique identifier for the entry.

getLink

public Link getLink(Relation rel)

Returns the first available link with a given relation type.

Parameters:

rel - The relation type to match.

Returns:

The first available link with a given relation type.

getLinks

public List<Link> getLinks()

Returns the references from the entry to Web resources.

Returns:

The references from the entry to Web resources.

getPublished

public Date getPublished()

Returns the moment associated with an event early in the life cycle of the entry.

Returns:

The moment associated with an event early in the life cycle of the entry.

getRights

public Text getRights()

Returns the information about rights held in and over an entry.

Returns:

The information about rights held in and over an entry.

getSource

public Source getSource()

Returns the source feed's metadata if the entry was copied from another feed.

Returns:

The source feed's metadata if the entry was copied from another feed.

getSummary

public String getSummary()

Returns the short summary, abstract, or excerpt of the entry.

Returns:

The short summary, abstract, or excerpt of the entry.

getTitle

public Text getTitle()

Returns the human-readable title for the entry.

Returns:

The human-readable title for the entry.

getUpdated

public Date getUpdated()

Returns the most recent moment when the entry was modified in a significant way.

Returns:

The most recent moment when the entry was modified in a significant way.

setContent

public void setContent(Content content)

Sets the content of the entry or links to it.

Parameters:

content - The content of the entry or links to it.

setId

public void setId(String id)

Sets the permanent, universally unique identifier for the entry.

Parameters:

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

setPublished

public void setPublished(Date published)

Sets the moment associated with an event early in the life cycle of the entry.

Parameters:

published - The moment associated with an event early in the life cycle of the entry.

setRights

public void setRights(Text rights)

Sets the information about rights held in and over an entry.

Parameters:

rights - The information about rights held in and over an entry.

setSource

public void setSource(Source source)

Sets the source feed's metadata if the entry was copied from another feed.

Parameters:

source - The source feed's metadata if the entry was copied from another feed.

setSummary

public void setSummary(String summary)

Sets the short summary, abstract, or excerpt of the entry.

Parameters:

summary - The short summary, abstract, or excerpt of the entry.

setTitle

public void setTitle(String title)

Sets the human-readable title for the entry.

Parameters:

title - The human-readable title for the entry.

setTitle

public void setTitle(Text title)

Sets the human-readable title for the entry.

Parameters:

title - The human-readable title for the entry.

setUpdated

public void setUpdated(Date updated)

Sets the most recent moment when the entry was modified in a significant way.

Parameters:

updated - The most recent moment when the entry was modified in a significant way.

write

public void write(XmlWriter writer)
           throws IOException

Writes the representation to a XML writer.

Overrides:

write in class SaxRepresentation

Parameters:

writer - The XML writer to write to.

Throws:

IOException

writeElement

public void writeElement(XmlWriter writer)
                  throws SAXException

Writes the current object as an XML element using the given SAX writer.

Parameters:

writer - The SAX writer.

Throws:

SAXException

writeInlineContent

public void writeInlineContent(XmlWriter writer)
                        throws SAXException

Allow to write extra content inside the entry. The default implementation does nothing and is intended to be overridden.

Parameters:

writer - The SAX writer.

Throws:

SAXException