XML/XSLT Kenntnisse

In der Anfangsphase meines CMS Projekts habe ich mich ausführlich mit dem XML/XSLT/Java Framework Cocoon beschäftigt. Cocoon ist aus dem Rennen, aber XSLT setze ich hin und wieder noch ganz gerne für die Codegenerierung ein.

Mein CMS hat ca. 30 Taballen die alle eine gemeinsame Basis Tabelle erweitern. Hibernate unterstützt zwar Vererbung, aber das Reverseengineering Tool, das Konfigurationen aus der Datebank erzeugt, noch nicht. Um nicht alle 30 Konfigurationsdateien anfassen zu müssen, habe ich mir ein XSLT Script geschrieben, das die vom reverse Engineering generierten hbm.xml Files in joined subclass hbm.xml Files konvertiert. Aus diesen Files generiere ich mir mit HBM2JAVA meine (abstrakten) Java Klassen.

Aus der nachfolgenden TypPerson.hbm.xml Ausgangsdatei:

TypPerson.hbm.xml

<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN"
"http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
<!-- Generated Feb 14, 2007 8:02:13 AM by Hibernate Tools 3.2.0.b9 -->
<hibernate-mapping>
    <class name="net.empego.core.hbm.TypPerson" table="typ_person" catalog="empego">
        <comment></comment>
        <id name="id" type="long">
            <column name="id" />
            <generator class="assigned" />
        </id>
        <many-to-one name="ecEntity" class="net.empego.core.hbm.EcEntity" update="false" insert="false" fetch="select">
            <column name="id" not-null="true" unique="true">
                <comment></comment>
            </column>
        </many-to-one>
        <property name="title" type="string">
            <column name="title" length="40">
                <comment></comment>
            </column>
        </property>
        <property name="firstName" type="string">
            <column name="first_Name">
                <comment></comment>
            </column>
        </property>
        <property name="lastName" type="string">
            <column name="last_Name">
                <comment></comment>
            </column>
        </property>
        <property name="birthday" type="date">
            <column name="birthday" length="10">
                <comment></comment>
            </column>
        </property>
    </class>
</hibernate-mapping>

wird mit diesem XSLT Stylesheet:

hbm2hbm-abstract-subclass.xsl

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet     xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0" >
    
     <xsl:output method="xml" encoding="UTF-8" indent="yes"
         doctype-system="http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd" 
         doctype-public="-//Hibernate/Hibernate Mapping DTD 3.0//EN"/> 
    
    <xsl:template match="/">
        
        <hibernate-mapping>
            <xsl:apply-templates select="//hibernate-mapping"/>
         </hibernate-mapping>
    </xsl:template>
    
    <xsl:template match="hibernate-mapping">
        <xsl:if test="./class/id/@name='id'">
            <xsl:text>
    </xsl:text>
            <joined-subclass extends="net.empego.core.AbstractEntity">
                <xsl:attribute name="name"><xsl:value-of select="./class/@name"/></xsl:attribute>
                <xsl:attribute name="table"><xsl:value-of select="./class/@table"/></xsl:attribute>
                <xsl:attribute name="catalog"><xsl:value-of select="./class/@catalog"/></xsl:attribute>

                <xsl:apply-templates select="//many-to-one" mode="first"/>
                <xsl:apply-templates select="//many-to-one" mode="second"/>
                <xsl:apply-templates select="//class/property"/>
                <xsl:apply-templates select="//class/set"/>
    <xsl:text>
	</xsl:text>
            </joined-subclass>
        </xsl:if>
    </xsl:template>

    <xsl:template match="many-to-one" mode="first">
        <xsl:if test="./@class='net.empego.core.hbm.EcEntity' and ./column/@name='id' ">           
                <xsl:text>
        </xsl:text>
                <key column="id"/>
            </xsl:if>
    </xsl:template>
    
     <xsl:template match="many-to-one" mode="second">
         <xsl:if test="not(./@class='net.empego.core.hbm.EcEntity' and ./column/@name='id')">           
                <xsl:text>
        </xsl:text>
                <xsl:copy-of select="." />
            </xsl:if>
    </xsl:template>
        
    <xsl:template match="property">
    	<xsl:text>
        </xsl:text>
        <xsl:copy-of select="." />
    </xsl:template>
    <xsl:template match="set">
    	<xsl:text>
        </xsl:text>
        <xsl:copy-of select="." />
    </xsl:template>
    
