com.oroad.stxx.transform.document
Interface SAXSerializer

All Known Implementing Classes:

DefaultSAXSerializer

public interface SAXSerializer

Serializes objects into SAX events

Author:

Don Brown

Method Summary

void	init(StxxProperties props) Initializes the serializer
void	serializeActionError(javax.servlet.http.HttpServletRequest request, java.lang.String name, org.apache.struts.action.ActionError error, java.util.Locale locale, org.apache.struts.util.MessageResources res, XMLConsumer handler) Serializes the action error as an element.
void	serializeActionForm(javax.servlet.http.HttpServletRequest request, java.lang.String name, org.apache.struts.action.ActionForm form, XMLConsumer handler) Serializes the action form as an element.
void	serializeActionMessage(javax.servlet.http.HttpServletRequest request, java.lang.String name, org.apache.struts.action.ActionMessage message, java.util.Locale locale, org.apache.struts.util.MessageResources res, XMLConsumer handler) Serializes the action message as an element.
void	serializeRequestAttribute(javax.servlet.http.HttpServletRequest request, java.lang.String name, XMLConsumer handler) Serializes the named request attribute as an element.
void	serializeRequestParameter(javax.servlet.http.HttpServletRequest request, java.lang.String name, XMLConsumer handler) Serializes the named request parameter as an element.
void	serializeResource(javax.servlet.http.HttpServletRequest request, java.util.Map resources, java.lang.String key, XMLConsumer handler) Serializes the resource as an element.

Method Detail

init

public void init(StxxProperties props)

Initializes the serializer

Parameters:

props - The stxx properties

serializeRequestParameter

public void serializeRequestParameter(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String name,
                                      XMLConsumer handler)
                               throws org.xml.sax.SAXException

Serializes the named request parameter as an element.

Parameters:

request - The http request

name - The name of the request parameter

handler - The SAX event consumer

Throws:

org.xml.sax.SAXException - If something goes wrong

serializeRequestAttribute

public void serializeRequestAttribute(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String name,
                                      XMLConsumer handler)
                               throws org.xml.sax.SAXException

Serializes the named request attribute as an element.

Parameters:

request - The http request

name - The name of the request attribute

handler - The SAX event consumer

Throws:

org.xml.sax.SAXException - If something goes wrong

serializeActionError

public void serializeActionError(javax.servlet.http.HttpServletRequest request,
                                 java.lang.String name,
                                 org.apache.struts.action.ActionError error,
                                 java.util.Locale locale,
                                 org.apache.struts.util.MessageResources res,
                                 XMLConsumer handler)
                          throws org.xml.sax.SAXException

Serializes the action error as an element.

Parameters:

request - The http request

name - The property name

error - The action error

locale - The current locale

res - The current resource bundle

handler - The SAX event consumer

Throws:

org.xml.sax.SAXException - If something goes wrong

serializeActionMessage

public void serializeActionMessage(javax.servlet.http.HttpServletRequest request,
                                   java.lang.String name,
                                   org.apache.struts.action.ActionMessage message,
                                   java.util.Locale locale,
                                   org.apache.struts.util.MessageResources res,
                                   XMLConsumer handler)
                            throws org.xml.sax.SAXException

Serializes the action message as an element.

Parameters:

request - The http request

name - The property name

message - The action message

locale - The current locale

res - The current resource bundle

handler - The SAX event consumer

Throws:

org.xml.sax.SAXException - If something goes wrong

serializeActionForm

public void serializeActionForm(javax.servlet.http.HttpServletRequest request,
                                java.lang.String name,
                                org.apache.struts.action.ActionForm form,
                                XMLConsumer handler)
                         throws org.xml.sax.SAXException

Serializes the action form as an element.

Parameters:

request - The http request

name - The name of the form

form - The action form

handler - The SAX event consumer

Throws:

org.xml.sax.SAXException - If something goes wrong

serializeResource

public void serializeResource(javax.servlet.http.HttpServletRequest request,
                              java.util.Map resources,
                              java.lang.String key,
                              XMLConsumer handler)
                       throws org.xml.sax.SAXException

Serializes the resource as an element.

Parameters:

request - The http request

resources - The resources

key - The resource key

handler - The SAX event consumer

Throws:

org.xml.sax.SAXException - If something goes wrong