jaxb2-basics icon indicating copy to clipboard operation
jaxb2-basics copied to clipboard

Enhancement for simplifying unbounded sequence

Open o0oGnas opened this issue 4 years ago • 2 comments

Suppose we have a complex type in a schema like this.

<complexType name="Numbers">
    <sequence maxOccurs="unbounded">
       <element name="number" type="int" />
       <element name="text" type="string" />
    </sequence>
</complexType>

By default XJC will generate a List<JAXBElement> inside class Numbers to represent the sequence. When used with simplify plugin, it becomes 2 separate lists List<Integer> number and List<String> text. While this works for unmarshalling XML data, it doesn't keep the interconnected relationship between each number and text element as defined by the schema, which can make it awkward to program with. Furthermore, when the same object is marshalled back into XML, all number elements will be placed before all text elements, which is wrong.

For example, XML data such as

<numbers>
    <number>1</number>
    <text>one</number>
    <number>2</number>
    <text>two</text>
</numbers>

would be marshalled back as

<numbers>
    <number>1</number>
    <number>2</number>
    <text>one</number>
    <text>two</text>
</numbers>

My proposed enhancement for this use case is as follows:

  • Generate a static inner class called Sequence inside generated Numbers class
  • This class would contain 2 fields: number as Integer and text as String.
  • The Numbers class would instead contain a List<Numbers.Sequence>.
  • e.g.
public class Numbers {
    List<Numbers.Sequence> sequence;

    public static class Sequence {
        Integer number;
        String text;
    }   
}

One problem I can think of with this approach is when the complexType happens to have an attribute also named sequence. In such cases I think prefixing or suffixing the name of the field List<Numbers.Sequence> sequence with something would suffice.

o0oGnas avatar Oct 26 '21 08:10 o0oGnas

JAXB can't 'guess' your intended object model. If you want a sequence of 'paired' items, you should make a complex type and a collection of the complex type.

Try this instead:

<complexType name="Number">
       <attribute name="number" type="int" />
       <attribute name="text" type="string" />
</complexType>

<complexType name="Numbers">
   <sequence>
      <element name="Number" type="ns:Number" maxOccurs="unbounded"/>
   </sequence>
</complexType>

mattrpav avatar Jan 13 '22 02:01 mattrpav

@mattrpav I think you didn't fully understand my issue. I'm not asking JAXB to guess my intended object model. I'm asking it to generate unbounded sequences as lists of wrapper objects which wrap the elements inside each sequence. Creating a complex type to wrap the elements and declaring it as a list with "unbounded" will not solve my problem because the structure would be slightly different from the unbounded sequence. In your suggestion the XML would look something like

<numbers>
    <number>
        <number>1</number>
        <text>one</number>
    </number>
   <number>
       <number>2</number>
       <text>two</text>
    </number>
</numbers>

which is different from what I have as input and thus cannot be unmarshalled by JAXB without doing some hacky workarounds. While I agree this would be the better way to represent the data, it's unfortunately what I have to live with as the structure is defined by a third party and not me.

o0oGnas avatar Jan 17 '22 12:01 o0oGnas