XML to Java code generation

-

 XML to Java code generation using CASTOR and JAXB

This tutorial explains the code generation from xml to java by using Castor and JAXB in brief. 

Procedure

  1.  Generate XSD from XML using CASTOR
  2.  Generate Java objects from XSD JAXB. http://castor.codehaus.org/
 Each of the steps in detail below.

XSD Generation

  
There are lot of tools available to generate XSD from XML including a few online tools. CASTOR is one such tool can be used to generate XSD form XML.

Castor is the Open Source data binding framework for Java. Mainly it consists of two features Castor XML and Castor JDO.

Download and install castor from http://castor.codehaus.org/

The Castor JARs, docs, DTDs, command line tools, and examples can be downloaded from http://dist.codehaus.org/castor/1.3.3-RC1/castor-1.3.3-RC1.tgz

 
 

XML Instance to Schema



Follow the below steps to generate Schema from XML.
  1. Open command prompt
  2. Java_home should point to java install directory
  3. Set castor_home to castor install directory.
  4. Set classpath to include all the castor dependency jars as below. 


Castor_home>set classpath=%classpath%;.;castor-1.3-anttasks.jar;castor-1.3-codegen.jar;castor-1.3-core.jar;castor-1.3-ddlgen.jar;castor-1.3-jdo.jar;castor-1.3-xml-schema.jar;castor-1.3-xml.jar;castor-1.3.jar;jta1.0.1.jar;commons-logging-api-1.0.4.jar
 
 
    5. Use XMLInstance2Schema class to generate Schema

Sample.xml

 


<sample attr1="ACCT" attr2="2001" id="978"/>

 XSD generation

 
 

Castor_home > java org.exolab.castor.xml.schema.util.XMLInstance2Schema gens\sample.xml sample_schema.xsd

 

Gendrated XSD 

 
The following xml will be generated after executing the above command.



<?xml version="1.0" encoding="UTF-8" ?>
<schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <element name="Sample">
    <complexType>
     <sequence />
       <attribute name="attr1" type="string" />
       <attribute name="attr2" type="integer" />
      <attribute name="id" type="integer" />
   </complexType>
</element>
</schema>

 

JAXB

 
 
The Java Architecture for XML Binding API (JAXB) makes it easy to access XML documents from applications written in the Java programming language. JAXB is bundled with java version 6 onwards.

Java Architecture for XML Binding (JAXB) 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. In other words, JAXB allows storing and retrieving data in memory in any XML format, without the need to implement a specific set of XML loading and saving routines for the program's class structure

JAXB is a part of the Java SE platform and one of the APIs in the Java EE platform, and is part of the Java Web Services Development Pack (JWSDP). It is also one of the foundations for WSIT. JAXB is part of SE version 1.6.
 

XSD to java


Use the following steps to generate java objects from XSD
  1. Open command prompt
  2. Set java_home
  3. Use the JAXB schema compiler, xjc command to generate JAXB-annotated Java classes. The schema compiler is located in the java installation directory.
  4. The schema compiler produces a set of packages containing Java source files and JAXB property files depending on the binding options used for compilation

Command> xjc -no-header -npa schemas\sample_schema.xsd -p com.ssc.xml -d generated

-npa : suppress generation of package level annotations

-no-header :  suppress generation of a file header with timestamp

-p : Package name for generated source files

-d : output folder name
 

This generates two files in the output directory, one is the ObjectFactory and another is the actual java object. The ObjectFactory can be used to programmatically construct the java object during runtime.

The generated java class will look like below.
 

Generated Java Class 

 
 
 

The xml requests from client can be marshaled and unmarshalled as below.
 

JAXB Context

 

The JAXBContext class provides the client's entry point to the JAXB API. It provides an abstraction for managing the XML/Java binding information necessary to implement the JAXB binding framework operations: unmarshal, marshal and validate.
 

The JAXBContext instance is initialized from a list of colon separated Java package names 
 

JAXBContext class 


 
 
private  static JAXBContext initContext() {    
       try {     
           return JAXBContext.newInstance(Sample.class);
       } catch (JAXBException e) {
           logger.fatal("Context not initialized :" + e);
       }
       return null;
    }
 


 

