Skip to content
Snippets Groups Projects
Commit eecb6576 authored by Goik Martin's avatar Goik Martin
Browse files

treating <methodname> elements properly with respect to javadoc

parent baca70cc
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
Doc/course.xml
+ 68
− 15
View file @ eecb6576
......@@ -5996,7 +5996,7 @@ public interface Node {
...
}</programlisting>
 
<para>We take <methodname>getChildNodes()</methodname> as an
<para>We take <methodname>org.w3c.dom.Node.getChildNodes()</methodname> as an
example:</para>
 
<figure xml:id="domRetrieveChildren">
......@@ -6527,7 +6527,7 @@ public class HtmlTree {
<callout arearefs="programlisting_catalog2html_insertproduct"
xml:id="programlisting_catalog2html_insertproduct_co">
<para>Calling
<methodname>appendIteprogramlisting_catalog2html_insertproduct_com(...)</methodname>
<methodname>solve.dom.HtmlTree.appendItem(String,String)</methodname>
once per product completes the creation of our HTML DOM
tree:</para>
 
......@@ -7251,7 +7251,7 @@ INSERT INTO Product VALUES('w-124', 110.40);</programlisting>
<answer>
<para>The additional functionality on top of <xref
linkend="xml2xml"/> is represented by a method
<methodname>addPrices</methodname>. This method modifies the
<methodname>dom.xsl.XmlRdbms2Html.addPrices()</methodname>. This method modifies the
<acronym xlink:href="http://www.w3.org/DOM">DOM</acronym>
input tree prior to applying the XSL. Prices are being
inserting based on data received from an RDBMS via
......@@ -11177,8 +11177,7 @@ PersistenceHandler.username=foo&lt;/pre&gt;
<para>Notice also the
<classname>java.awt.event.WindowAdapter</classname>
implementation being executed when closing the application's
main window. The <methodname>windowClosing(WindowEvent
e)</methodname> method disconnects any existing database
main window. The <methodname>java.awt.event.WindowAdapter.windowClosing(java.awt.event.WindowEvent)</methodname> method disconnects any existing database
connection thus freeing resources.</para>
 
<programlisting language="java">package sda.jdbc.intro.v1;
......@@ -12713,8 +12712,8 @@ public class HashProvider {
...}</programlisting>
 
<para>We may test the two class methods
<methodname>getSaltedHash</methodname>(...) and
<methodname>check(...)</methodname> by a separate driver
<methodname>sda.jdbc.intro.auth.HashProvider.getSaltedHash(char[])</methodname>(...) and
<methodname>sda.jdbc.intro.auth.HashProvider.check(char[],String)</methodname> by a separate driver
class. Notice the <quote>$</quote> sign <coref
linkend="saltPwhashSeparator"/> separating salt and password
hash:</para>
......@@ -16253,7 +16252,7 @@ Exception in thread "main" org.hibernate.ObjectNotFoundException: <co
<classname>org.hibernate.ObjectNotFoundException</classname>.</para>
 
<para>The documentation also tells us to use the
corresponding <methodname>get()</methodname> method which
corresponding <methodname>org.hibernate.Session.get(Class,Serializable)</methodname> method which
actually returns <code>null</code> in case a primary key
value does not exist:</para>
 
......@@ -16351,7 +16350,7 @@ uid=wings, Fred Wings</programlisting>
xml:id="hqlWithSelect"/>);
final Object queryResult <co xml:id="queryResultFromSelect"/>= searchUsers.list();</programlisting>
 
<para>Use the <methodname>getSimpleName()</methodname>
<para>Use the <methodname>Class.getSimpleName()</methodname>
reflection method to iteratively analyze the
<code>queryResult</code> <coref
linkend="queryResultFromSelect"/> instance's structure. This
......@@ -16428,7 +16427,7 @@ Found user 'Fred Wings'</programlisting>
</section>
 
<section xml:id="mappingSingleClasses">
<title>Mapping single classes and database tables</title>
<title>Mapping single entities and database tables</title>
 
<section xml:id="transientProperties">
<title>Transient properties</title>
......@@ -16789,8 +16788,7 @@ public class Project {
<qandadiv>
<qandaentry>
<question>
<para>The setter void <methodname>setId(int
id)</methodname>in
<para>The setter void <methodname annotations="nojavadoc">setId(int)</methodname>in
<classname>hibintro.v6.Project</classname> has protected
access. Explain this choice.</para>
</question>
......@@ -17754,12 +17752,67 @@ CREATE TABLE BankAccount (
<section xml:id="inheritTablePerConcrete">
<title>Table per concrete class</title>
 
<para/>
<para>Not covered here.</para>
</section>
</section>
 
<section xml:id="mappingRelatedClasses">
<title>Mapping related classes</title>
<section xml:id="mappingRelatedEntities">
<title>Mapping related entities</title>
<section xml:id="primaryKeyRevisit">
<title>Primary keys revisited</title>
<para>Following <xref linkend="Bauer05"/> (p.88) we list important
properties of primary keys with respect to <quote>best
practices</quote> on top of their relational counterparts:</para>
<itemizedlist>
<listitem>
<para>A primary key's values never change </para>
</listitem>
<listitem>
<para>Primary key values should not have a business
meaning</para>
</listitem>
<listitem>
<para>Primary keys should be chosen to have proper indexing
support with respect to the database product in question.</para>
</listitem>
</itemizedlist>
<para>Regarding persistence we have three different concepts
regarding an object's identity:</para>
<glosslist>
<glossentry>
<glossterm>Java Object identity</glossterm>
<glossdef>
<para>The operator == checks whether two identifiers point to
the same memory address.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>Java Object equality</glossterm>
<glossdef>
<para>The
<methodname>Object.equals(Object)</methodname>.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm/>
<glossdef>
<para/>
</glossdef>
</glossentry>
</glosslist>
</section>
 
<section xml:id="sect_MappingEmbeddedClass">
<title>Mapping a single embedded class</title>
......
ws/Docbook/Dbtools/Testdata/method.xml 0 → 100644
+ 34
− 0
View file @ eecb6576
<?xml version="1.0" encoding="UTF-8"?>
<book version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
<info>
<title/>
<author>
<personname><firstname/><surname/></personname>
<affiliation>
<orgname/>
</affiliation>
</author>
<pubdate/>
</info>
<chapter xml:id="chap">
<title>Methods</title>
<para>Lets assume a static method
<methodname>java.lang.String.equals(java.lang.Object)</methodname> an a
non-static method <methodname>String.indexOf(String,int)</methodname>,
<methodname>String.hashCode()</methodname>.</para>
<para> <methodname>String.getChars(int,int,char[],int)</methodname>
</para>
</chapter>
</book>
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment