com.ibm.portal.resolver.atom
Interface AtomThreadingContentHandler

All Superinterfaces:

org.xml.sax.ContentHandler, ResettableContentHandler

All Known Subinterfaces:

DefaultAtomThreadingContentHandler, ResettableAtomThreadingContentHandler

All Known Implementing Classes:

EmptyAtomThreadingContentHandler, LeafAtomThreadingContentHandler

public interface AtomThreadingContentHandler
extends ResettableContentHandler

http://www.ietf.org/rfc/rfc4685.txt ATOM threading extension (RFC 4685)

JAXP content handler extension that defines semantic callbacks for ATOM specific events. For each event in the ATOM namespace these semantic events should be called instead of the untyped SAX events. For all events outside of the ATOM namespace the methods on ContentHandler should be called.

From a design pattern, each ATOM element declares the attributes that are mentioned explicitly in the ATOM RFC 4287 as top level parameters. Common or extended attributes are transported via the Attributes interface. The naming convention oXXX indiciates an optional attribute that may be set to null whereas rXXX indicates a required attribute that must not be set to null.

Since:

6.0.1

See Also:

DefaultAtomThreadingContentHandler

Method Summary

void	endInReplyTo() Indicates the end of an atom:in-reply-to entry.
void	endTotal() Indicates the end of an atom:total/code> entry.
void	startInReplyTo(java.lang.String rRef, java.lang.String oHref, java.lang.String oSource, java.lang.String oType, org.xml.sax.Attributes attrs) Indicates the start of an thr:in-reply-to entry.
void	startTotal(org.xml.sax.Attributes attrs) Indicates the start of an thr:total entry.

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Method Detail

startInReplyTo

void startInReplyTo(java.lang.String rRef,
                    java.lang.String oHref,
                    java.lang.String oSource,
                    java.lang.String oType,
                    org.xml.sax.Attributes attrs)
                    throws org.xml.sax.SAXException

Indicates the start of an thr:in-reply-to entry.

The "in-reply-to" element is used to indicate that an entry is a response to another resource. The element MUST contain a "ref" attribute identifying the resource that is being responded to.

The element is not unlike the references and in-reply-to email message headers defined by [RFC2822]. However, unlike the in-reply-to header, the "in-reply-to" element is required to identify the unique identifier of only a single parent resource. If the entry is a response to multiple resources, additional "in-reply-to" elements MAY be used. There is no direct equivalent to the references header, which lists the unique identifiers of each preceding message in a thread.

Parameters:

rRef - Mandatory ref attribute, not null.

The "ref" attribute specifies the persistent, universally unique identifier of the resource being responded to. The value MUST conform to the same construction and comparison rules as the value of the atom:id element as defined in section 4.2.6 of [RFC4287]. Though the IRI might use a dereferenceable scheme, processors MUST NOT assume it can be dereferenced.

oHref - Optional href attribute, may be null.

oSource - Optional source attribute, may be null.

The "source" attribute MAY be used to specify the IRI [RFC3987] of an Atom Feed or Entry Document containing an atom:entry with an atom:id value equal to the value of the "ref" attribute. The IRI specified, once appropriately mapped to a corresponding URI, MUST be dereferenceable.

oType - Optional type attribute, may be null.

The "type" attribute MAY be used to provide a hint to the client about the media type [RFC4288] of the resource identified by the "href" attribute. The "type" attribute is only meaningful if a corresponding "href" attribute is also provided.

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endInReplyTo

void endInReplyTo()
                  throws org.xml.sax.SAXException

Indicates the end of an atom:in-reply-to entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created

startTotal

void startTotal(org.xml.sax.Attributes attrs)
                throws org.xml.sax.SAXException

Indicates the start of an thr:total entry.

The "total" element is used to indicate the total number of unique responses to an entry known to the publisher. Its content MUST be an unsigned non-negative integer value conforming to the canonical representation of the XML Schema nonNegativeInteger data type [W3C.REC-xmlschema-2-20041028].

Parameters:

attrs - optional attribues, must not be null but may be empty

Throws:

org.xml.sax.SAXException - - if the event could not be created

endTotal

void endTotal()
              throws org.xml.sax.SAXException

Indicates the end of an atom:total/code> entry.

Throws:

org.xml.sax.SAXException - - if the event could not be created