Unmarshalling XML to Java  

 
       final StringReader xmlReader = new StringReader(xmlString);
       final StreamSource xmlSource = new StreamSource(xmlReader);
 
       Unmarshaller u = _CONTEXT.createUnmarshaller();
       Sample sample= (Sample) u.unmarshal(xmlSource);
 

 

Marshalling Java to XML  

 
     _CONTEXT.createMarshaller().marshal(sample, handler);
 

For more reading,

http://castor.codehaus.org/
http://java.sun.com/webservices/jaxb/index.jsp

 






Comments

  1. Bala KSeptember 26, 2013 at 8:09 PM

    Better and faster way to obtain JAXBContext

    public class XmlBidningContext {

    private static final JAXBContext _CONTEXT = initContext();

    private static JAXBContext initContext()
    {
    try
    {
    //Register all the classes here at once
    return JAXBContext.newInstance(new Class[] { A.class, B.class, C.class});
    }
    catch (JAXBException localJAXBException)
    {
    logger.fatal("Context not initialized :" + localJAXBException);
    }
    return null;
    }

    public static JAXBContext getBindingContext()
    {
    return _CONTEXT;
    }
    }

    ReplyDelete
  2. UlisiKcio-de-1982April 24, 2022 at 7:58 AM

    UlisiKcio-de-1982 Max Mullen https://wakelet.com/wake/RmqvO5n-z0xhfmS6Doi-v
    franovthrontha

    ReplyDelete
  3. Mimfectur-soAugust 26, 2022 at 4:53 AM

    Wremptrorteri-1990 Joe Dawson Vysor
    Cubase
    Winamp Pro
    probosgigen

    ReplyDelete

Post a Comment

Popular posts from this blog

Log4j multiple WAR files in single EAR configuration

-
Log4j multiple WAR files in single EAR configuration Problem: When you have multiple WAR files under the same EAR with multiple log4j config files in each of the war files, the logging API will pickup the first available config file and ignores the list. i.e, only a single log4j config file applies to entire EAR. Consider the below app app.ear |__admin.war    |__WEB-INF/classes/log4.xml |__web.war    |__WEB-INF/classes/log4j.xml When you deploy this app to the server all logs of two war files admin.war and web.war will go to admin.war' log. The log4j.xml in web.war has no effect here. There are some complex solutions for this like adding a logback, specifying package level log files in log4j configuration etc. Solution The easiest way is configuring the context param in web.xml In your web.xml add the following context param will send the log4j config locations specific to the contexts and fixes this issue. web.war/WEB-INF/classes/log4j.xml <conte
More posts »

Ubuntu / kubuntu - Laptop key board cursor jumping issue

-
Image
Ubuntu cursor jumping problem Issue : When you type in Ubuntu/Kubuntu you may get annoyed by cursor jumping here and there in the screen. This happens across all the applications. You might have tried adjusting key board settings, key stroke speed etc. But this is not related to your key board, but the touch pad! Cause: The cause of this issue is your touch pad. Yes, while typing parts of your hand/fingers often touch the keyboard. In windows this touch will not be deducted while typing. But for Ubuntu it is.  So when you type something and un-intentionally unknowingly touch your touch pad will take your cursor to the appropriate mouse position with respect to your touch forgetting you are typing something!!! Solution: Simple. Say your touch pad not to care the touches while I am eagerly typing something important.. How to say that? Open Synaptix Touch pad manager  Check Automatically switch of touch pad on keyboard activity Time to wait before switching touc
More posts »

Java NIO2 - Watching a directory for changes. FileWatcherService.

-
Image
File Watch Service The NIO2 WatchService API provides the ability for java code to watch for file modifications in a directory in the filesystem. A WatchService object watches the folder it is registered with and signals the changes detected through event notifications.  Steps to create a WatchService Create a WatchService object (FileSystem.newWatchService()) Register the directories to be watched with the WatchService (WatchService.register()) Watch for file change events (poll()/take() methods) Retrieve the event keys and process them Rest the key and got to step 3 to watch again. Example code Below is a simple working code. import java.io.IOException; import java.nio.file.Path; import java.nio.file.Paths; import java.nio.file.StandardWatchEventKinds; import java.nio.file.WatchEvent; import java.nio.file.WatchKey; import java.nio.file.WatchService; import java.util.List; import java.util.concurrent.TimeUnit; public class FileWatcherTest { private static
More posts »