org.jboss.axis.encoding
Interface SerializationContext

All Superinterfaces:

javax.xml.rpc.encoding.SerializationContext

public interface SerializationContext
extends javax.xml.rpc.encoding.SerializationContext

This interface describes the AXIS SerializationContext.

Method Summary

String	attributeQName2String(javax.xml.namespace.QName qName) Convert attribute QName to a string of the form : There are some special rules for attributes
void	endDocument() Output anything in the end.
void	endElement() Writes the end element tag for the open element.
Message	getCurrentMessage() Get the current message.
javax.xml.namespace.QName	getCurrentXMLType() Get the currently prefered xmlType `* @return QName of xmlType or null
boolean	getDoMultiRefs() Are we doing multirefs?
Stack	getElementStack() Get the stack of element qnames.
MessageContext	getMessageContext() Get the MessageContext we're operating with
String	getPrefixForURI(String uri) Get a prefix for a namespace URI.
String	getPrefixForURI(String uri, String defaultPrefix) Get a prefix for a namespace URI.
boolean	getPretty() Get whether the serialization should be pretty printed.
javax.xml.namespace.QName	getQNameForClass(Class cls) Get the QName associated with the specified class.
Serializer	getSerializerForJavaType(Class javaType) Convenience method to get the Serializer for a specific java type
TypeMapping	getTypeMapping() Get the TypeMapping we're using.
TypeMappingRegistry	getTypeMappingRegistry() Get the TypeMappingRegistry we're using.
String	getValueAsString(Object value, javax.xml.namespace.QName xmlType)
boolean	isNoDefaultNamespace() Get whether or not to write the default namespace.
boolean	isPrimitive(Object value) Indicates whether the object should be interpretted as a primitive for the purposes of multi-ref processing.
void	outputMultiRefs() The serialize method uses hrefs to reference all non-primitive values.
String	qName2String(javax.xml.namespace.QName qName) Convert QName to a string of the form :
void	registerPrefixForURI(String prefix, String uri) Register prefix for the indicated uri
void	serialize(javax.xml.namespace.QName elemQName, Attributes attributes, Object value) Serialize the indicated value as an element with the name indicated by elemQName.
void	serialize(javax.xml.namespace.QName elemQName, Attributes attributes, Object value, javax.xml.namespace.QName xmlType, boolean sendNull, Boolean sendType) Serialize the indicated value as an element with the name indicated by elemQName.
void	setDoMultiRefs(boolean shouldDo) Set whether we are doing multirefs.
void	setNoDefaultNamespace(boolean noDefaultNamespace) Set whether or not to write the default namespace.
void	setPretty(boolean pretty) Indicate whether the serialization should be pretty printed.
void	setSendDecl(boolean sendDecl) Set whether or not we should write XML declarations.
Attributes	setTypeAttribute(Attributes attributes, javax.xml.namespace.QName type) Obtains the type attribute that should be serialized and returns the new list of Attributes
boolean	shouldSendXSIType() Get whether or not to write xsi:type attributes.
void	startDocument() Output anything in the beginning.
void	startElement(javax.xml.namespace.QName qName, Attributes attributes) Writes (using the Writer) the start tag for element QName along with the indicated attributes and namespace mappings.
void	writeChars(char[] p1, int p2, int p3) Convenience operation to write out (to Writer) the characters in p1 starting at index p2 for length p3.
void	writeDOMElement(Element el) Output a DOM representation to a SerializationContext
void	writeSafeString(String string) Convenience operation to write out (to Writer) the String properly encoded with xml entities (like &)
void	writeString(String string) Convenience operation to write out (to Writer) the String

Method Detail

serialize

void serialize(javax.xml.namespace.QName elemQName,
               Attributes attributes,
               Object value)
               throws IOException

Serialize the indicated value as an element with the name indicated by elemQName. The attributes are additional attribute to be serialized on the element. The value is the object being serialized. (It may be serialized directly or serialized as an mult-ref'd item) The value is an Object, which may be a wrapped primitive, the javaType is the actual unwrapped object type. The xmlType (if specified) is the QName of the type that is used to set xsi:type. If not specified, xsi:type is set by using the javaType to find an appopriate xmlType from the TypeMappingRegistry. The sendNull flag indicates whether null values should be sent over the wire (default is to send such values with xsi:nil="true"). The sendType flag indicates whether the xsi:type flag should be sent (default is true).

Parameters:

elemQName - is the QName of the element

attributes - are additional attributes

value - is the object to serialize

Throws:

IOException

serialize

void serialize(javax.xml.namespace.QName elemQName,
               Attributes attributes,
               Object value,
               javax.xml.namespace.QName xmlType,
               boolean sendNull,
               Boolean sendType)
               throws IOException

Serialize the indicated value as an element with the name indicated by elemQName. The attributes are additional attribute to be serialized on the element. The value is the object being serialized. (It may be serialized directly or serialized as an mult-ref'd item) The xmlType (if specified) is the QName of the type that is used to set xsi:type. The sendNull flag indicates whether null values should be sent over the wire (default is to send such values with xsi:nil="true"). The sendType flag indicates whether the xsi:type flag should be sent (default is true).

Parameters:

elemQName - is the QName of the element

attributes - are additional attributes

value - is the object to serialize

xmlType - is the qname of the type or null. (default is null)

sendNull - determines whether to send null values. (default is true)

sendType - determines whether to set xsi:type attribute. (default is true)

Throws:

IOException

setTypeAttribute

Attributes setTypeAttribute(Attributes attributes,
                            javax.xml.namespace.QName type)

Obtains the type attribute that should be serialized and returns the new list of Attributes

Parameters:

attributes - of the qname

type - is the qname of the type

Returns:

new list of Attributes

getSerializerForJavaType

Serializer getSerializerForJavaType(Class javaType)

Convenience method to get the Serializer for a specific java type

Parameters:

javaType - is Class for a type to serialize

Returns:

Serializer

getPretty

boolean getPretty()

Get whether the serialization should be pretty printed.

Returns:

true/false

setPretty

void setPretty(boolean pretty)

Indicate whether the serialization should be pretty printed.

Parameters:

pretty - true/false

getDoMultiRefs

boolean getDoMultiRefs()

Are we doing multirefs?

Returns:

true or false

setDoMultiRefs

void setDoMultiRefs(boolean shouldDo)

Set whether we are doing multirefs.

Parameters:

shouldDo - true/false

setSendDecl

void setSendDecl(boolean sendDecl)

Set whether or not we should write XML declarations.

Parameters:

sendDecl - true/false

shouldSendXSIType

boolean shouldSendXSIType()

Get whether or not to write xsi:type attributes.

Returns:

true/false

getTypeMapping

TypeMapping getTypeMapping()

Get the TypeMapping we're using.

Returns:

TypeMapping or null

getTypeMappingRegistry

TypeMappingRegistry getTypeMappingRegistry()

Get the TypeMappingRegistry we're using.

Returns:

TypeMapping or null

getPrefixForURI

String getPrefixForURI(String uri)

Get a prefix for a namespace URI. This method will ALWAYS return a valid prefix - if the given URI is already mapped in this serialization, we return the previous prefix. If it is not mapped, we will add a new mapping and return a generated prefix of the form "ns<num>".

Parameters:

uri - is the namespace uri

Returns:

prefix

getPrefixForURI

String getPrefixForURI(String uri,
                       String defaultPrefix)

Get a prefix for a namespace URI. This method will ALWAYS return a valid prefix - if the given URI is already mapped in this serialization, we return the previous prefix. If it is not mapped, we will add a new mapping and return a generated prefix of the form "ns<num>".

Parameters:

uri - is the namespace uri

defaultPrefix - optional parameter which is the default prefix

Returns:

prefix

registerPrefixForURI

void registerPrefixForURI(String prefix,
                          String uri)

Register prefix for the indicated uri

Parameters:

prefix -

uri - is the namespace uri

getCurrentMessage

Message getCurrentMessage()

Get the current message.

Returns:

Message

getMessageContext

MessageContext getMessageContext()

Get the MessageContext we're operating with

qName2String

String qName2String(javax.xml.namespace.QName qName)

Convert QName to a string of the form :

Parameters:

qName -

Returns:

prefixed qname representation for serialization.

attributeQName2String

String attributeQName2String(javax.xml.namespace.QName qName)

Convert attribute QName to a string of the form : There are some special rules for attributes

Parameters:

qName -

Returns:

prefixed qname representation for serialization.

getQNameForClass

javax.xml.namespace.QName getQNameForClass(Class cls)

Get the QName associated with the specified class.

Parameters:

cls - Class of an object requiring serialization.

Returns:

appropriate QName associated with the class.

isPrimitive

boolean isPrimitive(Object value)

Indicates whether the object should be interpretted as a primitive for the purposes of multi-ref processing. A primitive value is serialized directly instead of using id/href pairs. Thus primitive serialization/deserialization is slightly faster.

Parameters:

value - to be serialized

Returns:

true/false

outputMultiRefs

void outputMultiRefs()
                     throws IOException

The serialize method uses hrefs to reference all non-primitive values. These values are stored and serialized by calling outputMultiRefs after the serialize method completes.

Throws:

IOException

startDocument

void startDocument()
                   throws IOException

Output anything in the beginning.

Throws:

IOException

endDocument

void endDocument()
                 throws IOException

Output anything in the end.

Throws:

IOException

startElement

void startElement(javax.xml.namespace.QName qName,
                  Attributes attributes)
                  throws IOException

Writes (using the Writer) the start tag for element QName along with the indicated attributes and namespace mappings.

Parameters:

qName - is the name of the element

attributes - are the attributes to write

Throws:

IOException

endElement

void endElement()
                throws IOException

Writes the end element tag for the open element.

Throws:

IOException

writeChars

void writeChars(char[] p1,
                int p2,
                int p3)
                throws IOException

Convenience operation to write out (to Writer) the characters in p1 starting at index p2 for length p3.

Parameters:

p1 - character array to write

p2 - starting index in array

p3 - length to write

Throws:

IOException

writeString

void writeString(String string)
                 throws IOException

Convenience operation to write out (to Writer) the String

Parameters:

string - is the String to write.

Throws:

IOException

writeSafeString

void writeSafeString(String string)
                     throws IOException

Convenience operation to write out (to Writer) the String properly encoded with xml entities (like &)

Parameters:

string - is the String to write.

Throws:

IOException

writeDOMElement

void writeDOMElement(Element el)
                     throws IOException

Output a DOM representation to a SerializationContext

Parameters:

el - is a DOM Element

Throws:

IOException

getValueAsString

String getValueAsString(Object value,
                        javax.xml.namespace.QName xmlType)
                        throws IOException

Throws:

IOException

getElementStack

Stack getElementStack()

Get the stack of element qnames.

getCurrentXMLType

javax.xml.namespace.QName getCurrentXMLType()

Get the currently prefered xmlType `* @return QName of xmlType or null

isNoDefaultNamespace

boolean isNoDefaultNamespace()

Get whether or not to write the default namespace.

Returns:

true/false

setNoDefaultNamespace

void setNoDefaultNamespace(boolean noDefaultNamespace)

Set whether or not to write the default namespace.