Class DeserializationContext

Method Details

• deserializing

  public void deserializing(boolean isDeserializing)

• getSOAPConstants

  public SOAPConstants getSOAPConstants()

  returns the soap constants.

• parse

  public void parse() throws SAXException

  Create a parser and parse the inputSource

  Throws:

  SAXException

• getCurElement

  public MessageElement getCurElement()

  Get current MessageElement

• setCurElement

  public void setCurElement(MessageElement el)

  Set current MessageElement

• getMessageContext

  public MessageContext getMessageContext()

  Get MessageContext

• getEncodingStyle

  public String getEncodingStyle()

  Returns this context's encoding style. If we've got a message context then we'll get the style from that; otherwise we'll return a default.

  Returns:

  a String value

• getEnvelope

  public SOAPEnvelope getEnvelope()

  Get Envelope

• getRecorder

  public SAX2EventRecorder getRecorder()

  Get Event Recorder

• setRecorder

  public void setRecorder(SAX2EventRecorder recorder)

  Set Event Recorder

• getCurrentNSMappings

  public ArrayList getCurrentNSMappings()

  Get the Namespace Mappings. Returns null if none are present.

• getNamespaceURI

  public String getNamespaceURI(String prefix)

  Get the Namespace for a particular prefix

• getQNameFromString

  public QName getQNameFromString(String qNameStr)

  Construct a QName from a string of the form :

  Parameters:

  qNameStr - is the prefixed name from the xml text

  Returns:

  QName

• getTypeFromXSITypeAttr

  public QName getTypeFromXSITypeAttr(String namespace, String localName, Attributes attrs)

  Create a QName for the type of the element defined by localName and namespace from the XSI type.

  Parameters:

  namespace - of the element

  localName - is the local name of the element

  attrs - are the attributes on the element

• getTypeFromAttributes

  public QName getTypeFromAttributes(String namespace, String localName, Attributes attrs)

  Create a QName for the type of the element defined by localName and namespace with the specified attributes.

  Parameters:

  namespace - of the element

  localName - is the local name of the element

  attrs - are the attributes on the element

• isNil

  public boolean isNil(Attributes attrs)

  Convenenience method that returns true if the value is nil (due to the xsi:nil) attribute.

  Parameters:

  attrs - are the element attributes.

  Returns:

  true if xsi:nil is true

• getDeserializer

  public final Deserializer getDeserializer(Class cls, QName xmlType)

  Get a Deserializer which can turn a given xml type into a given Java type

• getDeserializerForClass

  public Deserializer getDeserializerForClass(Class cls)

  Convenience method to get the Deserializer for a specific java class from its meta data.

  Parameters:

  cls - is the Class used to find the deserializer

  Returns:

  Deserializer

• setDestinationClass

  public void setDestinationClass(Class destClass)

  Allows the destination class to be set so that downstream deserializers like ArrayDeserializer can pick it up when deserializing its components using getDeserializerForClass

  Parameters:

  destClass - is the Class of the component to be deserialized

• getDestinationClass

  public Class getDestinationClass()

  Allows the destination class to be retrieved so that downstream deserializers like ArrayDeserializer can pick it up when deserializing its components using getDeserializerForClass

  Returns:

  the Class of the component to be deserialized

• getDeserializerForType

  public final Deserializer getDeserializerForType(QName xmlType)

  Convenience method to get the Deserializer for a specific xmlType.

  Parameters:

  xmlType - is QName for a type to deserialize

  Returns:

  Deserializer

• getTypeMapping

  public TypeMapping getTypeMapping()

  Get the TypeMapping for this DeserializationContext

• getTypeMappingRegistry

  public TypeMappingRegistry getTypeMappingRegistry()

  Get the TypeMappingRegistry we're using.

  Returns:

  TypeMapping or null

