org.apache.ws.jaxme.pm.ino
Class InoResponseHandler

java.lang.Object
  org.apache.ws.jaxme.pm.ino.InoResponseHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class InoResponseHandler
extends java.lang.Object
implements org.xml.sax.ContentHandler

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

Author:

Jochen Wiedmann

Field Summary

static java.lang.String	INO_RESPONSE2_URI The namespace of an INO response document: http://namespaces.softwareag.com/tamino/response2.
static java.lang.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(java.lang.String namespaceUri, java.lang.String localName, java.lang.String qName)
void	endPrefixMapping(java.lang.String prefix)
org.xml.sax.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.
org.xml.sax.ContentHandler	getResultHandler() Returns a result handler, that was previously set with setResultHandler, or null.
void	ignorableWhitespace(char[] ch, int start, int len)
void	processingInstruction(java.lang.String target, java.lang.String data)
void	setDocumentLocator(org.xml.sax.Locator l)
void	setInoObjectIdList(java.util.List pList) The Tamino response document contains object ID's of inserted or updated objects.
void	setResultHandler(org.xml.sax.ContentHandler handler) Sets the result handler.
void	skippedEntity(java.lang.String entity)
void	startDocument()
void	startElement(java.lang.String namespaceUri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attr)
void	startPrefixMapping(java.lang.String namespaceUri, java.lang.String prefix)

Methods inherited from class java.lang.Object

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

Field Detail

INO_RESPONSE2_URI

public static final java.lang.String INO_RESPONSE2_URI

The namespace of an INO response document: http://namespaces.softwareag.com/tamino/response2.

See Also:

Constant Field Values

XQL_URI

public static final java.lang.String XQL_URI

The namespace of the XQL section in an INO response document: http://metalab.unc.edu/xql/.

See Also:

Constant Field Values

Constructor Detail

InoResponseHandler

public InoResponseHandler()

Creates a new InoResponseHandler

Method Detail

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator l)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

getDocumentLocator

public org.xml.sax.Locator getDocumentLocator()

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

startDocument

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

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

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

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceUri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attr)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceUri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String namespaceUri,
                               java.lang.String prefix)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int len)
                         throws org.xml.sax.SAXException

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

skippedEntity

public void skippedEntity(java.lang.String entity)
                   throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int len)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

setResultHandler

public void setResultHandler(org.xml.sax.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

See Also:

getResultHandler()

getResultHandler

public org.xml.sax.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.

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.

See Also:

getInoObjectIdList()

getInoObjectIdList

public java.util.List getInoObjectIdList()

Returns the current list for collection of generated ino:id's.

See Also:

setInoObjectIdList(java.util.List)