Changeset 1610 for trunk/src/xml/xsl/generate-log-message-info.xsl

Timestamp:

03/11/10 08:19:11 (2 years ago)

Author:

amandel

Message:

Implemented #78.
If a variable used in a message starts with a colon (:) and no type definition, the parameter is assumed to be already set. This gives access to implied parameters of the log message, such as _THREAD_ID or _CAUSE and also to the parameters that are bound to the thread context.

Files:

• trunk/src/xml/xsl/generate-log-message-info.xsl (modified) (21 diffs)

trunk/src/xml/xsl/generate-log-message-info.xsl

@@ -214 +214 @@
       </xsl:call-template>
    </xsl:variable>
+   <xsl:variable name="has-expicit-parameters"><xsl:call-template name="has-expicit-parameters">
+         <xsl:with-param name="tokens" select="$tokens"/>
+      </xsl:call-template>
+   </xsl:variable>
 package <xsl:value-of select="$package"/>;
 
@@ -234 +238 @@
    static final long serialVersionUID = 1L;
 
-   <xsl:if test="normalize-space($tokens)"><xsl:call-template
+   <xsl:if test="$has-expicit-parameters != 'false'"><xsl:call-template
       name="exception-clazz-member-list">
             <xsl:with-param name="tokens" select="$tokens"/></xsl:call-template></xsl:if>
@@ -245 +249 @@
     * @param cause the cause of this exception.
     */
