public class DeserializerImpl extends SOAPHandler implements Deserializer, Deserializer, Callback
Modifier and Type | Field and Description |
---|---|
protected boolean |
componentsReadyFlag |
protected QName |
defaultType |
protected String |
id |
protected boolean |
isEnded |
protected boolean |
isHref |
protected boolean |
isNil |
protected static org.apache.commons.logging.Log |
log |
protected Vector |
targets |
protected Object |
value |
myElement
Constructor and Description |
---|
DeserializerImpl() |
Modifier and Type | Method and Description |
---|---|
void |
addChildDeserializer(Deserializer dSer) |
boolean |
componentsReady()
Some deserializers (ArrayDeserializer) require
all of the component values to be known before the
value is complete.
|
void |
endElement(String namespace,
String localName,
DeserializationContext context)
endElement is called when the end element tag is reached.
|
QName |
getDefaultType() |
String |
getMechanismType()
JAX-RPC compliant method which returns mechanism type.
|
Object |
getValue()
Get the deserialized value.
|
Object |
getValue(Object hint)
If the deserializer has component values (like ArrayDeserializer)
this method gets the specific component via the hint.
|
Vector |
getValueTargets()
Get the Value Targets of the Deserializer.
|
void |
moveValueTargets(Deserializer other)
Move someone else's targets to our own (see DeserializationContext)
The DeserializationContext only allows one Deserializer to
wait for a unknown multi-ref'ed value.
|
void |
onEndElement(String namespace,
String localName,
DeserializationContext context)
onEndElement is called by endElement.
|
SOAPHandler |
onStartChild(String namespace,
String localName,
String prefix,
Attributes attributes,
DeserializationContext context)
onStartChild is called on each child element.
|
void |
onStartElement(String namespace,
String localName,
String prefix,
Attributes attributes,
DeserializationContext context)
This method is invoked after startElement when the element requires
deserialization (i.e. the element is not an href and the value is not nil.)
|
void |
registerValueTarget(Target target)
For deserializers of non-primitives, the value may not be
known until later (due to multi-referencing).
|
void |
removeValueTargets()
Remove the Value Targets of the Deserializer.
|
void |
setChildValue(Object value,
Object hint)
If the deserializer has component values (like ArrayDeserializer)
this method sets the specific component via the hint.
|
void |
setDefaultType(QName qName)
In some circumstances an element may not have
a type attribute, but a default type qname is known from
information in the container.
|
void |
setValue(Object value)
Set the deserialized value.
|
void |
setValue(Object value,
Object hint) |
void |
startElement(String namespace,
String localName,
String prefix,
Attributes attributes,
DeserializationContext context)
This method is invoked when an element start tag is encountered.
|
void |
valueComplete()
The valueComplete() method is invoked when the
end tag of the element is read.
|
characters, makeNewElement, onEndChild
endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning
protected static org.apache.commons.logging.Log log
protected Object value
protected boolean isEnded
protected Vector targets
protected QName defaultType
protected boolean componentsReadyFlag
protected boolean isHref
protected boolean isNil
protected String id
public String getMechanismType()
getMechanismType
in interface Deserializer
public Object getValue()
public void setValue(Object value)
value
- Object representing deserialized valuepublic Object getValue(Object hint)
public void setChildValue(Object value, Object hint) throws SAXException
hint
- Object representing deserialized value or nullvalue
- Object representing deserialized value or nullSAXException
public void setValue(Object value, Object hint) throws SAXException
setValue
in interface Callback
SAXException
public void setDefaultType(QName qName)
public QName getDefaultType()
public void registerValueTarget(Target target)
target
- public Vector getValueTargets()
public void removeValueTargets()
public void moveValueTargets(Deserializer other)
other
- is the Deserializer to copy targets from.public boolean componentsReady()
public void valueComplete() throws SAXException
SAXException
public void addChildDeserializer(Deserializer dSer)
public void startElement(String namespace, String localName, String prefix, Attributes attributes, DeserializationContext context) throws SAXException
startElement
in class SOAPHandler
namespace
- is the namespace of the elementlocalName
- is the name of the elementprefix
- is the prefix of the elementattributes
- are the attributes on the element...used to get the typecontext
- is the DeserializationContext
Normally a specific Deserializer (FooDeserializer) should extend DeserializerImpl.
Here is the flow that will occur in such cases:
1) DeserializerImpl.startElement(...) will be called and do the id/href/nill stuff.
2) If real deserialization needs to take place DeserializerImpl.onStartElement will be
invoked, which will attempt to install the specific Deserializer (FooDeserializer)
3) The FooDeserializer.startElement(...) will be called to do the Foo specific stuff.
This results in a call to FooDeserializer.onStartElement(...) if startElement was
not overridden.
4) The onChildElement(...) method is called for each child element. Nothing occurs
if not overridden. The FooDeserializer.onStartChild(...) method should return
the deserializer for the child element.
5) When the end tag is reached, the endElement(..) method is invoked. The default
behavior is to handle hrefs/ids, call onEndElement and then call the Deserializer
valueComplete method.
So the methods that you potentially want to override are:
onStartElement, onStartChild, componentsReady, setValue(object, hint)
You probably should not override startElement or endElement.
If you need specific behaviour at the end of the element consider overriding
onEndElement.
See the pre-existing Deserializers for more information.SAXException
public void onStartElement(String namespace, String localName, String prefix, Attributes attributes, DeserializationContext context) throws SAXException
namespace
- is the namespace of the elementlocalName
- is the name of the elementprefix
- is the prefix of the elementattributes
- are the attributes on the element...used to get the typecontext
- is the DeserializationContextSAXException
public SOAPHandler onStartChild(String namespace, String localName, String prefix, Attributes attributes, DeserializationContext context) throws SAXException
onStartChild
in class SOAPHandler
namespace
- is the namespace of the child elementlocalName
- is the local name of the child elementprefix
- is the prefix used on the name of the child elementattributes
- are the attributes of the child elementcontext
- is the deserialization context.SAXException
public final void endElement(String namespace, String localName, DeserializationContext context) throws SAXException
endElement
in class SOAPHandler
namespace
- is the namespace of the child elementlocalName
- is the local name of the child elementcontext
- is the deserialization contextSAXException
public void onEndElement(String namespace, String localName, DeserializationContext context) throws SAXException
namespace
- is the namespace of the child elementlocalName
- is the local name of the child elementcontext
- is the deserialization contextSAXException
Copyright © The Apache Software Foundation. All Rights Reserved.