Derby
  1. Derby
  2. DERBY-1997

Misleading text in WwdEmbedded demo source file for Working With Derby

    Details

    • Urgency:
      Normal

      Description

      I'm making some minor fixes to the Working With Derby manual (DERBY-1948, DERBY-1972). The description of the WwdEmbedded.java program in the HTML generated from the file rwwdactivity3.dita (http://db.apache.org/derby/docs/dev/workingwithderby/) contains the following paragraph:

      DERBY EXCEPTION REPORTING CLASSES: The two methods at the end of the file, errorPrint and SQLExceptionPrint, are generic exception reporting routines that can be used with any JDBC program. This type of exception handling is required because often multiple exceptions (SQLException) are chained together then thrown. A while loop is used to report on each error in the chain. These classes are used by calling the errorPrint method from the catch block of the code that accesses the database.

      The introductory text "DERBY EXCEPTION REPORTING CLASSES" is keyed to a comment with the same text in the DERBY_HOME/demo/programs/workingwithderby/WwdEmbedded.java program:

      // ## DERBY EXCEPTION REPORTING CLASSES ##

      /*** Exception reporting methods

        • with special handling of SQLExceptions

      ***/

      The problem is that there are no Derby exception reporting classes, only methods, as far as I can tell. The use of the term CLASSES is likely to confuse any users not well acquainted with Java (one of the target audiences of this manual). It would be great if someone could change CLASSES to METHODS in the WwdEmbedded.java file so that I can make the corresponding fix to the rwwdactivity3.dita file. I would also have to correct the confusing last sentence of the paragraph; I think it would make more sense to say, "The program starts this process by calling the errorPrint method from the catch block of the code that accesses the database." (I can't just change "classes" to "methods" because errorPrint is one of the methods.

      1. vcs-diff3523819486798216332.patch
        2 kB
        Dyre Tjeldvoll
      2. vcs-diff7276709987551559550.patch
        2 kB
        Dyre Tjeldvoll
      3. DERBY-1997.diff
        3 kB
        Kim Haase
      4. DERBY-1997.stat
        0.1 kB
        Kim Haase
      5. DERBY-1997-doc.diff
        8 kB
        Kim Haase
      6. DERBY-1997-doc.stat
        0.1 kB
        Kim Haase
      7. DERBY-1997-doc.zip
        8 kB
        Kim Haase

        Issue Links

          Activity

          Kim Haase created issue -
          Knut Anders Hatlen made changes -
          Field Original Value New Value
          Urgency Normal
          Issue & fix info [Known fix]
          Component/s Documentation [ 11406 ]
          Kathey Marsden made changes -
          Labels derby_triage10_5_2
          Dyre Tjeldvoll made changes -
          Attachment vcs-diff3523819486798216332.patch [ 12589152 ]
          Dyre Tjeldvoll made changes -
          Attachment vcs-diff7276709987551559550.patch [ 12589254 ]
          Gavin made changes -
          Workflow jira [ 12387659 ] Default workflow, editable Closed status [ 12802438 ]
          Kim Haase made changes -
          Assignee Kim Haase [ chaase3 ]
          Kim Haase made changes -
          Link This issue is blocked by DERBY-6459 [ DERBY-6459 ]
          Knut Anders Hatlen made changes -
          Link This issue is related to DERBY-6484 [ DERBY-6484 ]
          Kim Haase made changes -
          Link This issue is blocked by DERBY-6459 [ DERBY-6459 ]
          Knut Anders Hatlen made changes -
          Link This issue is related to DERBY-6488 [ DERBY-6488 ]
          Kim Haase made changes -
          Attachment DERBY-1997.diff [ 12633383 ]
          Attachment DERBY-1997.stat [ 12633384 ]
          Kim Haase made changes -
          Issue & fix info Known fix [ 10426 ] Known fix,Patch Available [ 10426, 10102 ]
          Kim Haase made changes -
          Attachment DERBY-1997-doc.diff [ 12633698 ]
          Attachment DERBY-1997-doc.stat [ 12633699 ]
          Attachment DERBY-1997-doc.zip [ 12633700 ]
          Kim Haase made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Issue & fix info Known fix,Patch Available [ 10426, 10102 ]
          Fix Version/s 10.11.0.0 [ 12324243 ]
          Resolution Fixed [ 1 ]
          Kim Haase made changes -
          Status Resolved [ 5 ] Closed [ 6 ]

            People

            • Assignee:
              Kim Haase
              Reporter:
              Kim Haase
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development