UBL 2.0 NameSpace question

Question

UBL 2.0 NameSpace question

GunterO opened this issue 4 years ago · comments

Hello,
I have a question about adding name spaces.

My sample XML (which I need to make) has these name spaces:

_xmlns:qdt:urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2
_xmlns:ccts:urn:oasis:names:specification:ubl:schema:xsd:CoreComponentParameters-2 
_xmlns:stat:urn:oasis:names:specification:ubl:schema:xsd:DocumentStatusCode-1.0
_xmlns:cbc:urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2
_xmlns:cac:urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2
_xmlns:udt:urn:un:unece:uncefact:data:draft:UnqualifiedDataTypesSchemaModule:2
_xmlns:urn:oasis:names:specification:ubl:schema:xsd:Invoice-2

My generated invoice XML has these name spaces:

_xmlns:ns4:urn:oasis:names:specification:ubl:schema:xsd:Invoice-2
_xmlns:cac:urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2
_xmlns:cec:urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2
_xmlns:cbc:urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2
__prefix:ns4

This is the code I tried to add for example qdt, but it's not added:

MapBasedNamespaceContext aNsCtx = UBL20NamespaceContext.getInstance().getClone();
aNsCtx.addMapping("qdt", "urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2");
aWriter.setNamespaceContext(aNsCtx);
final ESuccess eSuccess = aWriter.write(aInvoice, new File(fn));

Any idea what I'm doing wrong?
Thanks!

GunterO · Answer 1 · Tue May 19 2020 23:52:59 GMT+0800 (China Standard Time)

Also, then I don't clone the instance, the ns4 prefix is not there.

_xmlns:urn:oasis:names:specification:ubl:schema:xsd:Invoice-2
_xmlns:cac:urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2
_xmlns:cec:urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2
_xmlns:cbc:urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2

Used code:
final ESuccess eSuccess = UBL20Writer.invoice().write(aInvoice, new File(fn));
Why is that?
Thanks!

GunterO · Answer 2 · Wed May 20 2020 00:18:40 GMT+0800 (China Standard Time)

I could get rid of the prefix by adding this:
aNsCtx.addDefaultNamespaceURI("urn:oasis:names:specification:ubl:schema:xsd:Invoice-2");
But the extra namespace/mapping are not added dough.

Philip Helger · Answer 3 · Wed May 20 2020 14:23:06 GMT+0800 (China Standard Time)

Hi. So

MapBasedNamespaceContext aNsCtx = UBL20NamespaceContext.getInstance().getClone();
aNsCtx.addMapping("qdt", "urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2");
aWriter.setNamespaceContext(aNsCtx);
final ESuccess eSuccess = aWriter.write(aInvoice, new File(fn));

would be the correct solution.
What is __prefix:ns4 exactly. Can you paste the XML here?
Is it

prefix="ns4"

or so?

GunterO · Answer 4 · Wed May 20 2020 15:53:11 GMT+0800 (China Standard Time)

Thanks for your quick reply!

Correct, that's the code I use. However, when I add this line, the "ns4" prefix is not there:
aNsCtx.addDefaultNamespaceURI("urn:oasis:names:specification:ubl:schema:xsd:Invoice-2");
This "__prefix:ns4" is something the XML viewer is showing because of the prefix in the XML file.
I can't drop the XML extension here, so I renamed the file to sample.txt.

sample.txt

Philip Helger · Answer 5 · Wed May 20 2020 15:57:25 GMT+0800 (China Standard Time)

Ah okay got it - you have a weird XML viewer ;-)
Try this - combining both:

MapBasedNamespaceContext aNsCtx = UBL20NamespaceContext.getInstance().getClone();
aNsCtx.addMapping("qdt", "urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2");
aNsCtx.addDefaultNamespaceURI("urn:oasis:names:specification:ubl:schema:xsd:Invoice-2");
aWriter.setNamespaceContext(aNsCtx);
final ESuccess eSuccess = aWriter.write(aInvoice, new File(fn));

GunterO · Answer 6 · Wed May 20 2020 16:00:27 GMT+0800 (China Standard Time)

Yes, that's what I tried in the first place, but it is resulting in an XML without the "ns4" prefix, but without the "qdt" namespace line:
sample2.txt

GunterO · Answer 7 · Wed May 20 2020 16:10:02 GMT+0800 (China Standard Time)

It is there, but for some reason, it don't gets saved:

Philip Helger · Answer 8 · Wed May 20 2020 16:19:00 GMT+0800 (China Standard Time)

It says "thew NullPointerException" - is "fn" or "aInvoice" null?

GunterO · Answer 9 · Wed May 20 2020 16:23:31 GMT+0800 (China Standard Time)

Neither, it was because of the hovering over "aWriter", but I could inspect aWriter via Evaluate Expression. I think it is the IDE which is causing this.

Philip Helger · Answer 10 · Wed May 20 2020 16:26:27 GMT+0800 (China Standard Time)

Can you send me a bit more code privately - see the pom.xml for my email address. Thx

GunterO · Answer 11 · Wed May 20 2020 16:43:48 GMT+0800 (China Standard Time)

I just did, thanks!

GunterO · Answer 12 · Fri Jun 12 2020 17:10:54 GMT+0800 (China Standard Time)

Reason/solution:
In general, the underlying JAXB only writes the XML namespaces it (whysoever) needs.
And as the qdt namespace ( "urn:oasis:names:specification:ubl:schema:xsd:QualifiedDatatypes-2") is not used, it is not emitted.
If you would use an element that would require this namespace, than it would be there.