Jump to: navigation, search

Difference between revisions of "SMILA/Development Guidelines/Setup for JAXB code generation"

(Steps to install needed libraries)
(26 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
=== Introduction ===
 +
 
This page describes additional setup steps you need to do if you want to use JAXB to generate classes from XML schema descriptions for SMILA. This is also needed to be able to extend SMILA XML configuration file schemas, because we mostly use JAXB to parse them.  
 
This page describes additional setup steps you need to do if you want to use JAXB to generate classes from XML schema descriptions for SMILA. This is also needed to be able to extend SMILA XML configuration file schemas, because we mostly use JAXB to parse them.  
  
* Setup a build environment as described in [[SMILA/Development Guidelines/Howto build a SMILA-Distribution]].
+
 
* Download JAXB from [https://jaxb.dev.java.net/ https://jaxb.dev.java.net/], unpack it as described and copy <tt>lib/jaxb-xjc.jar</tt> to <tt>lib/xjc</tt> in the directory containing the additional libraries for building you created in the first step. Download <tt>InterfacesXJCPlugin.jar</tt> from ??where?? and add it to the lib/xjc directory, too. Your build lib directory should now look at least like this:
+
=== Steps to install needed libraries ===
 +
 
 +
# Setup a build library as described in [[SMILA/Development Guidelines/Howto build a SMILA-Distribution]]. In this document we will use {{path|lib/}} as the root of it.
 +
# Download the JAXB reference implementation 2.1.6 or above from [https://jaxb.dev.java.net/servlets/ProjectDocumentList here]
 +
# unpack it with (see [https://jaxb.dev.java.net/2.1.6/  here]) <source lang="text">java -jar <JAXB-version>.jar </source>
 +
# copy the following into your <tt>lib/xjc</tt>  
 +
#* all jars in the {{path|jaxb-ri-<version>/lib/}}
 +
#* <tt>InterfacesXJCPlugin.jar</tt>, you can download it [http://ubuntuone.com/7mZZkULtjiKxfCQfKVH2zG here]
 +
Your build lib directory should now look at least like this:
 
<source lang="text">
 
<source lang="text">
 
lib/
 
lib/
Line 10: Line 20:
 
       jaxb-xjc.jar
 
       jaxb-xjc.jar
 
       InterfacesXJCPlugin.jar
 
       InterfacesXJCPlugin.jar
 +
      activation.jar
 +
      jaxb-api.jar
 +
      jaxb-impl.jar
 +
      jsr173_1.0_api.jar     
 
</source>
 
</source>
* If you want to generate JAXB classes for a new crawler configuration:
 
** If you do not yet have a binary distribution of SMILA: [http://www.eclipse.org/smila/downloads.php Download] or build one.
 
** Copy <tt>org.eclipse.smila.connectivity.framework.schema_0.5.0.jar</tt> from the plugins directory of the SMILA distribution to <tt>lib/xjc</tt>. This is necessary because crawler configurations extend a base schema and therefore need to access classes in this bundle.
 
* Put your bundle next to all the SMILA source bundles.
 
* Create a <tt>schemas</tt> directory in your bundle and put the XSD and JXB file there (use the same basename and <tt>xsd</tt> and <tt>jxb</tt> as suffixes).
 
* Create a <tt>build.xml</tt> in the bundle directory with this content, replace $SCHEMA_NAME with the basename of the XSD/JXB files:
 
  
<source lang="xml">
+
=== Generate Sources  from Command line ===
<project name="sub-build" default="compile-schema-and-decorate" basedir=".">
+
  <property name="schema.name" value="$SCHEMA_NAME" />
+
  <import file="../SMILA.builder/xjc/build.xml" />
+
</project>
+
</source>
+
 
+
* You can optionally add a file <tt>copyright.txt</tt> to the bundle (next to build.xml) containing a copyright header for the generated files (use valid Java comment syntax).
+
* Add a <tt>code/gen</tt> folder to your bundle and add it as a source folder.
+
  
To generate the classes, you can now use:
+
#  Put <tt>[http://dev.eclipse.org/svnroot/rt/org.eclipse.smila/trunk/SMILA.builder SMILA.builder]</tt> into the same folder as the bundle for which you are generating the folder (for all SMILA bundles this is the case after a checkout).     
 
+
To generate the classes, you can now use:<source lang="text">
<source lang="text">
+
 
ant -Dlib.dir=<SMILA-Build-Lib-Dir>
 
ant -Dlib.dir=<SMILA-Build-Lib-Dir>
 
</source>
 
</source>
  
If you have created the folder with the build libs in the same directory where the source bundles are located, you can just use:
+
The JAXB classes should now be generated in the <tt>code/gen</tt> directory of your bundle.
  
<source lang="text">
+
=== Generating  JAXB classes for a new crawler or agent configuration ===
ant
+
#  If you do not yet have a binary distribution of SMILA: [http://www.eclipse.org/smila/downloads.php Download] or build one.
</source>
+
# Copy <tt>org.eclipse.smila.connectivity.framework.schema_$VERSION.jar</tt> from the plugins directory of the SMILA distribution to <tt>lib/xjc</tt>. This is necessary because crawler configurations extend a base schema and therefore need to access classes in this bundle.
 +
# Put your bundle next to the <tt>SMILA.builder</tt> source bundle.
 +
# Add a <tt>code/gen</tt> folder to your bundle and add it as a source folder.
 +
# Create a <tt>schemas</tt> directory in your bundle and put the XSD and JXB file there (use the same basename and <tt>xsd</tt> and <tt>jxb</tt> as suffixes).
 +
# Create a <tt>build.xml</tt> in the bundle directory with this content, replace $SCHEMA_NAME with the basename of the XSD/JXB files:
 +
 
 +
<source lang="xml">
 +
<project name="sub-build" default="compile-schema-and-decorate" basedir=".">
 +
  <property name="schema.name" value="$SCHEMA_NAME" />
 +
  <import file="../SMILA.builder/xjc/build.xml" />
 +
</project>
 +
</source>  
 +
 
 +
You can optionally add a file <tt>copyright.txt</tt> to the bundle (next to build.xml) containing a copyright header for the generated files (use valid Java comment syntax).
  
The JAXB classes should now be generated in the <tt>code/gen</tt> directory of your bundle.
 
  
 
[[Category:SMILA]]
 
[[Category:SMILA]]

Revision as of 07:27, 24 January 2012

Introduction

This page describes additional setup steps you need to do if you want to use JAXB to generate classes from XML schema descriptions for SMILA. This is also needed to be able to extend SMILA XML configuration file schemas, because we mostly use JAXB to parse them.


Steps to install needed libraries

  1. Setup a build library as described in SMILA/Development Guidelines/Howto build a SMILA-Distribution. In this document we will use lib/ as the root of it.
  2. Download the JAXB reference implementation 2.1.6 or above from here
  3. unpack it with (see here)
    java -jar <JAXB-version>.jar
  4. copy the following into your lib/xjc
    • all jars in the jaxb-ri-<version>/lib/
    • InterfacesXJCPlugin.jar, you can download it here

Your build lib directory should now look at least like this:

lib/
   ant-contrib/
      ant-contrib-1.0b1.jar
   xjc/
      jaxb-xjc.jar
      InterfacesXJCPlugin.jar
      activation.jar
      jaxb-api.jar
      jaxb-impl.jar
      jsr173_1.0_api.jar

Generate Sources from Command line

  1. Put SMILA.builder into the same folder as the bundle for which you are generating the folder (for all SMILA bundles this is the case after a checkout).
  2. To generate the classes, you can now use:
    ant -Dlib.dir=<SMILA-Build-Lib-Dir>

The JAXB classes should now be generated in the code/gen directory of your bundle.

Generating JAXB classes for a new crawler or agent configuration

  1. If you do not yet have a binary distribution of SMILA: Download or build one.
  2. Copy org.eclipse.smila.connectivity.framework.schema_$VERSION.jar from the plugins directory of the SMILA distribution to lib/xjc. This is necessary because crawler configurations extend a base schema and therefore need to access classes in this bundle.
  3. Put your bundle next to the SMILA.builder source bundle.
  4. Add a code/gen folder to your bundle and add it as a source folder.
  5. Create a schemas directory in your bundle and put the XSD and JXB file there (use the same basename and xsd and jxb as suffixes).
  6. Create a build.xml in the bundle directory with this content, replace $SCHEMA_NAME with the basename of the XSD/JXB files:
 <project name="sub-build" default="compile-schema-and-decorate" basedir=".">
  <property name="schema.name" value="$SCHEMA_NAME" />
  <import file="../SMILA.builder/xjc/build.xml" />
 </project>

You can optionally add a file copyright.txt to the bundle (next to build.xml) containing a copyright header for the generated files (use valid Java comment syntax).