castor

no fields generated for Model Group if extending from ComplexType with Model Group

Details

  • Type: Bug Bug
  • Status: Open Open
  • Priority: Major Major
  • Resolution: Unresolved
  • Affects Version/s: 0.9.5.2
  • Fix Version/s: None
  • Component/s: XML code generator
  • Labels:
    None
  • Environment:
    Operating System: All
    Platform: PC
  • Bugzilla Id:
    1537
  • Number of attachments :
    2

Description

i've discovered this source generator bug in version 0.9.3.21, and patched it
for our project. It still seems to be present in 0.9.5.2.
The example schema i'll include contains the following

  • two Model Group Definitions (named group-1 and group-2)
  • a Complex Type (named GroupBase) that has 'group-1' as Model Group.
  • another Complex Type (named GroupImpl) that extends from 'GroupBase' and
    has 'group-2' as Model Group
    The source generator fails to generate a field for 'group-2', which lead to
    runtime errors like
    org.xml.sax.SAXException: unable to find FieldDescriptor for 'element-c' in
    ClassDescriptor of group-element
    at org.exolab.castor.xml.UnmarshalHandler.startElement
    (UnmarshalHandler.java:1566)
    at org.exolab.castor.xml.UnmarshalHandler.startElement
    (UnmarshalHandler.java:1149)

