org.apache.ws.jaxme.pm.ino

Class InoResponseHandler

Implemented Interfaces:
ContentHandler

public class InoResponseHandler
extends java.lang.Object
implements ContentHandler

This is a SAX content handler for an ino:response document.
Author:
Jochen Wiedmann

Field Summary

static String
INO_RESPONSE2_URI
The namespace of an INO response document: http://namespaces.softwareag.com/tamino/response2.
static String
XQL_URI
The namespace of the XQL section in an INO response document: http://metalab.unc.edu/xql/.

Constructor Summary

InoResponseHandler()
Creates a new InoResponseHandler

Method Summary

void
characters(char[] ch, int start, int len)
void
endDocument()
void
endElement(String namespaceUri, String localName, String qName)
void
endPrefixMapping(String prefix)
Locator
getDocumentLocator()
Returns the document Locator, that was previously set by the XML parser.
java.util.List
getInoObjectIdList()
Returns the current list for collection of generated ino:id's.
ContentHandler
getResultHandler()
Returns a result handler, that was previously set with setResultHandler, or null.
void
ignorableWhitespace(char[] ch, int start, int len)
void
processingInstruction(String target, String data)
void
setDocumentLocator(Locator l)
void
setInoObjectIdList(java.util.List pList)
The Tamino response document contains object ID's of inserted or updated objects.
void
setResultHandler(ContentHandler handler)
Sets the result handler.
void
skippedEntity(String entity)
void
startDocument()
void
startElement(String namespaceUri, String localName, String qName, Attributes attr)
void
startPrefixMapping(String namespaceUri, String prefix)

Field Details

INO_RESPONSE2_URI

public static final String INO_RESPONSE2_URI
The namespace of an INO response document: http://namespaces.softwareag.com/tamino/response2.

XQL_URI

public static final String XQL_URI
The namespace of the XQL section in an INO response document: http://metalab.unc.edu/xql/.

Constructor Details

InoResponseHandler

public InoResponseHandler()
Creates a new InoResponseHandler

Method Details

characters

public void characters(char[] ch,
                       int start,
                       int len)
            throws SAXException

endDocument

public void endDocument()
            throws org.xml.sax.SAXException

endElement

public void endElement(String namespaceUri,
                       String localName,
                       String qName)
            throws SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
            throws SAXException

getDocumentLocator

public Locator getDocumentLocator()
Returns the document Locator, that was previously set by the XML parser. May be null, if the parser didn't supply one.

getInoObjectIdList

public java.util.List getInoObjectIdList()
Returns the current list for collection of generated ino:id's.

getResultHandler

public ContentHandler getResultHandler()
Returns a result handler, that was previously set with setResultHandler, or null.

The result handler is another SAX ContentHandler. For any result document the InoResponseHandler finds, that is, for any subelement of xql:result, a stream of SAX events is generated for the result handler.

If the response document contains more than one result object, then the result handler must be "restartable". In other words, it must be able to process multiple startDocument ... endDocument startDocument ... endDocument sequences.

Returns:
The result handler or null, if generating SAX events is disabled.

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int len)
            throws SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
            throws SAXException

setDocumentLocator

public void setDocumentLocator(Locator l)

setInoObjectIdList

public void setInoObjectIdList(java.util.List pList)
The Tamino response document contains object ID's of inserted or updated objects. If you use this method, then the ID's are collected in the given List. A null value disables ID collection. The list will be cleared within startDocument, so it's safe to reuse the list over multiple uses of the handler.

More precise, the list will contain all occurences of ino:response/ino:object/@ino:id.

Parameters:
pList - A list where ID's are being collected or null to disable ID collection.

setResultHandler

public void setResultHandler(ContentHandler handler)
Sets the result handler. The result handler is another SAX ContentHandler. For any result document the InoResponseHandler finds, that is, for any subelement of xql:result, a stream of SAX events is generated for the result handler.

If the response document contains more than one result object, then the result handler must be "restartable". In other words, it must be able to process multiple startDocument ... endDocument startDocument ... endDocument sequences.

Parameters:
handler - The result handler to use or null to disable SAX events

skippedEntity

public void skippedEntity(String entity)
            throws SAXException

startDocument

public void startDocument()
            throws org.xml.sax.SAXException

startElement

public void startElement(String namespaceUri,
                         String localName,
                         String qName,
                         Attributes attr)
            throws SAXException

startPrefixMapping

public void startPrefixMapping(String namespaceUri,
                               String prefix)
            throws SAXException