soaprmi.soap
Interface SerializeContext

All Known Subinterfaces:

SoapSerializeContext

All Known Implementing Classes:

SoapSerializeContextImpl

public interface SerializeContext

Define set of operations that must be supported for SOAP serialization.

Version:

$Revision: 1.5 $

Author:

Aleksander Slominski

Method Summary

java.lang.String	addId(java.lang.Object obj) Add object to id-table and return assigned id.
java.lang.String	addRef(Serializer typeSer, EncodingStyle typeEnc, java.lang.Object typeValue, java.lang.String name, java.lang.Class baseClass)
void	close()
void	done()
void	enterStruct()
EncodingStyle	getDefaultEncodingStyle()
java.lang.String	getId(java.lang.Object value) Return id for object or null if object has no id.
XmlJavaMapping	getMapping()
SoapStyle	getSoapStyle()
java.io.Writer	getWriter()
void	leaveStruct()
Serializer	querySerializer(EncodingStyle enc, java.lang.Class klass)
XmlJavaTypeMap	queryTypeMap(java.lang.Class javaClass)
void	setDefaultEncodingStyle(EncodingStyle enc)
void	setMapping(XmlJavaMapping mapping)
java.lang.String	setObjectId(java.lang.Object obj, java.lang.String id) Assign to object new id.
void	setSoapStyle(SoapStyle style)
void	setWriter(java.io.Writer writer)
int	structLevel()
void	writeEndTag(java.lang.String name)
void	writeFloat(float f)
void	writeFloat(float f, java.lang.String name)
void	writeInt(int i)
void	writeInt(int i, java.lang.String name)
void	writeNamespaces()
void	writeObject(java.lang.Object o)
void	writeObject(java.lang.Object o, java.lang.String name)
void	writeObject(java.lang.Object o, java.lang.String name, java.lang.Class baseType)
void	writeRef(java.lang.String name, java.lang.String href)
java.lang.String	writeStartStartTag(java.lang.String name, java.lang.String uri, java.lang.String localName, boolean forceXsiType, java.lang.String id)
java.lang.String	writeStartTag(java.lang.String name, java.lang.String uri, java.lang.String localName, boolean forceXsiType, java.lang.String id)
void	writeString(java.lang.String s)
void	writeString(java.lang.String s, java.lang.String name)
void	writeXmlns(java.lang.String prefix, java.lang.String uri)
void	writeXmlnsLevel(java.lang.String uri)
void	writeXsdType(java.lang.String localName)
void	writeXsiNull()
void	writeXsiNull(java.lang.String name)
void	writeXsiNull(java.lang.String name, java.lang.String uri, java.lang.String localName)
void	writeXsiType(java.lang.String uri, java.lang.String localName)

Method Detail

getDefaultEncodingStyle

public EncodingStyle getDefaultEncodingStyle()

setDefaultEncodingStyle

public void setDefaultEncodingStyle(EncodingStyle enc)

getMapping

public XmlJavaMapping getMapping()

setMapping

public void setMapping(XmlJavaMapping mapping)

getWriter

public java.io.Writer getWriter()

setWriter

public void setWriter(java.io.Writer writer)
               throws SerializeException

Throws:

SerializeException

getSoapStyle

public SoapStyle getSoapStyle()

setSoapStyle

public void setSoapStyle(SoapStyle style)

writeObject

public void writeObject(java.lang.Object o,
                        java.lang.String name,
                        java.lang.Class baseType)
                 throws SerializeException,
                        java.io.IOException

Throws:

SerializeException

java.io.IOException

writeObject

public void writeObject(java.lang.Object o,
                        java.lang.String name)
                 throws SerializeException,
                        java.io.IOException

Throws:

SerializeException

java.io.IOException

writeObject

public void writeObject(java.lang.Object o)
                 throws SerializeException,
                        java.io.IOException

Throws:

SerializeException

java.io.IOException

writeFloat

public void writeFloat(float f,
                       java.lang.String name)
                throws SerializeException,
                       java.io.IOException

Throws:

SerializeException

java.io.IOException

writeFloat

public void writeFloat(float f)
                throws SerializeException,
                       java.io.IOException

Throws:

SerializeException

java.io.IOException

writeInt

public void writeInt(int i,
                     java.lang.String name)
              throws SerializeException,
                     java.io.IOException

Throws:

SerializeException

java.io.IOException

