/**
* Hibernate xdoclet tags are included to generate the mapping files
* It is declared serializable to enable passing through to web layers. 
* It could be considered in the future to implement the Memento pattern
* to successfully serialze this object between applications running different
* versions of the code.  However, this is not required at this time.
*
* @hibernate.class
*       table="scientific_names"
*/
public class ScientificName implements Serializable {
   /**
    * To allow robust serialization
    */
   private static final long serialVersionUID = -7527155826957740342L;

   /**
    * The family we belong to
    */
   protected Family family;
   
   /**
    * The record id is a unique identifier
    */
   protected long recordId;

   /**
    * The name code
    */
   protected String nameCode;

   /**
    * The genus
    */
   protected String genus;

   /**
    * The species
    */
   protected String species;

   /**
    * The infraSpecies
    */
   protected String infraSpecies;

   /**
    * The infraSpeciesMarker
    */
   protected String infraSpeciesMarker;

   /**
    * The author
    */
   protected String author;

   /**
    * @return The unique record id
    * @hibernate.id
    *       generator-class="native"
    *       column="record_id"
    */
   public long getRecordId() {
      return recordId;
   }

   /**
    * @param recordId To set
    */
   public void setRecordId(long recordId) {
      this.recordId = recordId;
   }

   /**
    * @return Returns the family.
    * @hibernate.many-to-one
    *    column="family_id"
    *    not-null="true"
    */
   public Family getFamily() {
      return family;
   }

   /**
    * @param family The family to set.
    */
   public void setFamily(Family family) {
      this.family = family;
   }

   /**
    * @return Returns the author.
    * @hibernate.property
    *       column="author"
    */
   public String getAuthor() {
      return author;
   }

   /**
    * @param author The author to set.
    */
   public void setAuthor(String author) {
      this.author = author;
   }

   /**
    * @return Returns the genus.
    * @hibernate.property
    *       column="genus"
    */
   public String getGenus() {
      return genus;
   }

   /**
    * @param genus The genus to set.
    */
   public void setGenus(String genus) {
      this.genus = genus;
   }

   /**
    * @return Returns the infraSpecies.
    * @hibernate.property
    *       column="infraSpecies"
    */
   public String getInfraSpecies() {
      return infraSpecies;
   }

   /**
    * @param infraSpecies The infraSpecies to set.
    */
   public void setInfraSpecies(String infraSpecies) {
      this.infraSpecies = infraSpecies;
   }

   /**
    * @return Returns the infraSpeciesMarker.
    * @hibernate.property
    *       column="infraspecies_marker"
    */
   public String getInfraSpeciesMarker() {
      return infraSpeciesMarker;
   }

   /**
    * @param infraSpeciesMarker The infraSpeciesMarker to set.
    */
   public void setInfraSpeciesMarker(String infraSpeciesMarker) {
      this.infraSpeciesMarker = infraSpeciesMarker;
   }

   /**
    * @return Returns the nameCode.
    * @hibernate.property
    *       column="name_code"
    */
   public String getNameCode() {
      return nameCode;
   }

   /**
    * @param nameCode The nameCode to set.
    */
   public void setNameCode(String nameCode) {
      this.nameCode = nameCode;
   }

   /**
    * @return Returns the species.
    * @hibernate.property
    *       column="species"
    */
   public String getSpecies() {
      return species;
   }

   /**
    * @param species The species to set.
    */
   public void setSpecies(String species) {
      this.species = species;
   }

   /**
    * Considered equal if the target is the same type and has the same record id
    * @see java.lang.Object#equals(Object)
         * @todo: implement a proper equals and hashcode
    */
   public boolean equals(Object object) {
      if (!(object instanceof ScientificName)) {
         return false;
      }
      ScientificName target = (ScientificName) object;
      if (this.getRecordId() == target.getRecordId()) {
         return true;
      } else {
         return false;
      }
   }

   /**
    * A string representation of the dao for logging purposes
    * @see java.lang.Object#toString()
    */
   public String toString() {
      StringBuffer sb = new StringBuffer();
      sb.append(Long.toString(recordId))
         .append(" - ")
         .append(genus)
         .append(": ")
         .append(species)
         .append(": ")
         .append(author);
      return sb.toString();
   }
}

    <!-- The "hibernatedoclet" target generates Hibernate mapping files
         based on XDoclet marked-up Plain Old Java Object (POJO) -->
    <target name="hibernate.doclet" depends="prepare" description="Generate Hibernate mapping files">
       <taskdef name="hibernatedoclet" classname="xdoclet.modules.hibernate.HibernateDocletTask" classpathref="xdoclet.classpath"/>
        <hibernatedoclet destdir="${classes.dir}" excludedtags="@version,@author" addedtags="@xdoclet-generated at ${TODAY}"
            force="true">
            <fileset dir="${src.dir}" includes="**/model/**/*.java"/>
            <hibernate validatexml="true" version="3.0"/>
        </hibernatedoclet>
    </target>

   <!-- Based on the hibernate mapping template, generate the configuration -->
    <target name="generate.hibernate.config" depends="hibernate.doclet" description="Generate the database">
      <taskdef name="hibernatetool" classname="org.hibernate.tool.ant.HibernateToolTask" classpathref="xdoclet.classpath" />
      <hibernatetool destdir="${classes.dir}">
         <configuration configurationfile="${conf.dir}/hibernate.dialect.xml">
            <fileset dir="${classes.dir}">
               <include name="**/*.hbm.xml" />
            </fileset>
         </configuration>
         <hbm2cfgXml/>
      </hibernatetool>
    </target>

   <!-- Based on the hibernate mappings, generate the database schema (DB must exist - it will be dropped though) -->
    <target name="generate.database.script" depends="prepare,generate.hibernate.config" description="Generate the database">
      <mkdir dir="${db.dir}"/>
       <taskdef name="hibernatetool" classname="org.hibernate.tool.ant.HibernateToolTask" classpathref="xdoclet.classpath" />
      <hibernatetool destdir="${db.dir}">
         <classpath>
             <path location="${classes.dir}"/>
         </classpath>          
         <configuration configurationfile="${conf.dir}/hibernate.dialect.xml">
            <fileset dir="${classes.dir}">
               <include name="**/*.hbm.xml" />
            </fileset>
         </configuration>
         <hbm2ddl outputfilename="${project.name}-create.sql" export="false" console="true" create="true" />
      </hibernatetool>
      <!-- now fix the file -->
      <replaceregexp file="${db.dir}/${project.name}-create.sql"
                     match="^(alter table .* drop foreign key .*)"
                     replace="-- SKIP \1"
                     flags="i"
                     byline="true"/>         
      <replaceregexp file="${db.dir}/${project.name}-create.sql"
                     match="^(drop table if exists .*)"
                     replace="-- SKIP \1"
                     flags="i"
                     byline="true"/>         
    </target>