com.ibm.portal.resolver.atom
Interface AtomXMLReaderFactory

public interface AtomXMLReaderFactory

Helper factory that generates artifacts to convert between ATOM specific interfaces and SAX specific interfaces

Since:

6.0.1

Field Summary

static java.lang.String	ATTR_CLASS name of the class attribute used for instantiation
static java.lang.String	DEFAULT_EXTENSION_ID ID of the ATOM XLM Factory default extension
static java.lang.String	EXTENSION_POINT_ID ID of the ATOM XLM Factory extension point

Method Summary

DefaultAtomContentHandler	createAtomContentHandler() Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomContentHandler	createAtomContentHandler(org.xml.sax.ContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomContentHandler	createAtomContentHandler(ResettableAtomContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomContentHandler	createAtomContentHandler(ResettableContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
AtomDateParser	createAtomDateParser() Creates a push-parser that converts the ContentHandler.characters(char[], int, int) calls to an atom parser into Date objects.
DefaultAtomPublishingContentHandler	createAtomPublishingContentHandler() Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomPublishingContentHandler	createAtomPublishingContentHandler(org.xml.sax.ContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomPublishingContentHandler	createAtomPublishingContentHandler(ResettableContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
AtomPublishingXMLReader	createAtomPublishingXMLReader() Constructs an ATOM XML parser and uses the default SAX parser as the basis for parsing the original XML stream
AtomPublishingXMLReader	createAtomPublishingXMLReader(org.xml.sax.XMLReader aParent) Constructs an ATOM XML parser and allows to specify a basis XML reader instance to parse the actual XML stream
DefaultAtomThreadingContentHandler	createAtomThreadingContentHandler() Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomThreadingContentHandler	createAtomThreadingContentHandler(org.xml.sax.ContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomThreadingContentHandler	createAtomThreadingContentHandler(ResettableAtomThreadingContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
DefaultAtomThreadingContentHandler	createAtomThreadingContentHandler(ResettableContentHandler aHandler) Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods.
AtomThreadingXMLReader	createAtomThreadingXMLReader() Constructs an ATOM XML parser and uses the default SAX parser as the basis for parsing the original XML stream
AtomThreadingXMLReader	createAtomThreadingXMLReader(org.xml.sax.XMLReader aParent) Constructs an ATOM XML parser and allows to specify a basis XML reader instance to parse the actual XML stream
AtomXMLReader	createAtomXMLReader() Constructs an ATOM XML parser and uses the default SAX parser as the basis for parsing the original XML stream
AtomXMLReader	createAtomXMLReader(org.xml.sax.XMLReader aParent) Constructs an ATOM XML parser and allows to specify a basis XML reader instance to parse the actual XML stream
ResettableContentHandler	createContentHandler(AtomContentHandler aHandler) Constructs a SAX content handler that converts SAX events in the ATOM namespace into method callbacks on the AtomContentHandler interface.
ResettableContentHandler	createContentHandler(AtomThreadingContentHandler aHandler) Constructs a SAX content handler that converts SAX events in the ATOM namespace into method callbacks on the AtomContentHandler interface.

Field Detail

EXTENSION_POINT_ID

static final java.lang.String EXTENSION_POINT_ID

ID of the ATOM XLM Factory extension point

See Also:

Constant Field Values

DEFAULT_EXTENSION_ID

static final java.lang.String DEFAULT_EXTENSION_ID

ID of the ATOM XLM Factory default extension

See Also:

Constant Field Values

ATTR_CLASS

static final java.lang.String ATTR_CLASS

name of the class attribute used for instantiation

See Also:

Constant Field Values

Method Detail

createAtomContentHandler

DefaultAtomContentHandler createAtomContentHandler()
                                                   throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to manually connect the layer to a ContentHandler one or more times via the ResettableContentHandler interface.

Returns:

high level ATOM handler interface

Throws:

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

createAtomContentHandler

DefaultAtomContentHandler createAtomContentHandler(org.xml.sax.ContentHandler aHandler)
                                                   throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Uses this method as a convenience to create a completely connected layer. The target handler can be reset using ResettableContentHandler. This method should be used if the layer is only required for one single parsing step.

Parameters:

aHandler - SAX content handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomContentHandler

DefaultAtomContentHandler createAtomContentHandler(ResettableAtomContentHandler aHandler)
                                                   throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to connect the layer with another chain of ResettableAtomContentHandler layers. Use ResettableAtomContentHandler to associate the target AtomContentHandler one or more times.

Parameters:

aHandler - handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomContentHandler

DefaultAtomContentHandler createAtomContentHandler(ResettableContentHandler aHandler)
                                                   throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to connect the layer with a chain of ResettableContentHandler layers. Use ResettableContentHandler to associate the target ContentHandler.

Parameters:

aHandler - SAX content handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomThreadingContentHandler

DefaultAtomThreadingContentHandler createAtomThreadingContentHandler()
                                                                     throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to manually connect the layer to a ContentHandler one or more times via the ResettableContentHandler interface.

Returns:

high level ATOM handler interface

Throws:

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

createAtomThreadingContentHandler

DefaultAtomThreadingContentHandler createAtomThreadingContentHandler(org.xml.sax.ContentHandler aHandler)
                                                                     throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Uses this method as a convenience to create a completely connected layer. The target handler can be reset using ResettableContentHandler. This method should be used if the layer is only required for one single parsing step.

Parameters:

aHandler - SAX content handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomThreadingContentHandler

DefaultAtomThreadingContentHandler createAtomThreadingContentHandler(ResettableAtomThreadingContentHandler aHandler)
                                                                     throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to connect the layer with another chain of ResettableAtomThreadingContentHandler layers. Use ResettableAtomThreadingContentHandler to associate the target AtomThreadingContentHandler one or more times.

Parameters:

aHandler - handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomThreadingContentHandler

DefaultAtomThreadingContentHandler createAtomThreadingContentHandler(ResettableContentHandler aHandler)
                                                                     throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to connect the layer with a chain of ResettableContentHandler layers. Use ResettableContentHandler to associate the target ContentHandler.

Parameters:

aHandler - SAX content handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomThreadingXMLReader

AtomThreadingXMLReader createAtomThreadingXMLReader()
                                                    throws org.xml.sax.SAXException

Constructs an ATOM XML parser and uses the default SAX parser as the basis for parsing the original XML stream

Returns:

the ATOM parser

Throws:

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

createAtomThreadingXMLReader

AtomThreadingXMLReader createAtomThreadingXMLReader(org.xml.sax.XMLReader aParent)
                                                    throws org.xml.sax.SAXException

Constructs an ATOM XML parser and allows to specify a basis XML reader instance to parse the actual XML stream

Parameters:

aParent - the original xml parser

Returns:

the ATOM parser

Throws:

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

createAtomXMLReader

AtomXMLReader createAtomXMLReader()
                                  throws org.xml.sax.SAXException

Constructs an ATOM XML parser and uses the default SAX parser as the basis for parsing the original XML stream

Returns:

the ATOM parser

Throws:

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

createAtomXMLReader

AtomXMLReader createAtomXMLReader(org.xml.sax.XMLReader aParent)
                                  throws org.xml.sax.SAXException

Constructs an ATOM XML parser and allows to specify a basis XML reader instance to parse the actual XML stream

Parameters:

aParent - the original xml parser

Returns:

the ATOM parser

Throws:

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

createContentHandler

ResettableContentHandler createContentHandler(AtomContentHandler aHandler)
                                              throws org.xml.sax.SAXException

Constructs a SAX content handler that converts SAX events in the ATOM namespace into method callbacks on the AtomContentHandler interface.

Parameters:

aHandler - handler that receives method callbacks for ATOM events

Returns:

SAX content handler

Throws:

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

createContentHandler

ResettableContentHandler createContentHandler(AtomThreadingContentHandler aHandler)
                                              throws org.xml.sax.SAXException

Constructs a SAX content handler that converts SAX events in the ATOM namespace into method callbacks on the AtomContentHandler interface.

Parameters:

aHandler - handler that receives method callbacks for ATOM events

Returns:

SAX content handler

Throws:

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

createAtomPublishingContentHandler

DefaultAtomPublishingContentHandler createAtomPublishingContentHandler()
                                                                       throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to manually connect the layer to a ContentHandler one or more times via the ResettableContentHandler interface.

Returns:

high level ATOM handler interface

Throws:

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

createAtomPublishingContentHandler

DefaultAtomPublishingContentHandler createAtomPublishingContentHandler(org.xml.sax.ContentHandler aHandler)
                                                                       throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Uses this method as a convenience to create a completely connected layer. The target handler can be reset using ResettableContentHandler. This method should be used if the layer is only required for one single parsing step.

Parameters:

aHandler - SAX content handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomPublishingContentHandler

DefaultAtomPublishingContentHandler createAtomPublishingContentHandler(ResettableContentHandler aHandler)
                                                                       throws org.xml.sax.SAXException

Constructs a handler that allows to produce ATOM feeds by calling high-level, ATOM specific methods. These method calls are translated into SAX events in the ATOM format.

Use this method to connect the layer with a chain of ResettableContentHandler layers. Use ResettableContentHandler to associate the target ContentHandler.

Parameters:

aHandler - SAX content handler that will receive the events

Returns:

high level ATOM handler interface

Throws:

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

createAtomPublishingXMLReader

AtomPublishingXMLReader createAtomPublishingXMLReader()
                                                      throws org.xml.sax.SAXException

Constructs an ATOM XML parser and uses the default SAX parser as the basis for parsing the original XML stream

Returns:

the ATOM parser

Throws:

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

createAtomPublishingXMLReader

AtomPublishingXMLReader createAtomPublishingXMLReader(org.xml.sax.XMLReader aParent)
                                                      throws org.xml.sax.SAXException

Constructs an ATOM XML parser and allows to specify a basis XML reader instance to parse the actual XML stream

Parameters:

aParent - the original xml parser

Returns:

the ATOM parser

Throws:

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

createAtomDateParser

AtomDateParser createAtomDateParser()

Creates a push-parser that converts the ContentHandler.characters(char[], int, int) calls to an atom parser into Date objects. The returned parser instance is not thread safe but the same instance can be used to parse many dates.

Returns:

an instance of the parser, not null

Since:

6.1.0