File	Doc	Category	Size	Date	Package
Deserializer.java	API Doc	Apache Axis 1.4	11097	Sat Apr 22 18:57:28 BST 2006	org.apache.axis.encoding

Deserializer

Fields Summary

Constructors Summary

Methods Summary
public boolean	componentsReady() Some deserializers (ArrayDeserializer) require all of the component values to be known before the value is complete. (For the ArrayDeserializer this is important because the elements are stored in an ArrayList, and all values must be known before the ArrayList is converted into the expected array. This routine is used to indicate when the components are ready. The default (true) is useful for most Deserializers.
public void	endElement(java.lang.String namespace, java.lang.String localName, DeserializationContext context) endElement is called when the end element tag is reached. It handles href/id information for multi-ref processing and invokes the valueComplete() method of the deserializer which sets the targets with the deserialized value. param namespace is the namespace of the child element param localName is the local name of the child element param context is the deserialization context
public javax.xml.namespace.QName	getDefaultType()
public java.lang.Object	getValue() Get the deserialized value. return Object representing deserialized value or null
public java.lang.Object	getValue(java.lang.Object hint) If the deserializer has component values (like ArrayDeserializer) this method gets the specific component via the hint. The default implementation returns null. return Object representing deserialized value or null
public java.util.Vector	getValueTargets() Get the Value Targets of the Deserializer. return Vector of Target objects or null
public void	moveValueTargets(org.apache.axis.encoding.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. So to ensure that all of the targets are updated, this method is invoked to copy the Target objects to the waiting Deserializer. param other is the Deserializer to copy targets from.
public void	onEndElement(java.lang.String namespace, java.lang.String localName, DeserializationContext context) onEndElement is called by endElement. It is not called if the element has an href. param namespace is the namespace of the child element param localName is the local name of the child element param context is the deserialization context
public org.apache.axis.message.SOAPHandler	onStartChild(java.lang.String namespace, java.lang.String localName, java.lang.String prefix, org.xml.sax.Attributes attributes, DeserializationContext context) onStartChild is called on each child element. The default behavior supplied by DeserializationImpl is to do nothing. A specific deserializer may perform other tasks. For example a BeanDeserializer will construct a deserializer for the indicated property and return it. param namespace is the namespace of the child element param localName is the local name of the child element param prefix is the prefix used on the name of the child element param attributes are the attributes of the child element param context is the deserialization context. return is a Deserializer to use to deserialize a child (must be a derived class of SOAPHandler) or null if no deserialization should be performed.
public void	onStartElement(java.lang.String namespace, java.lang.String localName, java.lang.String prefix, org.xml.sax.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.) DeserializerImpl provides default behavior, which simply involves obtaining a correct Deserializer and plugging its handler. param namespace is the namespace of the element param localName is the name of the element param prefix is the prefix of the element param attributes are the attributes on the element...used to get the type param context is the DeserializationContext
public void	registerValueTarget(Target target) For deserializers of non-primitives, the value may not be known until later (due to multi-referencing). In such cases the deserializer registers Target object(s). When the value is known, the set(value) will be invoked for each Target registered with the Deserializer. The Target object abstracts the function of setting a target with a value. See the Target interface for more info. param target Target
public void	removeValueTargets() Remove the Value Targets of the Deserializer.
public void	setChildValue(java.lang.Object value, java.lang.Object hint) If the deserializer has component values (like ArrayDeserializer) this method sets the specific component via the hint. The default implementation does nothing. param value Object representing deserialized value or null
public void	setDefaultType(javax.xml.namespace.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. For example, an element of an array may not have a type= attribute, so the default qname is the component type of the array. This method is used to communicate the default type information to the deserializer.
public void	setValue(java.lang.Object value) Set the deserialized value. param value Object representing deserialized value
public void	startElement(java.lang.String namespace, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes, DeserializationContext context) This method is invoked when an element start tag is encountered. DeserializerImpl provides default behavior, which involves the following: - directly handling the deserialization of a nill value - handling the registration of the id value. - handling the registration of a fixup if this element is an href. - calling onStartElement to do the actual deserialization if not nill or href cases. param namespace is the namespace of the element param localName is the name of the element param qName is the prefixed qName of the element param attributes are the attributes on the element...used to get the type param context 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, set(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.
public void	valueComplete() The valueComplete() method is invoked when the end tag of the element is read. This results in the setting of all registered Targets (see registerValueTarget). Note that the valueComplete() only processes the Targets if componentReady() returns true. So if you override componentReady(), then your specific Deserializer will need to call valueComplete() when your components are ready (See ArrayDeserializer)