JAXB and ObservableList

If you don’t customize your schemas with JAXB, your generated classes will not handle correctly the list in your UI (using beans binding functionnality).

If you have lists in your xml, you’ll probably handle them with Jtable or JList in your UI. Modifications of objects (from the edition form if you don’t edit directly in your list) will be seen in your table, but creation or deletion of an element in the list will not be seen. To see creation or deletion events in your UI lists, your object list have to be observable, i.e. implements ObservableList.

JAXB generate the following code for xml lists :

protected List<E> listElements = new ArrayList<E>();

The way to create an an observable list is below; beans binding library contains a factory :

org.jdesktop.observablecollections.ObservableCollections.observableList(new ArrayList<E>());

I would appreciate a way to modify the creation method in JAXB, but didn’t find it. So I created a class which implements the ObservableList interface (with an almost Decorator Pattern) and specify to JAXB to use this class to handle lists :

So, first step, create your own class for lists, that implements all method of ObservableList :

package my.package;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;

import org.jdesktop.observablecollections.ObservableCollections;
import org.jdesktop.observablecollections.ObservableList;
import org.jdesktop.observablecollections.ObservableListListener;

public class MyObservableList<E> implements
        ObservableList<E> {

    private ObservableList<E> l= ObservableCollections.observableList(new ArrayList<E>());



    public AdretObservableList() {

    }

    public void addObservableListListener(ObservableListListener arg0) {
        l.addObservableListListener(arg0);
    }


    public void removeObservableListListener(ObservableListListener arg0) {
        l.removeObservableListListener(arg0);
    }

//... and so one for all methods
}

Then specify xjc to use a custom bindings settings. Use -b file.xjb, the file containing the following instructions :

<bindings xmlns=&quot;http://java.sun.com/xml/ns/jaxb&quot; version=&quot;2.0&quot; xmlns:xs=&quot;http://www.w3.org/2001/XMLSchema&quot;>

  <globalBindings
  collectionType=&quot;my.package.MyObservableList&quot; >
  </globalBindings>

</bindings>

This way, JAXB will call

protected List<E> listElements = new MyObservableList<E>();

The plugin from no0ne handle this UI requirement (with the library CollectionBeanProperty).

comments powered by Disqus