{"id":234,"date":"2010-01-17T00:11:00","date_gmt":"2010-01-16T22:11:00","guid":{"rendered":""},"modified":"2023-03-20T12:28:38","modified_gmt":"2023-03-20T11:28:38","slug":"embedding-xquery-in-java","status":"publish","type":"post","link":"https:\/\/touk.pl\/blog\/2010\/01\/17\/embedding-xquery-in-java\/","title":{"rendered":"Embedding XQuery in Java"},"content":{"rendered":"

XQuery is a very powerful language. It can be very useful when you want to do some XML processing in Java.
\nLet’s say you want to create an XML document based on some other XML data. Given something like this:<\/p>\n

\r\n  \r\n    Fred Jones\r\n    <address<\/span> location<\/span>=\"home\"<\/span>><\/span>\r\n      900<\/span> Aurora Ave.\r\n      Seattle\r\n      WA\r\n      98115<\/span>\r\n    \r\n    <address<\/span> location<\/span>=\"work\"<\/span>><\/span>\r\n      2011 152<\/span>nd Avenue NE\r\n      Redmond\r\n      WA\r\n      98052<\/span>\r\n    \r\n    <phone<\/span> location<\/span>=\"work\"<\/span>><\/span>(425<\/span>)555<\/span>-5665<\/span>\r\n    <phone<\/span> location<\/span>=\"home\"<\/span>><\/span>(206<\/span>)555<\/span>-5555<\/span>\r\n    <phone<\/span> location<\/span>=\"mobile\"<\/span>><\/span>(206<\/span>)555<\/span>-4321<\/span>\r\n  \r\n<\/pre>\n
You want to produce employees’ names:<\/p>\n
\r\n  Fred Jones<\/pre>\n
In XQuery it’s just as easy as:<\/p>\n
\r\n  {for $name in employees\/employee\/name\/text() return {$name}}<\/pre>\n
The most interesting advantage for XQuery over various other methods for generating XML is that XQuery operates natively on XML.
\nThere are tools like JaxB, XmlBeans, which enable strongly typed XML building directly from Java code. But using such approach often requires a lot of Java code to be written, which is not really necessary.
\nThere is also a possibility to use XPath. However it’s an inferior solution to XQuery, because XPath doesn’t provide a way for building XML documents. It’s designed only for nodes selection. On the other hand, XQuery extends XPath, so it supports every construct that XPath does.
\nAnother way to do such processing in Java is to use XSLT. It’s the closest approach to XQuery. But the problem with XSLT is that it has its language constructs, like ‘for’ expressed as XML elements. This makes writing XSLT code much more difficult that XQuery.
\nXQuery can be seen as a native template language for XML processing.
\nSo the question is: how to evaluate XQuery expressions the best way from Java?
\nThere are some Open Source implementations of XQuery for Java. One of them is inside XmlBeans. However in my opinion the best way is to use Saxon. It’s the most mature project for XQuery processing and it’s targetted directly for doing that.
\nHowever Saxon might be a bit difficult to use directly. At least digging a few interesting features from it took me some time.
\nSo I decided to write a simple class for interfacing Saxon and to provide a few interesting examples of how to use it. That’s how xquery4j was born. You can download it from github http:\/\/github.com\/rafalrusin\/xquery4j<\/a>.
\nIn xquery4j, you can execute XQuery expressions from Java in a simple way:<\/p>\n
XQueryEvaluator evaluator =<\/span> new<\/span> XQueryEvaluator<\/span>();<\/span>\r\nLong<\/span> result = (<\/span>Long<\/span>)<\/span> evaluator.<\/span>evaluateExpression<\/span>(<\/span>\"5+5\"<\/span>,<\/span> null).<\/span>get<\/span>(<\/span>0<\/span>);<\/span>\r\nAssert.<\/span>assertEquals<\/span>(<\/span>new<\/span> Long<\/span>(<\/span>10<\/span>),<\/span> result);<\/span><\/pre>\n
It’s possible to bind variables from Java objects, the easy way:<\/p>\n
evaluator.<\/span>bindVariable<\/span>(<\/span>QName<\/span>.<\/span>valueOf<\/span>(<\/span>\"myVar\"<\/span>),<\/span> 123<\/span>);<\/span><\/pre>\n
Sometimes it’s also useful to declare Java methods and bind them for XQuery expressions. This is also very simple to do with xquery4j:<\/p>\n
public static class<\/span> MyFunctions {<\/span>\r\n        public static<\/span> String<\/span> myHello<\/span>(<\/span>String<\/span> arg) {<\/span>\r\n            TestEvaluator te = (<\/span>TestEvaluator)<\/span> XQueryEvaluator.<\/span>contextObjectTL.<\/span>get<\/span>();<\/span>\r\n            te.<\/span>id++;<\/span>\r\n            return<\/span> \"hello(\"<\/span> +<\/span> arg +<\/span> te.<\/span>id +<\/span> \")\"<\/span>;<\/span>\r\n        }<\/span>\r\n    }<\/span><\/pre>\n
XQueryEvaluator evaluator =<\/span> new<\/span> XQueryEvaluator<\/span>();<\/span>
\nevaluator.<\/span>setContextObject<\/span>(<\/span>this<\/span>);<\/span>
\nevaluator.<\/span>declareJavaClass<\/span>(<\/span>“http:\/\/my.org\/employees”<\/span>,<\/span> MyFunctions.<\/span>class<\/span>);<\/span>
\n}<\/span>
\nThis code sets a context object to ‘this’ and binds all static methods from MyFunctions class to XQuery expressions. So during myHello execution from XQuery, you can easily operate on Java variables from bound context – ‘id’ in this case.
\nHere’s a way of invoking such bound myHello method from XQuery:<\/p>\n
declare namespace my = 'http:\/\/my.org\/employees'; my:myHello(\"hello\"<\/span>)<\/pre>\n
xquery4j code contains unit tests, which include examples above.
\nYou can run them by:<\/p>\n
mvn package<\/pre>\n
Feel free to give some feedback on using it.<\/p>\n
\"\"<\/div>\n","protected":false},"excerpt":{"rendered":"XQuery is a very powerful language. It can be very useful when you want to do some XML…\n","protected":false},"author":35,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11],"tags":[68,107],"class_list":{"0":"post-234","1":"post","2":"type-post","3":"status-publish","4":"format-standard","6":"category-development-design","7":"tag-java","8":"tag-xml"},"_links":{"self":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/234","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/users\/35"}],"replies":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/comments?post=234"}],"version-history":[{"count":32,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/234\/revisions"}],"predecessor-version":[{"id":15320,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/234\/revisions\/15320"}],"wp:attachment":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/media?parent=234"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/categories?post=234"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/tags?post=234"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}