</xsl:stylesheet>

die folgende

AbsTypPerson.hbm.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
<hibernate-mapping>
    <joined-subclass extends="net.empego.core.AbstractEntity" name="net.empego.core.hbm.TypPerson" table="typ_person" >
        <key column="id"/>
        <property name="title" type="string" unique="false" optimistic-lock="true" lazy="false" generated="never">
            <column name="title" length="40">
                <comment/>
            </column>
        </property>
        <property name="firstName" type="string" unique="false" optimistic-lock="true" lazy="false" generated="never">
            <column name="first_Name">
                <comment/>
            </column>
        </property>
        <property name="lastName" type="string" unique="false" optimistic-lock="true" lazy="false" generated="never">
            <column name="last_Name">
                <comment/>
            </column>
        </property>
        <property name="birthday" type="date" unique="false" optimistic-lock="true" lazy="false" generated="never">
            <column name="birthday" length="10">
                <comment/>
            </column>
        </property>
	</joined-subclass>
</hibernate-mapping>

Ein weiteres XSLT generiert leere Subklassen für alle joined subclasses, in die ich die Funktionalitäten für die persistenten Klassen implementiere und so vor dem Überschreiben durch die Codegenerierung schütze:

hbm2java-empty-subclass.xsl

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet     xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0" >
    
     <xsl:output method="text" encoding="UTF-8" indent="yes"/> 
    
    <xsl:template match="/">
        
        <hibernate-mapping>
            <xsl:apply-templates select="//hibernate-mapping"/>
         </hibernate-mapping>
    </xsl:template>
    
    <xsl:template match="hibernate-mapping">
package net.empego.core.hbm;

import <xsl:value-of select="./class/@name"/>;

public class <xsl:value-of select="./class/@name"/> extends <xsl:value-of select="./class/@name"/> {<xsl:text>
    
</xsl:text>}

    </xsl:template>

</xsl:stylesheet>

Nach dem reverse Engineering aus der Datenbank wird die gesamte Codegenerierung von einem Ant Buildfile angestoßen:

build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="empego.net" default="JavaCodegen" basedir=".">

	<property name="xslt.dir" value="${basedir}/src/codegen/XSLT_Codegen" />

	<property name="hib.rev.eng.dir" value="${basedir}/src/reveng/hib-rev-eng" />
	<property name="core.package" value="/net/empego/core/hbm" />
	<property name="hib.rev.eng.basetype.hbm.dir" value="${hib.rev.eng.dir}/basetypes${core.package}" />

	<property name="src.gen.dir" value="${basedir}/src/main/gen" />
	<property name="src.gen.basetypes.dir" value="${src.gen.dir}${core.package}" />
	<property name="hib-tools.plugin" value="C:\Programme\eclipse_tiny_WTP_2.0M4\plugins\org.hibernate.eclipse_3.2.0.beta9a">
	</property>
	<property name="jdbc.driver.jar" value="${basedir}/lib/mysql-connector-java-3.1.12.jar" />

	<property name="lib.dir" value="${hib-tools.plugin}/lib/tools" />
	<property name="edited.hbm.dir" value="${basedir}/src/codegen/edited-hbm" />

	<property name="deploy.dir" value="${basedir}/deploy" />
	<property name="build.dir" value="${basedir}/bin" />
	<property name="webapp.lib.dir" value="${basedir}/../zk.empego.net/WebContent/WEB-INF/lib" />


	<path id="toolslib">
		<path location="${hib-tools.plugin}/lib/tools/hibernate-tools.jar" />
		<path location="${hib-tools.plugin}/lib/hibernate/hibernate3.jar" />
		<path location="${hib-tools.plugin}/lib/tools/freemarker.jar" />
		<fileset dir="${hib-tools.plugin}/lib/hibernate" includes="*.jar" />

		<path location="${jdbc.driver.jar}" />
	</path>

	<taskdef name="hibernatetool"
	         classname="org.hibernate.tool.ant.HibernateToolTask" 
	         classpathref="toolslib" />

	<target name="DeleteGenerated">
		<delete>
			<fileset dir="${src.gen.basetypes.dir}">
				<include name="*.*" />
			</fileset>
		</delete>

	</target>

	<target name="HibRevEngType_2_EntiySubclassType.hbm" depends="DeleteGenerated" >
		<xslt basedir="${hib.rev.eng.basetype.hbm.dir}" destdir="${src.gen.basetypes.dir}" extension=".xml" style="${xslt.dir}/hbm2hbm-abstract-subclass.xsl">
			<include name="Ebt*.hbm.xml" />
			<include name="Typ*.hbm.xml" />
		</xslt>
	</target>

	<target name="JavaCodegen" depends="HibRevEngType_2_EntiySubclassType.hbm" description="generate the java type classes">
		<copy todir="${src.gen.basetypes.dir}" overwrite="true">
			<fileset dir="${hib.rev.eng.dir}/search${core.package}">
				<include name="Ec*.hbm.xml" />
			</fileset>
			<fileset dir="${hib.rev.eng.dir}/core${core.package}">
				<include name="Ec*.hbm.xml" />
				<exclude name="EcEntity.hbm.xml"/>
				<exclude name="EcRelation.hbm.xml"/>
			</fileset>
			<fileset dir="${edited.hbm.dir}">
				<include name="*.hbm.xml" />
			</fileset>
		</copy>

		<replace dir="${src.gen.basetypes.dir}"
			token='class="net.empego.core.hbm.EcEntity"' value='class="net.empego.core.EntityIF"'>
			<include name="*.hbm.xml"/>
			<exclude name="EcEntity.hbm.xml"/>
			<exclude name="EntityIF.hbm.xml"/>
			<exclude name="AbstractEntity.hbm.xml"/>
		</replace>
		
		<replace dir="${src.gen.basetypes.dir}"
			token='generator class="assigned" ' value='generator class="identity" '>
			<include name="Ec*.hbm.xml"/>
		</replace>

		<replace dir="${src.gen.basetypes.dir}"
			token='many-to-one name="ebtEntityType"' value='many-to-one name="ebtEntityTypeId"'>
			<include name="**/EbtEntityUsecase.hbm.xml"/>
			<include name="**/EbtEntityType.hbm.xml"/>
		</replace>
		
		<replace dir="${src.gen.basetypes.dir}"
			token='many-to-one name="ebtGeoType" class="net.empego.core.hbm.EbtGeoType" fetch="select"' 
			value='many-to-one name="ebtGeoType" class="net.empego.core.hbm.EbtGeoType" fetch="select" property-ref="geoTypeId"'>
			<include name="**/Ecg*.hbm.xml"/>
		</replace>
		
		<hibernatetool destdir="${src.gen.dir}">
			<configuration>
				<fileset dir="${src.gen.basetypes.dir}">
					<include name="*.hbm.xml" />
				</fileset>
			</configuration>
			<hbm2java jdk5="true"/>
		</hibernatetool>

		
		<replace dir="${src.gen.basetypes.dir}" 
			token='class="net.empego.core.EntityIF"' 
			value='class="net.empego.core.AbstractEntity"'>
			<include name="**/*.hbm.xml"/>
			<exclude name="**/EcEntity.hbm.xml"/>
			<exclude name="**/EntityIF.hbm.xml"/>
		</replace>

		<move file="${src.gen.basetypes.dir}/EcEntity.hbm.xml" tofile="${src.gen.basetypes.dir}/AbstractEntity.hbm.xml"/>

		<replace dir="${src.gen.basetypes.dir}" 
			token='class name="net.empego.core.hbm.EcEntity"' value='class name="net.empego.core.AbstractEntity"'>
			<include name="AbstractEntity.hbm.xml"/>
		</replace>

		<delete>
			<fileset dir="${src.gen.dir}">
				<include name="**/AbstractEntity.java" />
				<include name="**/EcEntity.hbm.xml" />
				<include name="**/EntityIF.java" />
				<include name="**/EntityIF.hbm.xml" />
			</fileset>
		</delete>

		<move todir="${src.gen.basetypes.dir}">
			<fileset dir="${src.gen.basetypes.dir}">
				<include name="E*.java"/>
				<include name="Typ*.java"/>
			</fileset>
			<mapper type="glob" from="*.java" to="Abs*.java"/>
		</move>

		<replace dir="${src.gen.basetypes.dir}" token="public class E" value="public class AbsE">
			<include name="AbsE*.java"/>
		</replace>
		
		<replace dir="${src.gen.basetypes.dir}" token="public class Typ" value="public class AbsTyp">
			<include name="AbsTyp*.java"/>
		</replace>

		<replace dir="${src.gen.basetypes.dir}" token="public Ec" value="public AbsEc">
			<include name="AbsEc*.java"/>
		</replace>

		<replace dir="${src.gen.basetypes.dir}" token="public Ebt" value="public AbsEbt">
			<include name="AbsEbt*.java"/>
		</replace>
		
		<replace dir="${src.gen.basetypes.dir}" token="public Typ" value="public AbsTyp">
			<include name="AbsTyp*.java"/>
		</replace>

		<replace dir="${src.gen.basetypes.dir}" 
			token="public AbsEbtEntityType getEbtEntityTypeId()" 
			value="public EbtEntityType getEbtEntityTypeId()">
			<include name="AbsEbtEntityType.java"/>
		</replace>
		
	</target>

	<target name="generate-empty-subclasses">
		<xslt basedir="${hib.rev.eng.dir}/all/net/empego/core/hbm" destdir="${hib.rev.eng.dir}/all-empty-subclass" extension=".xml" style="${xslt.dir}/hbm2java-empty-subclass.xsl">
			<include name="*.hbm.xml" />
		</xslt>

		<replace dir="${hib.rev.eng.dir}/all-empty-subclass" 
			token="public class net.empego.core.hbm." value="public class ">
			<include name="*.hbm.xml"/>
		</replace>

		<replace dir="${hib.rev.eng.dir}/all-empty-subclass" 
			token="extends net.empego.core.hbm." value="extends Abs">
			<include name="*.hbm.xml"/>
		</replace>

		<replace dir="${hib.rev.eng.dir}/all-empty-subclass"
			token="import net.empego.core.hbm." value="import net.empego.core.hbm.Abs">
			<include name="*.hbm.xml"/>
		</replace>

		<move todir="${hib.rev.eng.dir}/all-empty-subclass">
			<fileset dir="${hib.rev.eng.dir}/all-empty-subclass">
				<include name="*.hbm.xml"/>
			</fileset>
			<mapper type="glob" from="*.hbm.xml" to="*.java"/>
		</move>
	</target>

	<target name="generate empego.jar" description="Build empegor.jar from classes and mappings">
		<copy todir="${deploy.dir}">
			<fileset dir="${build.dir}">
				<exclude name="**/testcases/**" />
			</fileset>
		</copy>

		<xslt basedir="${build.dir}" destdir="${deploy.dir}" force="true" extension=".xml" style="${xslt.dir}/HibCfg2hbmCfgDeploy.xsl">
			<include name="hibernate.cfg.xml" />
		</xslt>

		<jar destfile="${webapp.lib.dir}/empego.jar" basedir="${deploy.dir}" excludes="**/Test_*.class" />
	</target>

	<target name="enhance setter">
		<replaceregexp file="${src.gen.basetypes.dir}/EbtGroup.java" 
			match="public void set(.*$.*$.*)}" 
			replace="public net.empego.core.EntityIF set\1 return this;}" 
			flags="gm" byline="false" />
	</target>

	<target name="enhance EbtGroup setter">
		<replaceregexp file="${src.gen.basetypes.dir}/EbtGroup.java" 
			match="public void set" 
			replace="public net.empego.core.EntityIF set" 
			flags="gm" byline="false" />
	</target>

</project>