writeInt

public void writeInt(int i)
              throws SerializeException,
                     java.io.IOException

Throws:

SerializeException

java.io.IOException

writeString

public void writeString(java.lang.String s,
                        java.lang.String name)
                 throws SerializeException,
                        java.io.IOException

Throws:

SerializeException

java.io.IOException

writeString

public void writeString(java.lang.String s)
                 throws SerializeException,
                        java.io.IOException

Throws:

SerializeException

java.io.IOException

done

public void done()
          throws SerializeException,
                 java.io.IOException

Throws:

SerializeException

java.io.IOException

close

public void close()
           throws SerializeException,
                  java.io.IOException

Throws:

SerializeException

java.io.IOException

queryTypeMap

public XmlJavaTypeMap queryTypeMap(java.lang.Class javaClass)
                            throws SerializeException,
                                   XmlMapException

Throws:

SerializeException

XmlMapException

querySerializer

public Serializer querySerializer(EncodingStyle enc,
                                  java.lang.Class klass)
                           throws SerializeException,
                                  java.io.IOException

Throws:

SerializeException

java.io.IOException

writeXsiNull

public void writeXsiNull(java.lang.String name,
                         java.lang.String uri,
                         java.lang.String localName)
                  throws SerializeException,
                         java.io.IOException

Throws:

SerializeException

java.io.IOException

writeXsiNull

public void writeXsiNull(java.lang.String name)
                  throws SerializeException,
                         java.io.IOException

Throws:

SerializeException

java.io.IOException

writeXsiNull

public void writeXsiNull()
                  throws SerializeException,
                         java.io.IOException

Throws:

SerializeException

java.io.IOException

writeXsiType

public void writeXsiType(java.lang.String uri,
                         java.lang.String localName)
                  throws SerializeException,
                         java.io.IOException

Throws:

SerializeException

java.io.IOException

writeXsdType

public void writeXsdType(java.lang.String localName)
                  throws SerializeException,
                         java.io.IOException

Throws:

SerializeException

java.io.IOException

writeNamespaces

public void writeNamespaces()
                     throws SerializeException,
                            java.io.IOException

Throws:

SerializeException

java.io.IOException

writeXmlns

public void writeXmlns(java.lang.String prefix,
                       java.lang.String uri)
                throws SerializeException,
                       java.io.IOException

Throws:

SerializeException

java.io.IOException

writeXmlnsLevel

public void writeXmlnsLevel(java.lang.String uri)
                     throws SerializeException,
                            java.io.IOException

Throws:

SerializeException

java.io.IOException

writeRef

public void writeRef(java.lang.String name,
                     java.lang.String href)
              throws SerializeException,
                     java.io.IOException

Throws:

SerializeException

java.io.IOException

writeStartStartTag

public java.lang.String writeStartStartTag(java.lang.String name,
                                           java.lang.String uri,
                                           java.lang.String localName,
                                           boolean forceXsiType,
                                           java.lang.String id)
                                    throws SerializeException,
                                           java.io.IOException

Throws:

SerializeException

java.io.IOException

writeStartTag

public java.lang.String writeStartTag(java.lang.String name,
                                      java.lang.String uri,
                                      java.lang.String localName,
                                      boolean forceXsiType,
                                      java.lang.String id)
                               throws SerializeException,
                                      java.io.IOException

Throws:

SerializeException

java.io.IOException

writeEndTag

public void writeEndTag(java.lang.String name)
                 throws SerializeException,
                        java.io.IOException

Throws:

SerializeException

java.io.IOException

enterStruct

public void enterStruct()

leaveStruct

public void leaveStruct()

structLevel

public int structLevel()

addRef

public java.lang.String addRef(Serializer typeSer,
                               EncodingStyle typeEnc,
                               java.lang.Object typeValue,
                               java.lang.String name,
                               java.lang.Class baseClass)

addId

public java.lang.String addId(java.lang.Object obj)

Add object to id-table and return assigned id. This function can be call multiple times and always returns the same id.

Parameters:

obj - must be not null

Returns:

id assigned to object

getId

public java.lang.String getId(java.lang.Object value)

Return id for object or null if object has no id.

setObjectId

public java.lang.String setObjectId(java.lang.Object obj,
                                    java.lang.String id)

Assign to object new id.

Parameters:

obj - must be not null

id - assigned to object

Returns:

previous id or null if object had no id previously