org.tagnetic.core.jaxb.tagneticconfig.impl.runtime
Class SAXMarshaller

java.lang.Object
  extended byorg.tagnetic.core.jaxb.tagneticconfig.impl.runtime.SAXMarshaller
All Implemented Interfaces:
XMLSerializer

public class SAXMarshaller
extends java.lang.Object
implements XMLSerializer

XMLSerializer that produces SAX2 events. To marshal an object, create an instance of SAXMarshaller and call the serializeElements method of the XMLSerializable object that you want to marshal.

Author:
Kohsuke Kawaguchi

Constructor Summary
SAXMarshaller(org.xml.sax.ContentHandler _writer, NamespacePrefixMapper prefixMapper, MarshallerImpl _owner)
          Creates a marshalling context by designating the ContentHandler that receives generated SAX2 events.
 
Method Summary
 void childAsAttributes(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(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(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 "marshal child texts/elements" mode.
 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(IdentifiableObject owner, java.lang.String value)
          Notifies the serializer that an ID value has just marshalled.
 java.lang.String onIDREF(IdentifiableObject obj)
          Notifies the serializer that an IDREF value has just marshalled.
 void reportError(ValidationEvent ve)
          Errors detected by the XMLSerializable should be either thrown as SAXException or reported through this method.
 void reportMissingObjectError(java.lang.String fieldName)
           
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SAXMarshaller

public SAXMarshaller(org.xml.sax.ContentHandler _writer,
                     NamespacePrefixMapper prefixMapper,
                     MarshallerImpl _owner)
Creates a marshalling context by designating the ContentHandler that receives generated SAX2 events.

Method Detail

getNamespaceContext

public NamespaceContext2 getNamespaceContext()
Description copied from interface: XMLSerializer
Obtains a namespace context object, which is used to declare/obtain namespace bindings.

Specified by:
getNamespaceContext in interface XMLSerializer

startElement

public 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.

Specified by:
startElement in interface XMLSerializer
Throws:
org.xml.sax.SAXException

endNamespaceDecls

public void endNamespaceDecls()
                       throws org.xml.sax.SAXException
Description copied from interface: XMLSerializer
Switches to the mode to marshal attribute values. This method has to be called after the 1st pass is completed.

Specified by:
endNamespaceDecls in interface XMLSerializer
Throws:
org.xml.sax.SAXException

endAttributes

public void endAttributes()
                   throws org.xml.sax.SAXException
Switches to the "marshal child texts/elements" mode. This method has to be called after the 1st pass is completed.

Specified by:
endAttributes in interface XMLSerializer
Throws:
org.xml.sax.SAXException

endElement

public void endElement()
                throws org.xml.sax.SAXException
Ends marshalling of an element. Pops the internal stack.

Specified by:
endElement in interface XMLSerializer
Throws:
org.xml.sax.SAXException

text

public 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.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>.

Specified by:
text in interface XMLSerializer
Throws:
org.xml.sax.SAXException

startAttribute

public void startAttribute(java.lang.String uri,
                           java.lang.String local)
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.

Specified by:
startAttribute in interface XMLSerializer

endAttribute

public void endAttribute()
Specified by:
endAttribute in interface XMLSerializer

onID

public java.lang.String onID(IdentifiableObject owner,
                             java.lang.String value)
                      throws org.xml.sax.SAXException
Description copied from interface: XMLSerializer
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.

Specified by:
onID in interface XMLSerializer
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

public java.lang.String onIDREF(IdentifiableObject obj)
                         throws org.xml.sax.SAXException
Description copied from interface: XMLSerializer
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.

Specified by:
onIDREF in interface XMLSerializer
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

public void childAsBody(JAXBObject o,
                        java.lang.String fieldName)
                 throws org.xml.sax.SAXException
Description copied from interface: XMLSerializer
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)

Specified by:
childAsBody in interface XMLSerializer
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

public void childAsAttributes(JAXBObject o,
                              java.lang.String fieldName)
                       throws org.xml.sax.SAXException
Description copied from interface: XMLSerializer
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)

Specified by:
childAsAttributes in interface XMLSerializer
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

public void childAsURIs(JAXBObject o,
                        java.lang.String fieldName)
                 throws org.xml.sax.SAXException
Description copied from interface: XMLSerializer
This method is called when an JAXBObject object is found while the marshaller is in the "URI" mode.

Specified by:
childAsURIs in interface XMLSerializer
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

reportError

public void reportError(ValidationEvent ve)
                 throws AbortSerializationException
Description copied from interface: XMLSerializer
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

Specified by:
reportError in interface XMLSerializer
Throws:
AbortSerializationException

reportMissingObjectError

public void reportMissingObjectError(java.lang.String fieldName)
                              throws org.xml.sax.SAXException
Throws:
org.xml.sax.SAXException


Copyright © 2005 tagnetic.org. All Rights Reserved.