highsource / jaxb2-basics

Useful plugins and tools for JAXB2.
BSD 2-Clause "Simplified" License
109 stars 54 forks source link

Enhancement for simplifying unbounded sequence #131

Open o0oGnas opened 3 years ago

o0oGnas commented 3 years ago

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:

mattrpav commented 2 years ago

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>
o0oGnas commented 2 years ago

@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.