This is what happens (i've checked this in 0.9.5.2)

  • org.exolab.castor.builder.MemberFactory creates a FieldInfo object
    to describe groups, and calls (line 388, method createFieldInfo(...))

fieldInfo.setNodeName("error-if-this-is-used");

because groups don't correspond to node names in xml documents.
FieldInfo extends from XmlInfo, and has a property nodeType, that is
initialized to XmlInfo.NODE_TYPE. In this case the default isn't changed.

  • for FieldInfo's of nodeType XmlInfo.NODE_TYPE,
    org.exolab.castor.builder.SourceFactory (line 1895, method handleField())
    checks, whether the field does not already exist in the class will extend
    from, using the nodeName as a key. Because both
    group-1 and group-2 have nodeName "error-if-this-is-used", no fields are
    generated for group-2

The solution I implemented was to change the line in MemberFactory to

fieldInfo.setNodeName("error-if-this-is-used"+xmlName);

thereby making the bogus nodeName unique for each group.
The conceptual problem underneath this bogus nodeName is that groups are
modelled as xml nodes in the castor builder code. At least i would add a
nodeType to XmlInfo (e.g. OTHER or SYNTHETIC or ...) to indicate Info objects
that do not correspond to something in the XML info set.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Thomas De Smedt added a comment -

Created an attachment (id=385)
Example Xml schema for which source generation fails

Show
Thomas De Smedt added a comment - Created an attachment (id=385) Example Xml schema for which source generation fails
Hide
Permalink
Thomas De Smedt added a comment -

Created an attachment (id=386)
example xml instance for that can't be handled by the generated code

Show
Thomas De Smedt added a comment - Created an attachment (id=386) example xml instance for that can't be handled by the generated code
Hide
Permalink
Fabio Ortiz added a comment -

MemberFactory.java at line 395 needs to be changed from

case Structure.GROUP:
fieldInfo.setNodeName("error-if-this-is-used");
fieldInfo.setContainer(true);
break;
To:

case Structure.GROUP:
fieldInfo.setNodeName(xmlName);
fieldInfo.setContainer(false);
break;

Then groups starts working just fine. Just changing the Node Name is not enoug because when starts processing the group it will fail. Also the fixes of the previous comment fail because it would output invalid xml. The group named would be mangled with the "error-if-this-is-used".

Show
Fabio Ortiz added a comment - MemberFactory.java at line 395 needs to be changed from case Structure.GROUP: fieldInfo.setNodeName(" error-if-this-is-used "); fieldInfo.setContainer(true); break; To: case Structure.GROUP: fieldInfo.setNodeName(xmlName); fieldInfo.setContainer(false); break; Then groups starts working just fine. Just changing the Node Name is not enoug because when starts processing the group it will fail. Also the fixes of the previous comment fail because it would output invalid xml. The group named would be mangled with the "error-if-this-is-used".
Hide
Permalink
Werner Guttmann added a comment -

It would be great is somebody attached a XML schema so that we can try to reproduce the problem (if it still exists at all). Having said that, I can tell from looking at MemberFactory.createFieldInfo(), lines 390ff that the code fix proposed above has not been integrated (so far).

Show
Werner Guttmann added a comment - It would be great is somebody attached a XML schema so that we can try to reproduce the problem (if it still exists at all). Having said that, I can tell from looking at MemberFactory.createFieldInfo(), lines 390ff that the code fix proposed above has not been integrated (so far).
Hide
Permalink
Thomas De Smedt added a comment -

attached an xsd that should reproduce the problem (recovered it from the attachements to CASTOR-684 ). I didn't rerun the my tests from 2,5 years ago.
Regarding the comments from Fabio Ortiz:

  • groups are a Schema construct, and do not belong to the XML Info Set, so are not represented by an xml node. So the name used in setNodeName() should never be visible in the xml output
  • groups are containers, using setContainer(false) will mix up other things (and maybe output groups as xml nodes !!)
    see also CASTOR-684 for a related xml-group issue.
Show
Thomas De Smedt added a comment - attached an xsd that should reproduce the problem (recovered it from the attachements to CASTOR-684 ). I didn't rerun the my tests from 2,5 years ago. Regarding the comments from Fabio Ortiz: groups are a Schema construct, and do not belong to the XML Info Set, so are not represented by an xml node. So the name used in setNodeName() should never be visible in the xml output groups are containers, using setContainer(false) will mix up other things (and maybe output groups as xml nodes !!) see also CASTOR-684 for a related xml-group issue.
Hide
Permalink
Werner Guttmann added a comment -

Hmm ... just created Java sources from the XML schema given, and I do not get any exceptions during code generation. In addition, classes are generated for both groups. Looks like we can eventually close this ....

Show
Werner Guttmann added a comment - Hmm ... just created Java sources from the XML schema given, and I do not get any exceptions during code generation. In addition, classes are generated for both groups. Looks like we can eventually close this ....
Hide
Permalink
Thomas De Smedt added a comment -

The generation doesn't give errors, it just generates wrong code.
Attached an eclipse project with a reproduction and the fix.

Show
Thomas De Smedt added a comment - The generation doesn't give errors, it just generates wrong code. Attached an eclipse project with a reproduction and the fix.
Hide
Permalink
Thomas De Smedt added a comment -

The MemberFactory_ORIGINAL.java file included in the zip, is not identical to the 1.0.4 source, sorry for the sloppyness.
It leaves out the line

fieldInfo.setNodeName("error-if-this-is-used");

line. This is only a partial fix, since it would raise conflicts between elements and model groups having the same name, which is allowed by the specs (see http://www.w3.org/TR/xmlschema-1/#concepts-nameSymbolSpaces ).

Show
Thomas De Smedt added a comment - The MemberFactory_ORIGINAL.java file included in the zip, is not identical to the 1.0.4 source, sorry for the sloppyness. It leaves out the line fieldInfo.setNodeName(" error-if-this-is-used "); line. This is only a partial fix, since it would raise conflicts between elements and model groups having the same name, which is allowed by the specs (see http://www.w3.org/TR/xmlschema-1/#concepts-nameSymbolSpaces ).
Hide
Permalink
Werner Guttmann added a comment -

Thanks, Thomas.

Show
Werner Guttmann added a comment - Thanks, Thomas.

People

  • Assignee:
    Unassigned
    Reporter:
    Thomas De Smedt
Vote (2)
Watch (1)

Dates

  • Created:
    Updated: