com.openharbor.beck.unmarshal
Class CollectionUnmarshaller

java.lang.Object
  com.openharbor.beck.unmarshal.DefaultUnmarshaller
      com.openharbor.beck.unmarshal.GroupUnmarshaller
          com.openharbor.beck.unmarshal.CollectionUnmarshaller

All Implemented Interfaces:

MapFromXML.Aware, Setter, Unmarshaller

Direct Known Subclasses:

MappingUnmarshaller, WhenUnmarshaller

public class CollectionUnmarshaller

extends GroupUnmarshaller

implements Setter

Maps to a collection, with members mapped from contained elements.

Field Summary

Fields inherited from class com.openharbor.beck.unmarshal.DefaultUnmarshaller

data, documentState, log

Constructor Summary

CollectionUnmarshaller()

Method Summary

void	addChild(Unmarshaller child) Create a reference from this object to the given child object.
protected java.util.Collection	getCollection()
java.lang.Class	getObjectClass()
java.lang.Object	getValue(Unmarshaller child, java.lang.Object[] getterParameters) Traverse an existing relationship from parent to child.
java.lang.Object	getValue(Unmarshaller child, java.lang.Object[] getterParameters, boolean toRemove, boolean toReplace)
java.lang.Class	getValueClass(JavaBeanUnmarshaller parent) Find the expected class of a child object; for example, the declared class of a field or JavaBean property.
java.lang.Object	removeValue(Unmarshaller child, java.lang.Object[] getterParameters)
java.lang.Object	replaceValue(Unmarshaller child, java.lang.Object[] getterParameters)
void	setValue(Unmarshaller child, java.lang.Object[] getterParameters) Create a relationship from parent to child.

Methods inherited from class com.openharbor.beck.unmarshal.GroupUnmarshaller

locateChild, removeChildAt, removeLastChild, swapLastChildWith

Methods inherited from class com.openharbor.beck.unmarshal.DefaultUnmarshaller

addToParent, addValue, afterEndObject, disengage, disengaged, endElement, endObject, engage, getChildClass, getMap, getMapFromXML, getObject, getParent, getSource, getSourceXPath, getXMLContext, getXName, getXPath, isEngaged, newObject, processAttributes, referToThis, reset, rethrow, setMapFromXML, setObject, setObjectClass, setParentAndSource, setValue, setXMLContext, startElement, startObject, toString, trim

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionUnmarshaller

public CollectionUnmarshaller()

Method Detail

getObjectClass

public java.lang.Class getObjectClass()

Specified by:

getObjectClass in interface Unmarshaller

Overrides:

getObjectClass in class DefaultUnmarshaller

addChild

public void addChild(Unmarshaller child)
              throws java.lang.Exception

Description copied from interface: Unmarshaller

Create a reference from this object to the given child object. For example, set a reference-valued JavaBean property, or add a member to a Collection.

Specified by:

addChild in interface Unmarshaller

Overrides:

addChild in class DefaultUnmarshaller

Throws:

java.lang.Exception

getCollection

protected java.util.Collection getCollection()

Specified by:

getCollection in class GroupUnmarshaller

setValue

public void setValue(Unmarshaller child,
                     java.lang.Object[] getterParameters)
              throws java.lang.Exception

Description copied from interface: Setter

Create a relationship from parent to child. Ordinarily, set a member of the parent to refer to the child.

Specified by:

setValue in interface Setter

Parameters:

child - describes the child object. child.getParent() describes the parent.

getterParameters - additional parameters to the setter method, such as LocaleTag.

Throws:

java.lang.Exception - something went wrong

removeValue

public java.lang.Object removeValue(Unmarshaller child,
                                    java.lang.Object[] getterParameters)
                             throws java.lang.Exception

Specified by:

removeValue in interface Setter

Throws:

java.lang.Exception

replaceValue

public java.lang.Object replaceValue(Unmarshaller child,
                                     java.lang.Object[] getterParameters)
                              throws java.lang.Exception

Specified by:

replaceValue in interface Setter

Throws:

java.lang.Exception

getValue

public java.lang.Object getValue(Unmarshaller child,
                                 java.lang.Object[] getterParameters)
                          throws java.lang.Exception

Description copied from interface: Setter

Traverse an existing relationship from parent to child. Call child.setObject() and child.setObjectClass() to record the child's identity and type, and return a reference to the child.

This method is used to resolve XPaths. Given an object and an XPath, we create an Unmarshaller for every level of the XPath, use the mapper to retrieve the corresponding setters, then traverse the object model using this method.

Specified by:

getValue in interface Setter

Parameters:

child - Child unmarshaller, which represents the property we're interested in. The parent (or the object whose property is to be read) can be accessed by child.getParent().

getterParameters - the parameters the getter takes. Typically, getters take no parameters, and null can be passed in. With mutli-lingual properties however, LocaleTag must be passed in to identify the language of interest,

Returns:

a reference to the child object, or null if there is no existing child.

Throws:

java.lang.Exception - something went wrong

getValue

public java.lang.Object getValue(Unmarshaller child,
                                 java.lang.Object[] getterParameters,
                                 boolean toRemove,
                                 boolean toReplace)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getValueClass

public java.lang.Class getValueClass(JavaBeanUnmarshaller parent)

Description copied from interface: Setter

Find the expected class of a child object; for example, the declared class of a field or JavaBean property. The actual class of the child object may be derived from this class.

Specified by:

getValueClass in interface Setter

Parameters:

parent - describes the parent object, or null if the parent is not yet known.

Returns:

the expected class of the child object, or null if no particular class is expected.