Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 362437 - Change function names to conform to an EGL naming convention ("is...")
Summary: Change function names to conform to an EGL naming convention ("is...")
Status: CLOSED WONTFIX
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: EDT (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-10-30 15:47 EDT by Ben Margolis CLA
Modified: 2017-02-23 14:16 EST (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ben Margolis CLA 2011-10-30 15:47:01 EDT
By EGL convention, a function name begins with "is" if the function returns a Boolean to indicate a status.  However, eglx.persistence.sql.SQLResultSet uses the Java names for rowDeleted and rowUpdated.

For clarity and consistency, please change the EGL names to isRowDeleted and isRowUpdated.
Comment 1 Tony Chen CLA 2011-10-30 22:55:10 EDT
This is SQL language support, I changed the components to Language and subscribed Joe.
Comment 2 Brian Svihovec CLA 2011-11-01 14:20:27 EDT
If this is our intended convention in EGL, then I agree with this change, but how many other functions should have 'is' in front of them and do not follow this convention?
Comment 3 Ben Margolis CLA 2011-11-02 12:59:05 EDT
(In reply to comment #2)
> If this is our intended convention in EGL, then I agree with this change, but
> how many other functions should have 'is' in front of them and do not follow
> this convention?

Booleans often begin with a verb: 

   eglx.lang.Stereotypes, 
   eglx.lang.String, 
   eglx.persistence.ScrollableDataSource, 
   eglx.persistence.sql.Column, 
   eglx.persistence.sql.SQLDataSource, 
   eglx.ui.rui.ExternalTypes
   org.eclipse.edt.eunit.runtime.LogResult

but not always:

   eglx.persistence.sql.JoinColumn
   eglx.services.OneWay 
   eglx.xml.binding.annotation.XMLArray   
   eglx.xml.binding.annotation.XMLAttribute
   eglx.xml.binding.annotation.XMLElement
   eglx.xml.binding.annotation.XMLArrayXMLRootElement
   eglx.ui.rui.ExternalTypes (in both lists)

The names of rowDeleted and rowUpdated seem particularly unclear, although the original assertion about "is" as a universal is not correct.
Comment 4 Brian Svihovec CLA 2011-11-03 15:56:36 EDT
I talked with Tim about this, and he claims the 'rowDeleted' and 'rowUpdated' methods are defined in a well known standard and should be left this way.
Comment 5 Ben Margolis CLA 2011-11-10 15:26:17 EST
closed