Derby
  1. Derby
  2. DERBY-6120

Clarify that $ is the separator character which should be used for the external names of static nested classes

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.10.1.1
    • Fix Version/s: 10.10.2.0, 10.11.1.1
    • Component/s: Documentation
    • Labels:
      None

      Description

      Various user-defined objects can be created which are bound to Java methods or classes via "external name" clauses. It's easy to mis-phrase the Java class name in the "external name" clause if the class is a static nested class. The affected objects include:

      o Functions
      o Procedures
      o Types
      o Aggregates

      Consider the following class:

      public class TestFuncs
      {
      public static final class Foo
      {
      public static double pow( double base, double power )

      { return Math.pow( base, power ); }

      }
      }

      If the pow method is bound to a user-defined function via a CREATE FUNCTION command, its external name should be TestFuncs$Foo.pow, NOT TestFuncs.Foo.pow.

      We should add a section to the Reference Manual clarifying how to phrase the external name if it includes a reference to a static nested class. The detailed sections for the various user-defined objects can then refer to this new section.

      1. DERBY-6120-2.zip
        9 kB
        Kim Haase
      2. DERBY-6120-2.stat
        0.1 kB
        Kim Haase
      3. DERBY-6120-2.diff
        1 kB
        Kim Haase
      4. DERBY-6120.zip
        17 kB
        Kim Haase
      5. DERBY-6120.stat
        0.3 kB
        Kim Haase
      6. DERBY-6120.diff
        17 kB
        Kim Haase

        Activity

        Myrna van Lunteren made changes -
        Fix Version/s 10.10.2.0 [ 12326659 ]
        Fix Version/s 10.10.1.4 [ 12324247 ]
        Rick Hillegas made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Kim Haase made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Issue & fix info Patch Available [ 10102 ]
        Fix Version/s 10.10.1.3 [ 12324247 ]
        Fix Version/s 10.11.0.0 [ 12324243 ]
        Resolution Fixed [ 1 ]
        Hide
        Kim Haase added a comment -

        Thanks again, Rick.

        Committed patch DERBY-6120-2.diff to documentation trunk at revision 1531077.
        Merged to 10.10 doc branch at revision 1531078.

        Show
        Kim Haase added a comment - Thanks again, Rick. Committed patch DERBY-6120 -2.diff to documentation trunk at revision 1531077. Merged to 10.10 doc branch at revision 1531078.
        Hide
        ASF subversion and git services added a comment -

        Commit 1531078 from Kim Haase in branch 'docs/branches/10.10'
        [ https://svn.apache.org/r1531078 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Merged patch DERBY-6120-2.diff to 10.10 doc branch from trunk revision 1531077.

        Show
        ASF subversion and git services added a comment - Commit 1531078 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1531078 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Merged patch DERBY-6120 -2.diff to 10.10 doc branch from trunk revision 1531077.
        Hide
        ASF subversion and git services added a comment -

        Commit 1531078 from Kim Haase in branch 'docs/branches/10.10'
        [ https://svn.apache.org/r1531078 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Merged patch DERBY-6120-2.diff to 10.10 doc branch from trunk revision 1531077.

        Show
        ASF subversion and git services added a comment - Commit 1531078 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1531078 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Merged patch DERBY-6120 -2.diff to 10.10 doc branch from trunk revision 1531077.
        Hide
        ASF subversion and git services added a comment -

        Commit 1531077 from Kim Haase in branch 'docs/trunk'
        [ https://svn.apache.org/r1531077 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Modified 2 topics in the Reference manual.

        Patch: DERBY-6120-2.diff

        Show
        ASF subversion and git services added a comment - Commit 1531077 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1531077 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Modified 2 topics in the Reference manual. Patch: DERBY-6120 -2.diff
        Hide
        ASF subversion and git services added a comment -

        Commit 1531077 from Kim Haase in branch 'docs/trunk'
        [ https://svn.apache.org/r1531077 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Modified 2 topics in the Reference manual.

        Patch: DERBY-6120-2.diff

        Show
        ASF subversion and git services added a comment - Commit 1531077 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1531077 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Modified 2 topics in the Reference manual. Patch: DERBY-6120 -2.diff
        Hide
        Rick Hillegas added a comment -

        Thanks for the new patch, Kim. +1

        Show
        Rick Hillegas added a comment - Thanks for the new patch, Kim. +1
        Kim Haase made changes -
        Attachment DERBY-6120-2.diff [ 12607832 ]
        Attachment DERBY-6120-2.stat [ 12607833 ]
        Attachment DERBY-6120-2.zip [ 12607834 ]
        Hide
        Kim Haase added a comment -

        Attaching DERBY-6120-2.diff, DERBY-6120-2.stat, and DERBY-6120-2.zip, a second patch that adds a link in two topics:

        M src/ref/rrefcreatefunctionstatement.dita
        M src/ref/rrefcreateprocedurestatement.dita

        Show
        Kim Haase added a comment - Attaching DERBY-6120 -2.diff, DERBY-6120 -2.stat, and DERBY-6120 -2.zip, a second patch that adds a link in two topics: M src/ref/rrefcreatefunctionstatement.dita M src/ref/rrefcreateprocedurestatement.dita
        Hide
        Kim Haase added a comment -

        Committed patch DERBY-6120.diff to documentation trunk at revision 1531025.
        Merged to 10.10 doc branch at revision 1531031.

        Show
        Kim Haase added a comment - Committed patch DERBY-6120 .diff to documentation trunk at revision 1531025. Merged to 10.10 doc branch at revision 1531031.
        Hide
        ASF subversion and git services added a comment -

        Commit 1531031 from Kim Haase in branch 'docs/branches/10.10'
        [ https://svn.apache.org/r1531031 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Merged patch DERBY-6120.diff to 10.10 doc branch from trunk revision 1531025.

        Show
        ASF subversion and git services added a comment - Commit 1531031 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1531031 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Merged patch DERBY-6120 .diff to 10.10 doc branch from trunk revision 1531025.
        Hide
        ASF subversion and git services added a comment -

        Commit 1531031 from Kim Haase in branch 'docs/branches/10.10'
        [ https://svn.apache.org/r1531031 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Merged patch DERBY-6120.diff to 10.10 doc branch from trunk revision 1531025.

        Show
        ASF subversion and git services added a comment - Commit 1531031 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1531031 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Merged patch DERBY-6120 .diff to 10.10 doc branch from trunk revision 1531025.
        Hide
        ASF subversion and git services added a comment -

        Commit 1531025 from Kim Haase in branch 'docs/trunk'
        [ https://svn.apache.org/r1531025 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Added a topic to the Reference manual, modified 4 other topics and the map file.

        Patch: DERBY-6120.diff

        Show
        ASF subversion and git services added a comment - Commit 1531025 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1531025 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Added a topic to the Reference manual, modified 4 other topics and the map file. Patch: DERBY-6120 .diff
        Hide
        ASF subversion and git services added a comment -

        Commit 1531025 from Kim Haase in branch 'docs/trunk'
        [ https://svn.apache.org/r1531025 ]

        DERBY-6120 Clarify that $ is the separator character which should be used for
        the external names of static nested classes

        Added a topic to the Reference manual, modified 4 other topics and the map file.

        Patch: DERBY-6120.diff

        Show
        ASF subversion and git services added a comment - Commit 1531025 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1531025 ] DERBY-6120 Clarify that $ is the separator character which should be used for the external names of static nested classes Added a topic to the Reference manual, modified 4 other topics and the map file. Patch: DERBY-6120 .diff
        Hide
        Kim Haase added a comment -

        Thanks, Rick. I think I will commit this patch and then file another one for the fix you suggest. Previously there were links both to other topics in the manual and to subsections of this topic, which seemed confusing – so I got rid of all of them. But if there are links only to other topics that will be more consistent. There are both a subsection on EXTERNAL NAME and an additional topic, but that shouldn't be a problem.

        Show
        Kim Haase added a comment - Thanks, Rick. I think I will commit this patch and then file another one for the fix you suggest. Previously there were links both to other topics in the manual and to subsections of this topic, which seemed confusing – so I got rid of all of them. But if there are links only to other topics that will be more consistent. There are both a subsection on EXTERNAL NAME and an additional topic, but that shouldn't be a problem.
        Hide
        Rick Hillegas added a comment -

        Hi Kim,

        These changes look great to me. +1. An extra bit of polishing might be useful:

        In some topics, the "external name" keywords in the grammar hotlink to the new topic. I like that. The topics with this behavior are rrefsqljcreatetype and rrefsqljcreateaggregate. It might be nice if rrefcreatefunctionstatement and rrefcreateprocedurestatement followed this pattern too.

        Thanks,
        -Rick

        Show
        Rick Hillegas added a comment - Hi Kim, These changes look great to me. +1. An extra bit of polishing might be useful: In some topics, the "external name" keywords in the grammar hotlink to the new topic. I like that. The topics with this behavior are rrefsqljcreatetype and rrefsqljcreateaggregate. It might be nice if rrefcreatefunctionstatement and rrefcreateprocedurestatement followed this pattern too. Thanks, -Rick
        Kim Haase made changes -
        Issue & fix info Patch Available [ 10102 ]
        Kim Haase made changes -
        Attachment DERBY-6120.diff [ 12607647 ]
        Attachment DERBY-6120.stat [ 12607648 ]
        Attachment DERBY-6120.zip [ 12607649 ]
        Hide
        Kim Haase added a comment -

        Attaching DERBY-6120.diff, DERBY-6120.stat, and DERBY-6120.zip, with the following changes:

        A src/ref/rrefsqljexternalname.dita
        M src/ref/refderby.ditamap
        M src/ref/rrefcreatefunctionstatement.dita
        M src/ref/rrefcreateprocedurestatement.dita
        M src/ref/rrefsqljcreatetype.dita
        M src/ref/rrefsqljcreateaggregate.dita

        There seemed to be some inconsistencies in the sections on procedureElement and functionElement concerning what was linked to or treated as a variable and what wasn't, so I am afraid I made a bunch of fixes a little far afield from this issue. I hope they are all right.

        Show
        Kim Haase added a comment - Attaching DERBY-6120 .diff, DERBY-6120 .stat, and DERBY-6120 .zip, with the following changes: A src/ref/rrefsqljexternalname.dita M src/ref/refderby.ditamap M src/ref/rrefcreatefunctionstatement.dita M src/ref/rrefcreateprocedurestatement.dita M src/ref/rrefsqljcreatetype.dita M src/ref/rrefsqljcreateaggregate.dita There seemed to be some inconsistencies in the sections on procedureElement and functionElement concerning what was linked to or treated as a variable and what wasn't, so I am afraid I made a bunch of fixes a little far afield from this issue. I hope they are all right.
        Hide
        Kim Haase added a comment -

        Thanks, Rick. I'll get to work on this.

        Show
        Kim Haase added a comment - Thanks, Rick. I'll get to work on this.
        Kim Haase made changes -
        Assignee Kim Haase [ chaase3 ]
        Hide
        Rick Hillegas added a comment -

        Hi Kim,

        Yes, that makes sense to me. Thanks.

        Show
        Rick Hillegas added a comment - Hi Kim, Yes, that makes sense to me. Thanks.
        Hide
        Kim Haase added a comment -

        Would it make sense to add a topic on the EXTERNAL NAME clause for this purpose?

        Show
        Kim Haase added a comment - Would it make sense to add a topic on the EXTERNAL NAME clause for this purpose?
        Gavin made changes -
        Field Original Value New Value
        Workflow jira [ 12772747 ] Default workflow, editable Closed status [ 12802471 ]
        Rick Hillegas created issue -

          People

          • Assignee:
            Kim Haase
            Reporter:
            Rick Hillegas
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development