org.apache.chemistry.opencmis.server.impl.atompub

Class AtomFeed

java.lang.Object

org.apache.chemistry.opencmis.server.impl.atompub.XMLDocumentBase

org.apache.chemistry.opencmis.server.impl.atompub.AtomDocumentBase

org.apache.chemistry.opencmis.server.impl.atompub.AtomFeed

public class AtomFeed
extends AtomDocumentBase

Atom Feed class.

Author:

Florian Müller

Field Summary

Fields

Modifier and Type	Field and Description
static BigInteger	DEFAULT_PAGE_SIZE

Fields inherited from class org.apache.chemistry.opencmis.server.impl.atompub.XMLDocumentBase

PREFIX_APP, PREFIX_ATOM, PREFIX_CMIS, PREFIX_RESTATOM, PREFIX_XSI

Constructor Summary

Constructors

Constructor and Description
AtomFeed() Creates an Atom feed document.
AtomFeed(XMLStreamWriter writer) Creates an Atom feed that is embedded somewhere.

Method Summary

Modifier and Type	Method and Description
void	endChildren() Closes the feed tag.
void	endFeed() Closes the feed tag.
void	startChildren() Opens the children tag.
void	startFeed(boolean isRoot) Opens the feed tag.
void	writeFeedElements(String id, String author, String title, GregorianCalendar updated, String pathSegment, BigInteger numItems) Writes the feed elements that are required by Atom.
void	writeNumItems(BigInteger numItems) Writes a CMIS numItems tag.
void	writePagingLinks(org.apache.chemistry.opencmis.commons.impl.UrlBuilder pagingUrl, BigInteger maxItems, BigInteger skipCount, BigInteger numItems, Boolean hasMoreItems, BigInteger pageSize) Writes paging links.

Methods inherited from class org.apache.chemistry.opencmis.server.impl.atompub.AtomDocumentBase

formatDate, generateAtomId, writeAclLink, writeAllowableActionsLink, writeAlternateLink, writeAuthor, writeCollection, writeCurrentVerionsLink, writeDescribedByLink, writeDownLink, writeEditLink, writeEditMediaLink, writeEnclosureLink, writeFirstLink, writeFolderTreeLink, writeId, writeLastLink, writeLink, writeNextLink, writePathSegment, writePoliciesLink, writePreviousLink, writePublished, writePublished, writeRelationshipsLink, writeRelationshipSourceLink, writeRelationshipTargetLink, writeRelativePathSegment, writeSelfLink, writeServiceLink, writeSimpleDate, writeSimpleDate, writeSimpleTag, writeTitle, writeTypeDownLink, writeTypeUpLink, writeUpdated, writeUpdated, writeUpLink, writeVersionHistoryLink, writeViaLink, writeWorkingCopyLink

Methods inherited from class org.apache.chemistry.opencmis.server.impl.atompub.XMLDocumentBase

endDocument, getWriter, setNamespaces, setWriter, startDocument, writeNamespace

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_SIZE

public static final BigInteger DEFAULT_PAGE_SIZE

Constructor Detail

AtomFeed

public AtomFeed()

Creates an Atom feed document.

AtomFeed

public AtomFeed(XMLStreamWriter writer)

Creates an Atom feed that is embedded somewhere.

Method Detail

startFeed

public void startFeed(boolean isRoot)
               throws XMLStreamException

Opens the feed tag.

Throws:

XMLStreamException

startChildren

public void startChildren()
                   throws XMLStreamException

Opens the children tag.

Throws:

XMLStreamException

endChildren

public void endChildren()
                 throws XMLStreamException

Closes the feed tag.

Throws:

XMLStreamException

endFeed

public void endFeed()
             throws XMLStreamException

Closes the feed tag.

Throws:

XMLStreamException

writeFeedElements

public void writeFeedElements(String id,
                              String author,
                              String title,
                              GregorianCalendar updated,
                              String pathSegment,
                              BigInteger numItems)
                       throws XMLStreamException

Writes the feed elements that are required by Atom.

Throws:

XMLStreamException

writeNumItems

public void writeNumItems(BigInteger numItems)
                   throws XMLStreamException

Writes a CMIS numItems tag.

Throws:

XMLStreamException

writePagingLinks

public void writePagingLinks(org.apache.chemistry.opencmis.commons.impl.UrlBuilder pagingUrl,
                             BigInteger maxItems,
                             BigInteger skipCount,
                             BigInteger numItems,
                             Boolean hasMoreItems,
                             BigInteger pageSize)
                      throws XMLStreamException

Writes paging links.

Throws:

XMLStreamException