From noreply at atlassian.com Tue Jan 15 05:30:56 2008
Content-Type: multipart/mixed; boundary="===============0371158382878535731=="
MIME-Version: 1.0
From: Peter Hilton (JIRA) <noreply at atlassian.com>
To: hibernate-issues at lists.jboss.org
Subject: [hibernate-issues] [Hibernate-JIRA] Commented: (ANN-537) Support
 @Comment or column attribute on @Table and @Column
Date: Tue, 15 Jan 2008 04:30:55 -0600
Message-ID: <111713147.1200393055733.JavaMail.j2ee@atlassian01.managed.contegix.com>
In-Reply-To: 133907243.1169136404232.JavaMail.j2ee@atlassian01.managed.contegix.com

--===============0371158382878535731==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable


    [ http://opensource.atlassian.com/projects/hibernate/browse/ANN-537?pag=
e=3Dcom.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action=
_29310 ] =


Peter Hilton commented on ANN-537:
----------------------------------

Meanwhile, I have a work-around: generate the HTML documentation and then u=
se XSLT to add the column descriptions.

First, I define the comments in an XML file, where the id attributes are ta=
ble names and column names.

<?xml version=3D"1.0" encoding=3D"UTF-8"?>
<column-descriptions>
<table id=3D"customers">
	<column id=3D"customer_id">Primary key</column>
	<!-- more columns -->
</table>
<!-- more tables -->
</column-descriptions>

Then I transform each generated table_name.html file with the following XSL=
 2.0 stylesheet. XSL version 2 is required, to have multiple source documen=
ts.

<?xml version=3D"1.0" encoding=3D"UTF-8"?>
<xsl:transform version=3D"2.0" xmlns:xsl=3D"http://www.w3.org/1999/XSL/Tran=
sform"	xmlns=3D"http://www.w3.org/1999/xhtml" xpath-default-namespace=3D"ht=
tp://www.w3.org/1999/xhtml">
	<xsl:output method=3D"xhtml" doctype-public=3D"-//W3C//DTD XHTML 1.0 Stric=
t//EN" doctype-system=3D"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"=
 />
	<!-- Identity transformation. -->
	<xsl:template match=3D"node()">
		<xsl:copy>
			<xsl:copy-of select=3D"@*" />
			<xsl:apply-templates />
		</xsl:copy>
	</xsl:template>
	<!-- Column detail section: copy the heading, then output a paragraph cont=
aining the column description from column-descriptions.xml. -->
	<xsl:template match=3D"h3">
		<xsl:copy-of select=3D"."/>
		<xsl:variable name=3D"table" select=3D"substring(/html/body/h2[1], 7)"/>
		<xsl:variable name=3D"column" select=3D"substring(@id , 15)"/>
		<p><xsl:value-of select=3D"document('column-descriptions.xml')//*[@id=3D$=
table]/*[@id=3D$column]"/></p>
	</xsl:template>
</xsl:transform>

The easiest way to run this is to use Saxon-B 9.0 (http://saxon.sourceforge=
.net/) and the following Ant task.

<xslt style=3D"source/column-descriptions.xsl" basedir=3D"build/hbm2doc/tab=
les" destdir=3D"build/documentation" force=3D"yes">
	<classpath location=3D"lib/saxonb9-0-0-2j/saxon9.jar"/>
	<include name=3D"**/*.html" />
</xslt>

Also, while I am at it, I added templates to the XSL stylesheet to replace =
the HTML LINK element so I can point to my own stylesheet.



> Support @Comment or column attribute on @Table and @Column
> ----------------------------------------------------------
>
>                 Key: ANN-537
>                 URL: http://opensource.atlassian.com/projects/hibernate/b=
rowse/ANN-537
>             Project: Hibernate Annotations
>          Issue Type: Improvement
>          Components: binder
>    Affects Versions: 3.2.1
>            Reporter: Max Rydahl Andersen
>
> with hbm2ddl and hbm2doc its a shame that Annotation does not support set=
ting a comment on table and columns.

-- =

This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: htt=
p://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

       =20

--===============0371158382878535731==--