• getElementByID

  public MessageElement getElementByID(String id)

  Get the MessageElement for the indicated id (where id is the #value of an href) If the MessageElement has not been processed, the MessageElement will be returned. If the MessageElement has been processed, the actual object value is stored with the id and this routine will return null.

  Parameters:

  id - is the value of an href attribute

  Returns:

  MessageElement or null

• getObjectByRef

  public Object getObjectByRef(String href)

  Gets the MessageElement or actual Object value associated with the href value. The return of a MessageElement indicates that the referenced element has not been processed. If it is not a MessageElement, the Object is the actual deserialized value. In addition, this method is invoked to get Object values via Attachments.

  Parameters:

  href - is the value of an href attribute (or an Attachment id)

  Returns:

  MessageElement other Object or null

• addObjectById

  public void addObjectById(String id, Object obj)

  Add the object associated with this id (where id is the value of an id= attribute, i.e. it does not start with #). This routine is called to associate the deserialized object with the id specified on the XML element.

  Parameters:

  id - (id name without the #)

  obj - is the deserialized object for this id.

• registerFixup

  public void registerFixup(String href, Deserializer dser)

  During deserialization, an element with an href=#id may be encountered before the element defining id=id is read. In these cases, the getObjectByRef method above will return null. The deserializer is placed in a table keyed by href (a fixup table). After the element id is processed, the deserializer is informed of the value so that it can update its target(s) with the value.

  Parameters:

  href - (#id syntax)

  dser - is the deserializer of the element

• registerElementByID

  public void registerElementByID(String id, MessageElement elem)

  Register the MessageElement with this id (where id is id= form without the #) This routine is called when the MessageElement with an id is read. If there is a Deserializer in our fixup list (described above), the 'fixup' deserializer is given to the MessageElement. When the MessageElement is completed, the 'fixup' deserializer is informed and it can set its targets.

  Parameters:

  id - (id name without the #)

  elem - is the MessageElement

• registerResolverForID

  public void registerResolverForID(String id, IDResolver resolver)

  Each id can have its own kind of resolver. This registers a resolver for the id.

• hasElementsByID

  public boolean hasElementsByID()

  Return true if any ids are being tracked by this DeserializationContext

  Returns:

  true if any ides are being tracked by this DeserializationContext

• getCurrentRecordPos

  public int getCurrentRecordPos()

  Get the current position in the record.

• getStartOfMappingsPos

  public int getStartOfMappingsPos()

  Get the start of the mapping position

• pushNewElement

  public void pushNewElement(MessageElement elem)

  Push the MessageElement into the recorder

• pushElementHandler

  public void pushElementHandler(SOAPHandler handler)

  Management of sub-handlers (deserializers)

• replaceElementHandler

  public void replaceElementHandler(SOAPHandler handler)

  Replace the handler at the top of the stack. This is only used when we have a placeholder Deserializer for a referenced object which doesn't know its type until we hit the referent.

• popElementHandler

  public SOAPHandler popElementHandler()

• setProcessingRef

  public void setProcessingRef(boolean ref)

• isProcessingRef

  public boolean isProcessingRef()

• startDocument

  public void startDocument() throws SAXException

  SAX event handlers

  Specified by:

  startDocument in interface ContentHandler

  Overrides:

  startDocument in class DefaultHandler

  Throws:

  SAXException

• endDocument

  public void endDocument() throws SAXException

  endDocument is invoked at the end of the document.

  Specified by:

  endDocument in interface ContentHandler

  Overrides:

  endDocument in class DefaultHandler

  Throws:

  SAXException

• isDoneParsing

  public boolean isDoneParsing()

  Return if done parsing document.

• startPrefixMapping

  public void startPrefixMapping(String prefix, String uri) throws SAXException

  Record the current set of prefix mappings in the nsMappings table. !!! We probably want to have this mapping be associated with the MessageElements, since they may potentially need access to them long after the end of the prefix mapping here. (example: when we need to record a long string of events scanning forward in the document to find an element with a particular ID.)

  Specified by:

  startPrefixMapping in interface ContentHandler

  Overrides:

  startPrefixMapping in class DefaultHandler

  Throws:

  SAXException

• endPrefixMapping

  public void endPrefixMapping(String prefix) throws SAXException

  Specified by:

  endPrefixMapping in interface ContentHandler

  Overrides:

  endPrefixMapping in class DefaultHandler

  Throws:

  SAXException

• setDocumentLocator

  public void setDocumentLocator(Locator locator)

  Specified by:

  setDocumentLocator in interface ContentHandler

  Overrides:

  setDocumentLocator in class DefaultHandler

• getDocumentLocator

  public Locator getDocumentLocator()

• characters

  public void characters(char[] p1, int p2, int p3) throws SAXException

  Specified by:

  characters in interface ContentHandler

  Overrides:

  characters in class DefaultHandler

  Throws:

  SAXException

• ignorableWhitespace

  public void ignorableWhitespace(char[] p1, int p2, int p3) throws SAXException

  Specified by:

  ignorableWhitespace in interface ContentHandler

  Overrides:

  ignorableWhitespace in class DefaultHandler

  Throws:

  SAXException

• processingInstruction

  public void processingInstruction(String p1, String p2) throws SAXException

  Specified by:

  processingInstruction in interface ContentHandler

  Overrides:

  processingInstruction in class DefaultHandler

  Throws:

  SAXException

• skippedEntity

  public void skippedEntity(String p1) throws SAXException

  Specified by:

  skippedEntity in interface ContentHandler

  Overrides:

  skippedEntity in class DefaultHandler

  Throws:

  SAXException

• startElement

  public void startElement(String namespace, String localName, String qName, Attributes attributes) throws SAXException

  startElement is called when an element is read. This is the big work-horse. This guy also handles monitoring the recording depth if we're recording (so we know when to stop).

  Specified by:

  startElement in interface ContentHandler

  Overrides:

  startElement in class DefaultHandler

  Throws:

  SAXException

• endElement

  public void endElement(String namespace, String localName, String qName) throws SAXException

  endElement is called at the end tag of an element

  Specified by:

  endElement in interface ContentHandler

  Overrides:

  endElement in class DefaultHandler

  Throws:

  SAXException

• startDTD

  public void startDTD(String name, String publicId, String systemId) throws SAXException

  Specified by:

  startDTD in interface LexicalHandler

  Throws:

  SAXException

• endDTD

  public void endDTD() throws SAXException

  Specified by:

  endDTD in interface LexicalHandler

  Throws:

  SAXException

• startEntity

  public void startEntity(String name) throws SAXException

  Specified by:

  startEntity in interface LexicalHandler

  Throws:

  SAXException

• endEntity

  public void endEntity(String name) throws SAXException

  Specified by:

  endEntity in interface LexicalHandler

  Throws:

  SAXException

• startCDATA

  public void startCDATA() throws SAXException

  Specified by:

  startCDATA in interface LexicalHandler

  Throws:

  SAXException

• endCDATA

  public void endCDATA() throws SAXException

  Specified by:

  endCDATA in interface LexicalHandler

  Throws:

  SAXException

• comment

  public void comment(char[] ch, int start, int length) throws SAXException

  Specified by:

  comment in interface LexicalHandler

  Throws:

  SAXException

• resolveEntity

  public InputSource resolveEntity(String publicId, String systemId)

  Specified by:

  resolveEntity in interface EntityResolver

  Overrides:

  resolveEntity in class DefaultHandler