-   public <xsl:value-of select="$classname"/> (<xsl:if
-      test="normalize-space($tokens)"><xsl:call-template name="inner-clazz-log-parameter-list">
-            <xsl:with-param name="tokens" select="$tokens"/>
-         </xsl:call-template>
-      ,</xsl:if> Throwable cause)
+   public <xsl:value-of select="$classname"/> (<xsl:call-template name="inner-clazz-log-parameter-list">
+            <xsl:with-param name="tokens" select="concat($tokens, $DEFAULT_STRING_SEPARATOR, 'Throwable:cause')"/>
+         </xsl:call-template>)
    {
       super(<xsl:value-of select="$group-classname"/>.<xsl:value-of select="$constant-name"/>, cause);
-      <xsl:if test="normalize-space($tokens)">
+      <xsl:if test="$has-expicit-parameters != 'false'">
       <xsl:call-template name="exception-clazz-member-init">
          <xsl:with-param name="tokens" select="$tokens"/>
@@ -276 +278 @@
    {
       super(<xsl:value-of select="$group-classname"/>.<xsl:value-of select="$constant-name"/>);
-      <xsl:if test="normalize-space($tokens)">
+      <xsl:if test="$has-expicit-parameters != 'false'">
       <xsl:call-template name="exception-clazz-member-init">
          <xsl:with-param name="tokens" select="$tokens"/>
@@ -667 +669 @@
          select="$groupNameAbbr"/>_<xsl:value-of
          select="$message/@name"/></xsl:variable>
+   <xsl:variable name="has-expicit-parameters"><xsl:call-template name="has-expicit-parameters">
+         <xsl:with-param name="tokens" select="$tokens"/>
+   </xsl:call-template></xsl:variable>
+
       /**
        * The unique symbolic String of the log message
@@ -753 +759 @@
             <xsl:when test="normalize-space($tokens)">
          addParameters(new <xsl:value-of select="$log-event-class"/>(<xsl:value-of
-            select="$constant"/><xsl:if test="$isAudit">, auditPrincipal</xsl:if>),
+            select="$constant"/><xsl:if test="$isAudit">, auditPrincipal</xsl:if>)
                <xsl:call-template
                   name="inner-clazz-log-parameter-call">
                   <xsl:with-param name="tokens" select="$tokens"/>
-                  <xsl:with-param name="isAudit" select="$isAudit"/>
+                  <xsl:with-param name="isFirst" select="false()"/>
                </xsl:call-template>).log();</xsl:when>
             <xsl:otherwise>
@@ -776 +782 @@
       public static void log (<xsl:call-template
                   name="inner-clazz-log-parameter-list">
-                  <xsl:with-param name="tokens" select="$tokens"/>
-                  <xsl:with-param name="isAudit" select="$isAudit"/>
-               </xsl:call-template><xsl:if test="$isAudit or normalize-space($tokens)">,</xsl:if>
-               Throwable cause
+                  <xsl:with-param name="tokens" select="concat($tokens, $DEFAULT_STRING_SEPARATOR, 'Throwable:cause')"/>
+                  <xsl:with-param name="isAudit" select="$isAudit"/></xsl:call-template>
             )
       {<xsl:choose>
             <xsl:when test="normalize-space($tokens)">
-         addParameters(new <xsl:value-of select="$log-event-class"/>(<xsl:value-of select="$constant"/><xsl:if test="$isAudit">, auditPrincipal</xsl:if>, cause),
-               <xsl:call-template
+         addParameters(new <xsl:value-of select="$log-event-class"/>(<xsl:value-of
+           select="$constant"/><xsl:if test="$isAudit">, auditPrincipal</xsl:if>, cause)<xsl:call-template
                   name="inner-clazz-log-parameter-call">
                   <xsl:with-param name="tokens" select="$tokens"/>
-                  <xsl:with-param name="isAudit" select="$isAudit"/>
+                  <xsl:with-param name="isFirst" select="false()"/>
                </xsl:call-template>).log();</xsl:when>
             <xsl:otherwise>
@@ -806 +810 @@
                </xsl:call-template>
        */
-      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if
-       test="$isAudit or normalize-space($tokens)">, <xsl:call-template
+      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:call-template
                   name="inner-clazz-log-parameter-list">
                   <xsl:with-param name="tokens" select="$tokens"/>
                   <xsl:with-param name="isAudit" select="$isAudit"/>
-          </xsl:call-template></xsl:if>)
+                  <xsl:with-param name="isFirst" select="false()"/>
+          </xsl:call-template>)
       {
         final <xsl:value-of select="$log-event-class"/> logEvent
           = new <xsl:value-of select="$log-event-class"/>(<xsl:value-of
               select="$constant"/><xsl:if test="$isAudit">, auditPrincipal</xsl:if>);
-           <xsl:if test="normalize-space($tokens)">
+           <xsl:if test="$has-expicit-parameters != 'false'">
+        addParameters(logEvent
+               <xsl:call-template
+                  name="inner-clazz-log-parameter-call">
+                  <xsl:with-param name="tokens" select="$tokens"/>
+                  <xsl:with-param name="isFirst" select="false()"/>
+               </xsl:call-template>);
+           </xsl:if>
+
+        logger.logp(<xsl:value-of select="$constant"/>.getLogLevel(),
+          <xsl:if test="$custom-logger-class != 'java.util.logging.Logger'">
+           <xsl:value-of select="$constant"/>.getSymbol(),</xsl:if>
+           logEvent.getSourceClass(),
+           logEvent.getSourceMethod(), <xsl:if test="$custom-logger-class = 'java.util.logging.Logger'">
+           <xsl:value-of select="$constant"/>.getSymbol() + "|" + </xsl:if>
+           logEvent.getTrackingNumber() + "|" + logEvent.getMessage(),
+           (Object) logEvent);
+      }
+
+      /**
+       * Logs the message
+       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
+       * with the given parameters to the custom logger.
+       * @param logger the custom logger to log to.<xsl:call-template
+                  name="inner-clazz-log-parameter-javadoc">
+                  <xsl:with-param name="tokens" select="$tokens"/>
+                  <xsl:with-param name="isAudit" select="$isAudit"/>
+               </xsl:call-template>
+       * @param cause the Throwable that causes this message to be logged.
+       */
+      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:call-template
+                  name="inner-clazz-log-parameter-list">
+                  <xsl:with-param name="tokens" select="concat($tokens, $DEFAULT_STRING_SEPARATOR, 'Throwable:cause')"/>
+                  <xsl:with-param name="isAudit" select="$isAudit"/>
+                  <xsl:with-param name="isFirst" select="false()"/>
+          </xsl:call-template>
+            )
+      {
+        final <xsl:value-of select="$log-event-class"/> logEvent
+          = new <xsl:value-of select="$log-event-class"/>(<xsl:value-of
+              select="$constant"/><xsl:if test="$isAudit">, auditPrincipal</xsl:if>,
+              cause);
+           <xsl:if test="$has-expicit-parameters != 'false'">
         addParameters(logEvent,
                <xsl:call-template
@@ -835 +881 @@
       }
 
-      /**
-       * Logs the message
-       * &lt;tt>"<xsl:value-of select="normalize-space($message/text)"/>"&lt;/tt>
-       * with the given parameters to the custom logger.
-       * @param logger the custom logger to log to.<xsl:call-template
-                  name="inner-clazz-log-parameter-javadoc">
-                  <xsl:with-param name="tokens" select="$tokens"/>
-                  <xsl:with-param name="isAudit" select="$isAudit"/>
-               </xsl:call-template>
-       * @param cause the Throwable that causes this message to be logged.
-       */
-      public static void log (<xsl:value-of select="$custom-logger-class"/> logger<xsl:if
-       test="$isAudit or normalize-space($tokens)">, <xsl:call-template
-                  name="inner-clazz-log-parameter-list">
-                  <xsl:with-param name="tokens" select="$tokens"/>
-                  <xsl:with-param name="isAudit" select="$isAudit"/>
-          </xsl:call-template></xsl:if>,
-               Throwable cause
-            )
-      {
-        final <xsl:value-of select="$log-event-class"/> logEvent
-          = new <xsl:value-of select="$log-event-class"/>(<xsl:value-of
-              select="$constant"/><xsl:if test="$isAudit">, auditPrincipal</xsl:if>,
-              cause);
-           <xsl:if test="normalize-space($tokens)">
-        addParameters(logEvent,
-               <xsl:call-template
-                  name="inner-clazz-log-parameter-call">
-                  <xsl:with-param name="tokens" select="$tokens"/>
-                  <xsl:with-param name="isAudit" select="$isAudit"/>
-               </xsl:call-template>);
-           </xsl:if>
-
-         logger.logp(<xsl:value-of select="$constant"/>.getLogLevel(),
-          <xsl:if test="$custom-logger-class != 'java.util.logging.Logger'">
-           <xsl:value-of select="$constant"/>.getSymbol(),</xsl:if>
-           logEvent.getSourceClass(),
-           logEvent.getSourceMethod(), <xsl:if test="$custom-logger-class = 'java.util.logging.Logger'">
-           <xsl:value-of select="$constant"/>.getSymbol() + "|" + </xsl:if>
-           logEvent.getTrackingNumber() + "|" + logEvent.getMessage(),
-           (Object) logEvent);
-      }
-
         </xsl:if>
 
@@ -952 +955 @@
        * @return the given initialized &lt;tt>loggable&lt;/tt>.
        */
-      public static Loggable addParameters (Loggable loggable<xsl:if
-         test="normalize-space($tokens)">,</xsl:if> <xsl:call-template
-                  name="inner-clazz-log-parameter-list">
-                  <xsl:with-param name="tokens" select="$tokens"/>
+      public static Loggable addParameters (Loggable loggable<xsl:call-template
+                  name="inner-clazz-log-parameter-list-sub">
+                  <xsl:with-param name="tokens" select="$tokens"/>
+                  <xsl:with-param name="isFirst" select="false()"/>
                </xsl:call-template>)
       {<xsl:call-template
@@ -1022 +1025 @@
    <xsl:param name="tokens" select="''"/>
    <xsl:param name="isAudit" select="false()"/>
+   <xsl:param name="isFirst" select="true()"/>
+
+   <xsl:if test="$isAudit"><xsl:if test="not($isFirst)">, </xsl:if>
+      AuditPrincipal auditPrincipal</xsl:if>
+    <xsl:call-template name="inner-clazz-log-parameter-list-sub">
+       <xsl:with-param name="tokens" select="$tokens"/>
+       <xsl:with-param name="isFirst" select="not($isAudit) and $isFirst"/>
+    </xsl:call-template>
+</xsl:template>
+<xsl:template name="inner-clazz-log-parameter-list-sub">
+   <xsl:param name="tokens" select="''"/>
+   <xsl:param name="isFirst"/>
    <xsl:variable name="type-token">
       <xsl:call-template name="string-set-next-token">
@@ -1034 +1049 @@
    </xsl:variable>
    <xsl:variable name="type" select="substring-before($type-token, ':')"/>
-   <xsl:if test="$isAudit">
-      AuditPrincipal auditPrincipal</xsl:if>
-   <xsl:if test="normalize-space($token)">
-         <xsl:if test="$isAudit"><xsl:text>,</xsl:text></xsl:if> <!-- comma for AuditPrincipal -->
-            <xsl:value-of select="$type"/><xsl:text> </xsl:text><xsl:value-of select="$display_token"/><xsl:if
-               test="contains($tokens, $DEFAULT_STRING_SEPARATOR)">
-         <xsl:text>,</xsl:text>
-      </xsl:if>
-      <xsl:call-template name="inner-clazz-log-parameter-list">
-         <xsl:with-param name="tokens"
-            select="substring-after($tokens, $DEFAULT_STRING_SEPARATOR)"/>
-      </xsl:call-template>
-   </xsl:if>
+   <xsl:choose>
+     <xsl:when test="normalize-space($token) and normalize-space($type)">
+           <xsl:if test="not($isFirst)"><xsl:text>, </xsl:text></xsl:if>
+              <xsl:value-of select="$type"/><xsl:text> </xsl:text><xsl:value-of select="$display_token"/>
+        <xsl:call-template name="inner-clazz-log-parameter-list-sub">
+           <xsl:with-param name="tokens"
+              select="substring-after($tokens, $DEFAULT_STRING_SEPARATOR)"/>
+           <xsl:with-param name="isFirst" select="false()"/>
+        </xsl:call-template>
+     </xsl:when>
+     <xsl:otherwise>
+       <xsl:if test="normalize-space($tokens)">
+          <xsl:call-template name="inner-clazz-log-parameter-list-sub">
+             <xsl:with-param name="tokens"
+                select="substring-after($tokens, $DEFAULT_STRING_SEPARATOR)"/>
+             <xsl:with-param name="isFirst" select="$isFirst"/>
+          </xsl:call-template>
+       </xsl:if>
+     </xsl:otherwise>
+   </xsl:choose>
+</xsl:template>
+
+<xsl:template name="has-expicit-parameters">
+   <xsl:param name="tokens" select="''"/>
+   <xsl:variable name="type-token">
+      <xsl:call-template name="string-set-next-token">
+         <xsl:with-param name="s" select="$tokens"/>
+      </xsl:call-template>
+   </xsl:variable>
+   <xsl:variable name="token" select="substring-after($type-token, ':')"/>
+   <xsl:variable name="type" select="substring-before($type-token, ':')"/>
+   <xsl:choose>
+     <xsl:when test="normalize-space($token) and normalize-space($type)">true</xsl:when>
+     <xsl:when test="normalize-space($tokens)">
+          <xsl:call-template name="has-expicit-parameters">
+             <xsl:with-param name="tokens"
+                select="substring-after($tokens, $DEFAULT_STRING_SEPARATOR)"/>
+          </xsl:call-template>
+     </xsl:when>
+     <xsl:otherwise>false</xsl:otherwise>
+   </xsl:choose>
 </xsl:template>
 
@@ -1064 +1107 @@
    </xsl:variable>
    <xsl:variable name="type" select="substring-before($type-token, ':')"/>
-   <xsl:if test="normalize-space($token)">
+   <xsl:if test="normalize-space($token) and normalize-space($type)">
    private final <xsl:value-of select="$type"/><xsl:text> </xsl:text><xsl:value-of select="$display_token"/>;
       <xsl:call-template name="exception-clazz-member-list">
@@ -1094 +1137 @@
    </xsl:variable>
    <xsl:variable name="type" select="substring-before($type-token, ':')"/>
-   <xsl:if test="normalize-space($token)">
+   <xsl:if test="normalize-space($token) and normalize-space($type)">
    <xsl:value-of select="$member_token"/> = <xsl:choose><xsl:when
       test="$with = 'param'"><xsl:value-of select="$display_token"/></xsl:when>
@@ -1131 +1174 @@
    </xsl:variable>
    <xsl:variable name="type" select="substring-before($type-token, ':')"/>
-   <xsl:if test="normalize-space($token)">
+   <xsl:if test="normalize-space($token) and normalize-space($type)">
    /**
     * Returns the value of the parameter &lt;tt><xsl:value-of select="$display_token"/>&lt;/tt>.
@@ -1158 +1201 @@
    </xsl:variable>
    <xsl:variable name="token" select="substring-after($type-token, ':')"/>
+   <xsl:variable name="type" select="substring-before($type-token, ':')"/>
    <xsl:variable name="display_token">
       <xsl:call-template name="asJavaParameter">
@@ -1172 +1216 @@
        *      log event.
    </xsl:if>
-   <xsl:if test="normalize-space($token)">
+   <xsl:if test="normalize-space($token) and normalize-space($type)">
        * @param <xsl:value-of select="$display_token"/> The <xsl:value-of
                select="$display_text"/> used in the message.<xsl:call-template
@@ -1185 +1229 @@
 <xsl:template name="inner-clazz-log-parameter-call">
    <xsl:param name="tokens" select="''"/>
+   <xsl:param name="isFirst" select="true()"/>
    <xsl:variable name="type-token">
       <xsl:call-template name="string-set-next-token">
@@ -1191 +1236 @@
    </xsl:variable>
    <xsl:variable name="token" select="substring-after($type-token, ':')"/>
+   <xsl:variable name="type" select="substring-before($type-token, ':')"/>
    <xsl:variable name="display_token">
       <xsl:call-template name="asJavaParameter">
@@ -1196 +1242 @@
       </xsl:call-template>
    </xsl:variable>
-   <xsl:if test="normalize-space($token)">
-             <xsl:value-of select="$display_token"/><xsl:if
-               test="contains($tokens, $DEFAULT_STRING_SEPARATOR)">
-         <xsl:text>, </xsl:text>
-      </xsl:if>
-      <xsl:call-template name="inner-clazz-log-parameter-call">
-         <xsl:with-param name="tokens"
-            select="substring-after($tokens, $DEFAULT_STRING_SEPARATOR)"/>
-      </xsl:call-template>
-   </xsl:if>
+   <xsl:choose>
+     <xsl:when test="normalize-space($token) and normalize-space($type)">
+       <xsl:if test="not($isFirst)"><xsl:text>, </xsl:text>
+       </xsl:if><xsl:value-of select="$display_token"/>
+       <xsl:call-template name="inner-clazz-log-parameter-call">
+           <xsl:with-param name="tokens"
+              select="substring-after($tokens, $DEFAULT_STRING_SEPARATOR)"/>
+           <xsl:with-param name="isFirst" select="false()"/>
+        </xsl:call-template>
+     </xsl:when>
+     <xsl:otherwise>
+       <xsl:if test="$tokens">
+         <xsl:call-template name="inner-clazz-log-parameter-call">
+             <xsl:with-param name="tokens"
+                select="substring-after($tokens, $DEFAULT_STRING_SEPARATOR)"/>
+             <xsl:with-param name="isFirst" select="$isFirst"/>
+          </xsl:call-template>
+       </xsl:if>
+     </xsl:otherwise>
+   </xsl:choose>
 </xsl:template>
 
@@ -1216 +1272 @@
    </xsl:variable>
    <xsl:variable name="token" select="substring-after($type-token, ':')"/>
-   <xsl:if test="normalize-space($token)">
+   <xsl:variable name="type" select="substring-before($type-token, ':')"/>
+   <xsl:if test="normalize-space($token) and normalize-space($type)">
      <xsl:variable name="display_token">
         <xsl:call-template name="asJavaParameter">