We know that JAXB(Java Architecture for XML Binding) allows Java developers to map Java classes to XML representations. JAXB provides two main features: the ability to marshal Java objects into XML and the inverse, i.e. to unmarshal XML back into Java objects. JAXB mostly is used while implementing webservices or any other such client interface for an application where data needs to be transferred in XML format instead of HTML format which is default in case of visual client like web browsers.
A good example is facebook APIs. Facebook has exposed its services through some open endpoints in form of RESTful webservices where you hit a URL and post some parameters, and API return you the data in xml format. Now it is upto you, how you use that data.
In this post, I am giving an example of marshalling and unmarshalling of Map object e.g. HashMap. These map objects are usually represent the mapping between some simple keys to complex data.
1) JAXB Maven Dependencies
To run JAXB examples, we need to add run time dependencies like below.
<dependency> <groupId>com.sun.xml.bind</groupId> <artifactId>jaxb-core</artifactId> <version>2.2.8-b01</version> </dependency> <dependency> <groupId>com.sun.xml.bind</groupId> <artifactId>jaxb-impl</artifactId> <version>2.2-promoted-b65</version> </dependency>
2) Map model classes
I have created a model class “Employee.java” which has some common fields. I want to build code which could parse map of objects where key is sequence code and value is Employee object itself.
@XmlRootElement(name = "employee")
@XmlAccessorType (XmlAccessType.FIELD)
public class Employee
{
private Integer id;
private String firstName;
private String lastName;
private double income;
//Getters and Setters
}
import java.util.List;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement (name="employees")
@XmlAccessorType(XmlAccessType.FIELD)
public class EmployeeMap {
private Map<Integer, Employee> employeeMap = new HashMap<Integer, Employee>();
public Map<Integer, Employee> getEmployeeMap() {
return employeeMap;
}
public void setEmployeeMap(Map<Integer, Employee> employeeMap) {
this.employeeMap = employeeMap;
}
}
3) Marshal Map to XML Example
Java example to marshal or convert java map to xml representation. In below example code, I am writing the map of employees first in console, and then in a file.
public static void main(String[] args) throws JAXBException
{
HashMap<Integer, Employee> map = new HashMap<Integer, Employee>();
Employee emp1 = new Employee();
emp1.setId(1);
emp1.setFirstName("Lokesh");
emp1.setLastName("Gupta");
emp1.setIncome(100.0);
Employee emp2 = new Employee();
emp2.setId(2);
emp2.setFirstName("John");
emp2.setLastName("Mclane");
emp2.setIncome(200.0);
map.put( 1 , emp1);
map.put( 2 , emp2);
//Add employees in map
EmployeeMap employeeMap = new EmployeeMap();
employeeMap.setEmployeeMap(map);
/******************** Marshalling example *****************************/
JAXBContext jaxbContext = JAXBContext.newInstance(EmployeeMap.class);
Marshaller jaxbMarshaller = jaxbContext.createMarshaller();
jaxbMarshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
jaxbMarshaller.marshal(employeeMap, System.out);
jaxbMarshaller.marshal(employeeMap, new File("c:/temp/employees.xml"));
}
Output:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<employees>
<employeeMap>
<entry>
<key>1</key>
<value>
<id>1</id>
<firstName>Lokesh</firstName>
<lastName>Gupta</lastName>
<income>100.0</income>
</value>
</entry>
<entry>
<key>2</key>
<value>
<id>2</id>
<firstName>John</firstName>
<lastName>Mclane</lastName>
<income>200.0</income>
</value>
</entry>
</employeeMap>
</employees>
4) Unmarshal XML to Map Example
Java example to convert xml to Java map object. Let’s see the example of our EmployeeMap class.
private static void unMarshalingExample() throws JAXBException
{
JAXBContext jaxbContext = JAXBContext.newInstance(EmployeeMap.class);
Unmarshaller jaxbUnmarshaller = jaxbContext.createUnmarshaller();
EmployeeMap empMap = (EmployeeMap) jaxbUnmarshaller.unmarshal( new File("c:/temp/employees.xml") );
for(Integer empId : empMap.getEmployeeMap().keySet())
{
System.out.println(empMap.getEmployeeMap().get(empId).getFirstName());
System.out.println(empMap.getEmployeeMap().get(empId).getLastName());
}
}
Output:
Lokesh
Gupta
John
Mclane
5) Sourcecode Download
To download the sourcecode of above example follow below link.
Happy Learning !!
abhi
how to use only the name of xml file without giving the full path address in unMarshalingExample() ?
abhi
what to do if wanna call xml file only by its name not by full path address?
Srinivasarao Dupati
i want learn Data Structures and Algorithms and I want know which algorithm is better for which Data Structures also….. please give me Best Reference to learn Time Complexity and Space Complexity also…..
Lokesh Gupta
Not sure. I still have not gone through any resource/book which I can recommend.
Srinivasarao Dupati
Ok But as per your point of view you can prefer one book, so Just give me any one based on your experience level to refer, it could be Commercial also fine or Open Source also fine…
I want grow up my Skills, i am trying for 6 months but i did’t find So please help me ……
Srinivasarao Dupati
Hi Lokesh good evening ,
thank you for Sharing Content here and giving reply for to US.
i got one Business case, that I have to Develop one Web Service and That Web Service Will have to as SOAP(JAX-RS) Web Service and as well as REST full web Service, to get the Solution i am referring JAX-RS Spec and SOAP(JAX-RS) Spec, But i could n’t able to find the Solution . So can you help me Here.
Thanking you.
Lokesh Gupta
You will need to develop two web services with almost similar contract.
Srinivasarao
Hi Lokesh,
Yes, but at the SOAP Point of view we can See WSDL, But JAX-RS API , Resteasy Impl will not support the any WSDl and WADL, in this case one Contract is not usefull.
here i have some doubts, IF we develop the SOAP Web Service then the Web Service will not take the GET method , Bcoz the Complexity xml Data we cant send over the Get method String Query param, So that the SOAP failed Here as per my knowledge, is there any alternative tools are there in market to support the above business case, please tell me.
Lokesh Gupta
I am not aware of any such tool or methodology.
Srinivasarao Dupati
OK thanks for your answer,
is it possible to build one web Service and that could be work as SOAP and REST Web Service
Lokesh Gupta
Not really!! Both are too much different with very less in common.
Srinivasarao Dupati
Which algorithm is better for sorting Linked List and Searching the Element in Linked list
Lokesh Gupta
Perhaps MergeSort will give you best results in case of LinkedList. It has been established many times by many researchers e.g. here.
Ganga
Hi,
This is a very good article which helped through the issue I have been struggling with a few days now.
How can I get rid of the unwanted tags , 1 and from the output xml and only retain the actual Employee related Tags.
Thanks,
Ganga
Ganga
Sorry, looks like the tags that I was referring to in the Query I posted did not display quite well . The tags that I am referring to are
1. Entry
2. Key
3. Value
Ganga
I found a solution for this..I used Arraylist instead of Map…I added all the map values into Arraylist before passing it to jaxb marshaller…
Thanks,
Ganga
Lokesh Gupta
Seems good to me.
Rahul Gupta
I have one ParentItem.java class having common attributes and 2 child classes Merchandise.java and Offer.java. I have one Transaction.java class having list of ParentItem, so as to marshal list of 2 different object and want to get structure like this :
LINE_ITEM
ADD
1
REG2
7.00
7.42
0.42
5.00
#1 Combo Meal
1695155651
5.00
1
5.00
#1 Combo Meal
1695155652
5.00
1
OTHER_COUPON
1695155653
EmpDisc
2.00
1695155651
MERCHANT_COUPON
1695155654
1OffAnyPurch
1.00
1695155651
but doing all my stuff of coding I am getting following structure:
ADD
LINE_ITEM
TIE WAIST SHIRT DRESS
1
Offer
100
muhabbul Haasan
How i create a java client now to view all the employee and perform an simple query
Lokesh Gupta
Java client for what purpose??
hasan
to retrive employee information.
Ankush
Ankush
I want output is like that as PFB
Employees e =
e.getFirstName() = “Ankush”
e.getAddress() = “>”
how can get this result from jaxb
Lokesh Gupta
Something missing in comment. I am not able to understand it properly.
Zamir Hasan
Hi Lokesh,
Could you please help me with the below XML structure where the below block would be repeated many times depending upon the condition.
ABC
.
Many Thanks!
Nitish
Hi Lokesh i am getting the following error while sending the @requestline(get test/search?userid={userId}deptid={deptid}
unable to marshal type “java.util.LinkedHashMap” as an element because it is missing an @XmlRootElement annotation
Lokesh Gupta
You can return an instance of LinkedHashMap from your method because it does not contain @XmlRootElement annotation. You must return an instance of class which has @XmlRootElement annotation and add LinkedHashMap as an attribute in this class (with setters and getters).
https://dzone.com/articles/jaxb-and-javautilmap has some good examples.
Nitish
I need to send only couple of parameters but still facing the problem
Lokesh Gupta
Doesn’t matter the number of parameters. The class you return from method “MUST” have @XmlRootElement annotation.