source: trunk/build.xml @ 7

<?xml version="1.0" encoding="UTF-8"?>
<project
  name="BASE2"
  default="core"
  basedir="."
  >

  <description>
    Build file for BASE 2.0
    Main targets:
    core (default): build the core
    nohibernate: build the core, but do not regenerate the Hibernate mappings
    test: build the test programs
    web: build the web client
    migrate: build the migration client
    javadoc: generate documentation
    package: create binary distribution
    all: core, clients, docs
    clean: clean up everything
  </description>

  <!-- set global properties for this build -->
  <property name="base.version" value="2.0-alpha1" />
  <property name="src" location="src" />
  <property name="build" location="build" />
  <property name="dist" location="dist" />
  <property name="dist.lib" location="${dist}/www/WEB-INF/lib" />
  <property name="dist.classes" location="${dist}/www/WEB-INF/classes" />
  <property name="dist.bin" location="${dist}/bin" />
  <property name="doc" location="doc" />
  <property name="lib" location="lib" />
  <property name="www" location="www" />

  <property name="core.src" location="${src}/core" />
  <property name="test.src" location="${src}/test" />
  <property name="web.src" location="${src}/clients/web" />
  <property name="migrate.src" location="${src}/clients/migrate" />
  <property name="install.src" location="${src}/install" />

  <property name="core.build" location="${build}/core" />
  <property name="test.build" location="${build}/test" />
  <property name="migrate.build" location="${build}/clients/migrate" />
  <property name="install.build" location="${build}/install" />
  <property name="web.build" location="${build}/clients/web" />
  <property name="web.inf" location="${www}/WEB-INF" />

  <property name="doc.develop" location="${doc}/api/develop" />
  <property name="doc.public" location="${doc}/api/public" />

  <path id="core.compile.classpath">
    <fileset dir="${lib}/compile">
      <include name="**/*.jar"/>
    </fileset>
  </path>

  <path id="test.compile.classpath">
    <path refid="core.compile.classpath"/>
    <pathelement location="${core.build}"/>
  </path>

  <path id="migrate.compile.classpath">
    <path refid="core.compile.classpath" />
    <pathelement location="${core.build}" />
  </path>
  
  <path id="install.compile.classpath">
    <path refid="core.compile.classpath" />
    <pathelement location="${core.build}" />
  </path>
  
  <path id="web.compile.classpath">
    <path refid="core.compile.classpath"/>
    <pathelement location="${core.build}"/>
  </path>

  <path id="hibernatedoclet.classpath">
    <fileset dir="${lib}/hibernatedoclet">
      <include name="**/*.jar"/>
    </fileset>
  </path>

  <taskdef
    name="hibernatedoclet"
    classname="xdoclet.modules.hibernate.HibernateDocletTask"
    classpathref="hibernatedoclet.classpath"
    description="Task for generating Hibernate mapping files from XDoclet tags"
  />

  <target
    name="all"
    depends="core, test, web, javadoc"
    description="Compile/create everything"
  />

  <target
    name="core"
    depends="core.compile,core.hibernate"
    description="Compile the core, generate Hibernate mappings and put everyting in a JAR file"
  />

  <target
    name="nohibernate"
    depends="core.compile"
    description="Compile the core, assuming Hibernate mappings already exists
      and put everyting in a JAR file"
  />

  <target
    name="core.hibernate"
    depends="core.compile"
    description="Generates Hibernate mappings for the core."
    >
    <hibernatedoclet
      destdir="${core.build}"
      excludedtags="@version,@author,@todo"
      mergedir="${core.build}"
      verbose="${xdoclet.verbose}">
      <fileset dir="${core.src}">
        <include name="**/*.java"/>
      </fileset>
      <hibernate version="2.0"/>
    </hibernatedoclet>
  </target>

  <target
    name="core.compile"
    depends=""
    description="compile the core source code"
    >
    <mkdir dir="${core.build}"/>
    <javac
      encoding="ISO-8859-1"
      srcdir="${core.src}"
      destdir="${core.build}"
      classpathref="core.compile.classpath"
      debug="true"
      deprecation="true"
    />
    <copy todir="${core.build}">
      <fileset dir="${core.src}">
        <include name="**/*.xml" />
        <include name="**/*.dtd" />
        <include name="**/*.config" />
        <include name="**/*.properties" />
      </fileset>
    </copy>
  </target>

  <target
    name="test"
    depends="test.compile"
    description="Compile the test programs"
  />

  <target name="test.compile"
    depends=""
    description="compile the source code for the test programs"
    >
    <mkdir dir="${test.build}"/>
    <javac
      srcdir="${test.src}"
      destdir="${test.build}"
      classpathref="test.compile.classpath"
      debug="true"
      deprecation="true"
      encoding="ISO-8859-1"
    />
    <copy todir="${test.build}">
      <fileset dir="${test.src}">
        <include name="*.*" />
        <exclude name="*.java" />
      </fileset>
    </copy>
    <chmod file="${test.build}/run.sh" perm="a+x"/>
    <copy todir="${test.build}">
      <fileset dir="${src}">
        <include name="*.config" />
        <include name="*.properties" />
        <include name="*.xml" />
      </fileset>
    </copy>
  </target>

  <target
    name="migrate"
    depends="dist.migrate"
    description="create the Migrate.jar"
  >
  </target>
  
  <target name="dist.migrate" depends="migrate.compile,dist.init" description="">
    <jar basedir="${migrate.build}" jarfile="${dist.bin}/Migrate.jar" includes="**/*.class">
    </jar>
    <copy todir="${dist.bin}" file="${migrate.src}/migrate_from_1.2.sh" />
    <chmod file="${dist.bin}/migrate_from_1.2.sh" perm="a+x"/>
    <copy tofile="${dist.classes}/migrate.properties" file="${migrate.src}/migrate.properties.in" />
    <chmod file="${dist.classes}/migrate.properties" perm="600"/>

  </target>

  <target name="migrate.properties" if="migrate.newproperties">
    <copy tofile="${migrate.build}/migrate.properties" file="${migrate.src}/migrate.properties.in" />
    <chmod file="${migrate.build}/migrate.properties" perm="600"/>
  </target>

  <target name="migrate.compile" description="compile the source code for the migration program">
    <mkdir dir="${migrate.build}" />
    <javac
      encoding="ISO-8859-1"
      srcdir="${migrate.src}"
      destdir="${migrate.build}"
      classpathref="migrate.compile.classpath"
      debug="true"
    />
    <copy todir="${migrate.build}">
      <fileset dir="${src}">
        <include name="*.config" />
        <include name="*.properties" />
        <include name="*.xml" />
      </fileset>
    </copy>
    <copy todir="${migrate.build}" file="${migrate.src}/migrate_from_1.2.sh" />
    <chmod file="${migrate.build}/migrate_from_1.2.sh" perm="a+x"/>
    <condition property="migrate.newproperties">
      <not>
        <available file="${migrate.build}/migrate.properties"/>
      </not>
    </condition>
    <antcall target="migrate.properties"/>
  </target>
  
  <target
    name="install"
    depends="install.compile"
    description="Compile the installation program"
  >
  </target>

  <target name="install.compile"
    description="compile the source code for the installation program"
    >
    <mkdir dir="${install.build}" />
    <javac
      encoding="ISO-8859-1"
      srcdir="${install.src}"
      destdir="${install.build}"
      classpathref="install.compile.classpath"
      debug="true"
    />
  </target>

  <target
    name="web"
    depends="web.compile"
    description="Compile the web client, and copy required files to the web-inf directory"
  >
    <mkdir dir="${web.inf}/lib"/>
    <mkdir dir="${web.inf}/classes"/>
    <jar
      basedir="${core.build}"
      jarfile="${web.inf}/lib/BASE2Core.jar"
    />
    <jar
      basedir="${web.build}"
      jarfile="${web.inf}/lib/BASE2Webclient.jar"
    />
    <copy todir="${web.inf}/lib">
      <fileset dir="${lib}/compile">
        <include name="**/*.jar"/>
      </fileset>
      <fileset dir="${lib}/dist">
        <include name="**/*.jar"/>
      </fileset>
    </copy>
    <copy todir="${web.inf}/classes">
      <fileset dir="${src}">
        <include name="*.config"/>
        <include name="*.properties"/>
        <include name="*.xml"/>
      </fileset>
    </copy>
  </target>

  <target
    name="web.compile"
    depends=""
    description="compile the source code for the web client"
    >
    <mkdir dir="${web.build}"/>
    <javac
      encoding="ISO-8859-1"
      srcdir="${web.src}"
      destdir="${web.build}"
      classpathref="web.compile.classpath"
      debug="true"
    />
  </target>

  <target
    name="dist"
    depends="dist.init,dist.core,dist.install,dist.web,dist.doc,dist.migrate"
    description="Create the distribution and put all files in their correct places">
    <copy todir="${dist.lib}">
      <fileset dir="${lib}/compile">
        <include name="**/*.jar"/>
        <exclude name="**/jai*.jar" />
        <exclude name="**/servlet.jar" />
      </fileset>
      <fileset dir="${lib}/dist">
        <include name="**/*.jar"/>
      </fileset>
    </copy>
    <copy tofile="${dist.classes}/base.config" file="${src}/base.config.in" />
    <chmod file="${dist.classes}/base.config" perm="600"/>
    <copy todir="${dist.classes}" file="${src}/hibernate.properties" />
    <copy todir="${dist.classes}" file="${src}/log4j.properties" />
    <copy todir="${dist.classes}" file="${src}/extended-properties.xml" />
    <copy todir="${dist.classes}" file="${src}/raw-data-types.xml" />
    <copy todir="${dist.classes}" file="${src}/mysql-queries.xml" />
    <copy todir="${dist.classes}" file="${src}/sqlserver-queries.xml" />
  </target>

  <target
    name="dist.init"
    description="Create the distribution directory structure"
    >
    <mkdir dir="${dist}"/>
    <mkdir dir="${dist.bin}"/>
    <mkdir dir="${dist}/doc"/>
    <mkdir dir="${dist}/www"/>
    <mkdir dir="${dist.lib}"/>
  </target>

  <target
    name="dist.core"
    depends="core.compile,core.hibernate"
    description="Generate the core jar file: BASE2Core.jar"
    >
    <jar
      basedir="${core.build}"
      jarfile="${dist.lib}/BASE2Core.jar"
    />
  </target>
  <target
    name="dist.install"
    depends="install.compile"
    description="Generate the installation jar file: BASE2Install.jar"
    >
    <jar
      basedir="${install.build}"
      jarfile="${dist.bin}/BASE2Install.jar"
    />
    <copy todir="${dist.bin}" file="${install.src}/initdb.sh" />
    <chmod file="${dist.bin}/initdb.sh" perm="a+x"/>
  </target>
  <target
    name="dist.web"
    depends="web"
    description="Generate the web jar file: BASE2Webclient.jar
      and copy all *.jsp files"
    >
    <jar
      basedir="${web.build}"
      jarfile="${dist.lib}/BASE2Webclient.jar"
    />
    <copy
      todir="${dist}/www"
      >
      <fileset dir="${www}">
        <include name="**/*"/>
        <exclude name="CVS" />
        <exclude name="**/*.jar" />
      </fileset>
    </copy>
  </target>

  <target
    name="dist.doc"
    depends=""
    description="Copy required documentation"
    >
    <copy todir="${dist}" file="${doc}/installation.txt" />
    <copy todir="${dist}" file="base2.license.txt" />
    <copy todir="${dist}/doc" file="${doc}/3rd-party-components.txt" />
    <copy todir="${dist}/doc" file="${doc}/Hibernate_modifications.txt" />
    <copy todir="${dist}/doc/licenses">
      <fileset dir="${doc}/licenses" />
    </copy>
  </target>

  <target
    name="package"
    depends="dist"
    description="Package the distribution"
    >
    <tar
      destfile="base-${base.version}.tar.gz"
      compression="gzip"
      >
      <tarfileset
        dir="${dist}"
        prefix="base-${base.version}"
        preserveLeadingSlashes="true"
      />
    </tar>
    <checksum
      file="base-${base.version}.tar.gz"
    />
  </target>

  <target
    name="clean"
    description="Remove all generated files and backup files" >
    <delete dir="${build}"/>
    <delete dir="${dist}"/>
    <delete dir="${web.inf}/lib"/>
    <delete dir="${web.inf}/classes"/>
    <delete>
      <fileset dir="." includes="**/*~" defaultexcludes="no"/>
      <fileset dir="." includes="**/.#*" defaultexcludes="no"/>
    </delete>
  </target>

  <target name="uml"
    description="generate uml for core package using UmlGraph" >
    <javadoc
      packagenames="net.sf.basedb.*"
      sourcepath="${core.src}"
      >
      <doclet name="UmlGraph" path="${lib}/umldoclet/UmlGraph.jar">
        <param name="-hide" value="java.lang.Exception"/>
      </doclet>
    </javadoc>
    <apply executable="dot">
      <arg value="-Tps"/>
      <arg value="-o${doc}/core.ps"/>
      <fileset file="graph.dot"/>
    </apply>
  </target>

  <target
    name="javadoc"
    depends="javadoc.develop"
  />

  <target
    name="javadoc.develop"
    description="generate JavaDoc for developers of BASE, ie. include private and protecteed methods.">
    <!-- Create the time stamp -->
    <tstamp>
      <format property="TODAY" pattern="yyyy-MM-dd"/>
    </tstamp>
    <mkdir dir="${doc}"/>

    <javadoc
      packagenames="net.sf.basedb.*"
      sourcepath="${core.src}:${web.src}"
      destdir="${doc.develop}"
      author="true"
      version="true"
      use="true"
      private="true"
      windowtitle="BASE 2.0 Class documentation (developer edition)"
      stylesheetfile="${doc}/styles.css"
      classpathref="core.compile.classpath"
      linksource="yes"
      breakiterator="yes"
      encoding="iso-8859-1"
      >
      <header><![CDATA[Last update: ${TODAY}]]></header>
      <link href="http://java.sun.com/j2se/1.4/docs/api"/>
      <link href="http://www.thep.lu.se/~nicklas/bioinfo"/>
      <tag name="base.internal" description="Developer info" />
      <tag name="hibernate.class" description="Hibernate: class" scope="types" />
      <tag name="hibernate.subclass" description="Hibernate: subclass" scope="types" />
      <tag name="hibernate.discriminator" description="Hibernate: discriminator" scope="types" />
      <tag name="hibernate.id" description="Hibernate: id" scope="methods" />
      <tag name="hibernate.generator-param" description="Hibernate: generator-param" scope="methods" />
      <tag name="hibernate.version" description="Hibernate: version" scope="methods" />
      <tag name="hibernate.property" description="Hibernate: property" scope="methods" />
      <tag name="hibernate.key-property" description="Hibernate: key-property" scope="methods" />
      <tag name="hibernate.column" description="Hibernate: column" scope="methods" />
      <tag name="hibernate.map" description="Hibernate: map" scope="methods" />
      <tag name="hibernate.set" description="Hibernate: set" scope="methods" />
      <tag name="hibernate.list" description="Hibernate: list" scope="methods" />
      <tag name="hibernate.array" description="Hibernate: array" scope="methods" />
      <tag name="hibernate.one-to-one" description="Hibernate: one-to-one" scope="methods" />
      <tag name="hibernate.many-to-one" description="Hibernate: many-to-one" scope="methods" />
      <tag name="hibernate.many-to-many" description="Hibernate: many-to-many" scope="methods" />
      <tag name="hibernate.index-many-to-many" description="Hibernate: index-many-to-many" scope="methods" />
      <tag name="hibernate.collection-key" description="Hibernate: collection-key" scope="methods" />
      <tag name="hibernate.collection-index" description="Hibernate: collection-index" scope="methods" />
      <tag name="hibernate.collection-composite-index" description="Hibernate: collection-composite-index" scope="methods" />
      <tag name="hibernate.collection-element" description="Hibernate: collection-element" scope="methods" />
      <tag name="hibernate.collection-composite-element" description="Hibernate: collection-composite-element" scope="methods" />
      <tag name="hibernate.collection-one-to-many" description="Hibernate: collection-one-to-many" scope="methods" />
      <tag name="hibernate.collection-many-to-many" description="Hibernate: collection-many-to-many" scope="methods" />
    </javadoc>
  </target>

  <target
    name="javadoc.public"
    description="generate public JavaDoc, ie. without private and protected methods">
    <javadoc
      packagenames="net.sf.basedb.*"
      sourcepath="${src}"
      destdir="${doc.public}"
      author="true"
      version="true"
      protected="true"
      windowtitle="BASE 2.0 Class documentation"
      stylesheetfile="${doc}/styles.css"
      classpathref="core.compile.classpath"
      breakiterator="yes"
      encoding="iso-8859-1"
      >
      <header><![CDATA[Last update: ${TODAY}]]></header>
      <link href="http://java.sun.com/j2se/1.4/docs/api"/>
      <link href="http://www.thep.lu.se/~nicklas/bioinfo"/>
      <tag name="base.internal" description="Developer info" />
      <tag name="hibernate.class" description="Hibernate: class" scope="types" enabled="false" />
      <tag name="hibernate.subclass" description="Hibernate: subclass" scope="types" enabled="false" />
      <tag name="hibernate.discriminator" description="Hibernate: discriminator" scope="types" enabled="false" />
      <tag name="hibernate.id" description="Hibernate: id" scope="methods" enabled="false" />
      <tag name="hibernate.generator-param" description="Hibernate: generator-param" scope="methods" enabled="false" />
      <tag name="hibernate.version" description="Hibernate: version" scope="methods" enabled="false" />
      <tag name="hibernate.property" description="Hibernate: property" scope="methods" enabled="false" />
      <tag name="hibernate.key-property" description="Hibernate: key-property" scope="methods" enabled="false" />
      <tag name="hibernate.column" description="Hibernate: column" scope="methods" />
      <tag name="hibernate.map" description="Hibernate: map" scope="methods" enabled="false" />
      <tag name="hibernate.set" description="Hibernate: set" scope="methods" enabled="false" />
      <tag name="hibernate.list" description="Hibernate: list" scope="methods" enabled="false" />
      <tag name="hibernate.array" description="Hibernate: array" scope="methods" enabled="false" />
      <tag name="hibernate.one-to-one" description="Hibernate: one-to-one" scope="methods" enabled="false" />
      <tag name="hibernate.many-to-one" description="Hibernate: many-to-one" scope="methods" enabled="false" />
      <tag name="hibernate.many-to-many" description="Hibernate: many-to-many" scope="methods" enabled="false" />
      <tag name="hibernate.index-many-to-many" description="Hibernate: index-many-to-many" scope="methods" enabled="false" />
      <tag name="hibernate.collection-key" description="Hibernate: collection-key" scope="methods" enabled="false" />
      <tag name="hibernate.collection-index" description="Hibernate: collection-index" scope="methods" enabled="false" />
      <tag name="hibernate.collection-composite-index" description="Hibernate: collection-composite-index" scope="methods" enabled="false" />
      <tag name="hibernate.collection-element" description="Hibernate: collection-element" scope="methods" enabled="false" />
      <tag name="hibernate.collection-composite-element" description="Hibernate: collection-composite-element" scope="methods" enabled="false" />
      <tag name="hibernate.collection-one-to-many" description="Hibernate: collection-one-to-many" scope="methods" enabled="false" />
      <tag name="hibernate.collection-many-to-many" description="Hibernate: collection-many-to-many" scope="methods" enabled="false" />
    </javadoc>
  </target>


</project>