be.ac.ulg.montefiore.run.totem.util.jaxb.runtime
Interface XMLSerializer

All Known Implementing Classes:

MSVValidator, SAXMarshaller

public interface XMLSerializer

Receives XML serialization event

This object coordinates the overall marshalling efforts across different content-tree objects and different target formats.

The following CFG gives the proper sequence of method invocation.

 MARSHALLING  :=  ELEMENT
 ELEMENT      :=  "startElement" NSDECL* "endNamespaceDecls"
                        ATTRIBUTE* "endAttributes" BODY "endElement"
 
 NSDECL       :=  "declareNamespace"
 
 ATTRIBUTE    :=  "startAttribute" ATTVALUES "endAttribute"
 ATTVALUES    :=  "text"*
 
 
 BODY         :=  ( "text" | ELEMENT )*
 

A marshalling of one element consists of two stages. The first stage is for marshalling attributes and collecting namespace declarations. The second stage is for marshalling characters/child elements of that element.

Observe that multiple invocation of "text" is allowed.

Also observe that the namespace declarations are allowed only between "startElement" and "endAttributes".

Author:

Kohsuke Kawaguchi

Method Summary

void	childAsAttributes(com.sun.xml.bind.JAXBObject o, java.lang.String fieldName) This method is called when an JAXBObject object is found while the marshaller is in the "attribute" mode (i.e.
void	childAsBody(com.sun.xml.bind.JAXBObject o, java.lang.String fieldName) This method is called when an JAXBObject object is found while the marshaller is in the "element" mode (i.e.
void	childAsURIs(com.sun.xml.bind.JAXBObject o, java.lang.String fieldName) This method is called when an JAXBObject object is found while the marshaller is in the "URI" mode.
void	endAttribute()
void	endAttributes() Switches to the mode to marshal child texts/elements.
void	endElement() Ends marshalling of an element.
void	endNamespaceDecls() Switches to the mode to marshal attribute values.
NamespaceContext2	getNamespaceContext() Obtains a namespace context object, which is used to declare/obtain namespace bindings.
java.lang.String	onID(com.sun.xml.bind.marshaller.IdentifiableObject owner, java.lang.String value) Notifies the serializer that an ID value has just marshalled.
java.lang.String	onIDREF(com.sun.xml.bind.marshaller.IdentifiableObject obj) Notifies the serializer that an IDREF value has just marshalled.
void	reportError(javax.xml.bind.ValidationEvent e) Errors detected by the XMLSerializable should be either thrown as SAXException or reported through this method.
void	startAttribute(java.lang.String uri, java.lang.String local) Starts marshalling of an attribute.
void	startElement(java.lang.String uri, java.lang.String local) Starts marshalling of an element.
void	text(java.lang.String text, java.lang.String fieldName) Marshalls text.

Method Detail

reportError

void reportError(javax.xml.bind.ValidationEvent e)
                 throws com.sun.xml.bind.serializer.AbortSerializationException

Errors detected by the XMLSerializable should be either thrown as SAXException or reported through this method. The callee should report an error to the client application and

Throws:

com.sun.xml.bind.serializer.AbortSerializationException

startElement

void startElement(java.lang.String uri,
                  java.lang.String local)
                  throws org.xml.sax.SAXException

Starts marshalling of an element. Calling this method will push the internal state into the internal stack.

Throws:

org.xml.sax.SAXException

endNamespaceDecls

void endNamespaceDecls()
                       throws org.xml.sax.SAXException

Switches to the mode to marshal attribute values. This method has to be called after the 1st pass is completed.

Throws:

org.xml.sax.SAXException

endAttributes

void endAttributes()
                   throws org.xml.sax.SAXException

Switches to the mode to marshal child texts/elements. This method has to be called after the 2nd pass is completed.

Throws:

org.xml.sax.SAXException

endElement

void endElement()
                throws org.xml.sax.SAXException

Ends marshalling of an element. Pops the internal stack.

Throws:

org.xml.sax.SAXException

text

void text(java.lang.String text,
          java.lang.String fieldName)
          throws org.xml.sax.SAXException

Marshalls text.

This method can be called (i) after the startAttribute method and (ii) before the endAttribute method, to marshal attribute values. If the method is called more than once, those texts are considered as separated by whitespaces. For example,

 c.startAttribute();
 c.text("abc");
 c.text("def");
 c.endAttribute("","foo");
 

will generate foo="abc def".

Similarly, this method can be called after the endAttributes method to marshal texts inside elements. The same rule about multiple invokations apply to this case, too. For example,

 c.startElement("","foo");
 c.endNamespaceDecls();
 c.endAttributes();
 c.text("abc");
 c.text("def");
   c.startElement("","bar");
   c.endAttributes();
   c.endElement();
 c.text("ghi");
 c.endElement();
 

will generate <foo>abc def<bar/>ghi</foo>.

Throws:

org.xml.sax.SAXException

startAttribute

void startAttribute(java.lang.String uri,
                    java.lang.String local)
                    throws org.xml.sax.SAXException

Starts marshalling of an attribute. The marshalling of an attribute will be done by

1. call the startAttribute method
2. call the text method (several times if necessary)
3. call the endAttribute method

No two attributes can be marshalled at the same time. Note that the whole attribute marshalling must be happened after the startElement method and before the endAttributes method.

Throws:

org.xml.sax.SAXException

endAttribute

void endAttribute()
                  throws org.xml.sax.SAXException

Throws:

org.xml.sax.SAXException

getNamespaceContext

NamespaceContext2 getNamespaceContext()

Obtains a namespace context object, which is used to declare/obtain namespace bindings.

onID

java.lang.String onID(com.sun.xml.bind.marshaller.IdentifiableObject owner,
                      java.lang.String value)
                      throws org.xml.sax.SAXException

Notifies the serializer that an ID value has just marshalled. The serializer may or may not check the consistency of ID/IDREFs and may throw a SAXException.

Parameters:

owner - JAXB content object that posesses the ID.

value - The value of the ID.

Returns:

Return the value parameter without any modification, so that the invocation of this method can be done transparently by a transducer.

Throws:

org.xml.sax.SAXException

onIDREF

java.lang.String onIDREF(com.sun.xml.bind.marshaller.IdentifiableObject obj)
                         throws org.xml.sax.SAXException

Notifies the serializer that an IDREF value has just marshalled. The serializer may or may not check the consistency of ID/IDREFs and may throw a SAXException.

Returns:

Return the value parameter without any modification. so that the invocation of this method can be done transparently by a transducer.

Throws:

org.xml.sax.SAXException

childAsBody

void childAsBody(com.sun.xml.bind.JAXBObject o,
                 java.lang.String fieldName)
                 throws org.xml.sax.SAXException

This method is called when an JAXBObject object is found while the marshaller is in the "element" mode (i.e. marshalling a content model of an element)

Parameters:

fieldName - property name of the parent objeect from which 'o' comes. Used as a part of the error message in case anything goes wrong with 'o'.

Throws:

org.xml.sax.SAXException

childAsAttributes

void childAsAttributes(com.sun.xml.bind.JAXBObject o,
                       java.lang.String fieldName)
                       throws org.xml.sax.SAXException

This method is called when an JAXBObject object is found while the marshaller is in the "attribute" mode (i.e. marshalling attributes of an element)

Parameters:

fieldName - property name of the parent objeect from which 'o' comes. Used as a part of the error message in case anything goes wrong with 'o'.

Throws:

org.xml.sax.SAXException

childAsURIs

void childAsURIs(com.sun.xml.bind.JAXBObject o,
                 java.lang.String fieldName)
                 throws org.xml.sax.SAXException

This method is called when an JAXBObject object is found while the marshaller is in the "URI" mode.

Parameters:

fieldName - property name of the parent objeect from which 'o' comes. Used as a part of the error message in case anything goes wrong with 'o'.

Throws:

org.xml.sax.SAXException