JAXB By Example

Java Architecture for XML Binding makes developer's life easier .Extended markup language (XML) is standard for exchanging data in between different applications across the network and Java provides a platform for building portable applications. JAXB API provides easier and standard way of accessing XML in java application.

It is just two steps process
  1. Bind the Schema , binding xml schema to set of Java classes
  2. Unsharshaling / marshaling , XML to Java or Java to XML
Following are step by step processing of using JAXB

1. Sample department XML Schema, save in the file named dept.xsd. Put in current directory.


2. Generate Java Classes from XML Schema using xjc tool

xjc –d src/ dept.xsd

output of this command :

parsing a schema...
compiling a schema...
demo\jaxb\Customer.java
demo\jaxb\Item.java
demo\jaxb\Items.java
demo\jaxb\ObjectFactory.java
demo\jaxb\Order.java
demo\jaxb\package-info.java
demo\jaxb\package-info.java

As you see the output, it will create java class files under src/ . It creates one Class for each Element in xsd , for example Customer, Item, Items,Order.


3. Create a sample xml file corresponding to above schema


<

4. Unmarshaling above xml, parsing xml file .

package demo.jaxb.test;

import demo.jaxb.*;
import java.io.FileInputStream;
import java.math.BigInteger;
import java.util.List;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller;
import javax.xml.datatype.XMLGregorianCalendar;

public class UnMarshalTest {
public UnMarshalTest() {
}
static String xmlPath = "D:\\jaxb\\dept2.xml";
public static void main(String[] args) throws Exception {
JAXBContext jc = JAXBContext.newInstance( "demo.jaxb" );
Unmarshaller u = jc.createUnmarshaller();
Order order = (Order)u.unmarshal( new FileInputStream( xmlPath ) );
BigInteger id = order.getOrderId();
String desc = order.getOrderDesc();
XMLGregorianCalendar date = order.getOrderDate();
System.out.println("Order Id = "+ id);
System.out.println("Order Desc = "+ desc);
System.out.println("Order Date = "+ date);
List items = order.getItems().getItem();
for ( Item t : items){
System.out.println("\t Item Desc = "+ t.getItemDec());
System.out.println("\t Item Quamtity = "+ t.getItemQ().toString());
}
Customer cust = order.getCustomer();
System.out.println("Customer Name = "+ cust.getCustomerName());
System.out.println("Customer Address = "+ cust.getCustomerAdd());
}
}

Output above java program will be

Order Id = 1
Order Desc = First order of its kind
Order Date = 2009-03-20
Item Desc = null
Item Quamtity = 10
Item Desc = null
Item Quamtity = 10
Item Desc = null
Item Quamtity = 10
Item Desc = null
Item Quamtity = 10
Customer Name = Yogesh
Customer Address = Hyderabad
Process exited with exit code 0.

This java class unmarshal xml document, converting xml document to java object. It creates JAXBContext passing binded java classes package ( output of binding schemea ) an gets Unmarshaller. Unmarshaller's job is to accept xml document and give java object.

5. Marshalling, Creating Xml file using java classes. Previuos steps is to convert xml document to java object, here we are going to create xml document using java claases.

package demo.jaxb.test;

import demo.jaxb.*;
import java.io.FileOutputStream;
import java.io.OutputStream;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.List;
import javax.xml.bind.Marshaller;
import javax.xml.bind.JAXBContext;

public class MarshalTest {
public MarshalTest() {
}
static String xmlPath = "D:\\mywork\\dept3.xml";
public static void main(String[] args) throws Exception{
ObjectFactory factory = new ObjectFactory();
Order order = factory.createOrder();
order.setOrderDesc("Marshing Order");
order.setOrderId(new BigInteger("02"));
Customer cust = factory.createCustomer();
cust.setCustomerAdd("Hyderabad");
cust.setCustomerName("Yogesh");
order.setCustomer(cust);
order.setItems(new Items());
List list = order.getItems().getItem();
Item item = factory.createItem();
item.setItemDec("Item -01");
item.setItemQ(new BigInteger("20"));
list.add(item);
item = factory.createItem();
item.setItemDec("Item -02");
item.setItemQ(new BigInteger("20"));
list.add(item);
item = factory.createItem();
item.setItemDec("Item -03");
item.setItemQ(new BigInteger("20"));
list.add(item);
JAXBContext context = JAXBContext.newInstance("demo.jaxb");
Marshaller marshaller= context.createMarshaller();
marshaller.marshal(order, new FileOutputStream(xmlPath));
System.out.println("Marshaling is Done Successfuly ...");
}
}

Output XML file will be


Comments

  1. UnknownJune 15, 2010 at 2:44 AM

    Hi yogesh, nice article, but while running application got a error of null pointer exception.
    Here below is the error
    java.lang.NullPointerException
    at MarshalTest.main(MarshalTest.java:37)

    The error in the code is
    list.add(item);

    and i changed as List list =(List)order.getItems().getItem(); for removing compile time error.

    Please help me from in this problem.

    ReplyDelete
  2. AnonymousFebruary 14, 2019 at 4:59 AM

    Hi
    I get the same error. When I execute my program step by step, I notice the error comes from the declaration of the context : the call of the method "newInstance()" retrieves null. JAXBContext jc is null.

    ReplyDelete
  3. WfratimdorseApril 24, 2022 at 7:58 AM

    Wfratimdorse Michelle King https://wakelet.com/wake/cFdllqN4MhMP9whto_zwS
    despdifnela

    ReplyDelete

Post a Comment

Popular posts from this blog

Composite Design Pattern by example

Image
This post explains Composite design pattern with an example. When to use ? – Use Composite pattern when you have treat a collection of objects as they were once one thing. With Composite design pattern it is very easy to simplify operations over collection data structure. It reduces complexity of the code required if you were going to handle collection as special case. How to Use? - The Composite pattern consist of Component, Leaf and Composite Classes as shown below class diagram Component – Component declares the common interface that both the single and composite nodes will implements Leaf – The leaf class represent the singular atomic data type implementing he component interface.     Composite – Composite is an abstract entity which declares common functionality which are needed by concrete implementation for handling collection data. An Example -   Item.java public interface Item {     public double getPrice(); }   ColdDrink.java pu
Read more

State Design Pattern by Example

Image
State pattern falls under the category of Behavioral patterns. State design pattern comes in picture when a system’s behavior is depends on its own state or some other resource’s state. If an implementation is depends on the states, we end up with snarl of conditional statement every where in code. A very neat approach to deal with such situation is to separate out every state’s behavior and use them where ever they are applicable. The state pattern allows an object to alter its behavior when is internal state changes . The object is appeared to change its class. State pattern is a way to implement the same. Class Diagram : As above class diagram shows, System class holds state instance. As state of system changes , all handle request delegated to respective State’s concrete implementation. Example : Have an example of Vending machine. Vending machine has following states No Coin Inserted Coin Inserted Dispensing Empty Following diagram explain behavior
Read more

Eclipse command framework core expression: Property tester

Image
Addition to Eclipse command framework series, this post explains use of property tester to control command’s enable/visible properties. In earlier post we have tried declarative way to achieve same thing but property tester gives us more control. Property tester is associated with, tester class which implements PropertyTester.java, a namespace and set of property which it supports. We can refer this property tester using its namespace + a property name. It gives you call back to test() method with property name as parameter inside property tester class. We can configure property tester for type of input parameter. Here is sample declaration of property tester extension point < extension point ="org.eclipse.core.expressions.propertyTesters" > < propertyTester class ="com.example.advance.cmd.EditorTester" id ="com.example.advance.cmd.propertyTester1" namespace ="com.example.advance.cm
Read more