Bug 113157 - API naming issues: ensure proper naming of public API
Summary: API naming issues: ensure proper naming of public API
Status: RESOLVED FIXED
Alias: None
Product: GMF-Runtime
Classification: Modeling
Component: General (show other bugs)
Version: 1.0   Edit
Hardware: PC Windows XP
: P1 enhancement
Target Milestone: 1.0   Edit
Assignee: Cherie Revells CLA
QA Contact:
URL:
Whiteboard:
Keywords: api, contributed
Depends on:
Blocks:
 
Reported: 2005-10-19 16:52 EDT by Steven R. Shaw CLA
Modified: 2010-07-19 12:29 EDT (History)
2 users (show)

See Also:


Attachments
Public API renames about to take place. (44.50 KB, text/doc)
2005-11-02 13:20 EST, Cherie Revells CLA
no flags Details
Final document describing API changes (46.00 KB, application/octet-stream)
2005-11-14 09:29 EST, Steven R. Shaw CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Steven R. Shaw CLA 2005-10-19 16:52:36 EDT
1. References to "Connector" should be "Connection" to be consistent with GEF
2. ActionBarEditPolicy --> PopupBarEditPolicy to avoid confusion with Eclipse
ActionBar terminology
3. Check for spelling mistakes - "Nesteable..." should be "Nestable"
4. Gate infrastructure should be "Border" and "Bordered"
5. ListCompartmentItem.. should simply be "ListItem" to avoid confusion with the
container "ListCompartment..."
Comment 1 Cherie Revells CLA 2005-10-19 17:25:40 EDT
- Remove Messages.java / Images.java – use ResourceManager instead.
- Remove DiagramEditPart.getScrollableControl() – doesn’t seem to be used 
anywhere.
- Move ConnectorUnmoveableEditPolicy, ShapeUnmoveableEditPolicy out of 
diagram.ui.
- Remove AddUMLActionBarTool.
- Rename the following:
Presentation*Provider		Diagram*Provider
PresentationAction		DiagramAction
AttachedShapeAction		AttachShapeAction
ShapeResizableEditPolicy	ResizableShapeEditPolicy
ShapeLabelResizableEditPolicy	ResizableShapeLabelEditPolicy
ShapeRotatableEditPolicy	RotatableShapeEditPolicy
*NonResizableEditPolicy	        NonResizable*EditPolicy
ListItemCompartmentEditPart	ListItemEditPart
Comment 2 Cherie Revells CLA 2005-10-25 12:46:19 EDT
More potential renames:
CreateOrSelectElementCommand -- PromptForElementCommand
GetConnectorTypeAndEndCommand -- PromptForConnectionAndEndCommand
PopupMenuCommand -- PromptCommand
Comment 3 Steven R. Shaw CLA 2005-10-26 15:07:00 EDT
Need to be sure to propogate these API changes into the SDK html as well...
Comment 4 Cherie Revells CLA 2005-10-27 15:55:58 EDT
Discussion on renaming of Gate*...
Suggested Names:
GateFigure	        BorderItemFigure
GateFigure.GateLocator 	BorderItemLocator
GatedFigure 	        BorderedFigure
GatedPaneFigure 	BorderedPane or BorderedFigurePane? (This is a pane 
that contains a bordered figure.)
GateEditPart 	        BorderItemEditPart
GatedShapeEditPart 	BorderedShapeEditPart
GatedCompartmentEditPart 	BorderedCompartmentEditPart
GateNonResizableEditPolicy 	This extends NonResizableEditPolicyEx, is used 
for the PRIMARY_DRAG_ROLE on gates themselves, and says "Edit policy to 
restrict gate movement along border of Gated item."  How about 
FixedBorderItemEditPolicy?
GatedShapeCompartmentDragDropEditPolicy 
	BorderedShapeCompartmentDragDropEditPolicy or 
BorderedDragDropEditPolicy to be shorter?

Comments:
- GatedShapeCompartmentDragDropEditPolicy, GatedCompartmentEditPart – Not 
needed, can be deleted.
- Re; BorderedPane vs BorderedFigurePane:  Depends on which one is more 
consistent with other namings... 
- The FixedDistanceGatedXXXX stuff could also be renamed/removed.   It was 
intended as an intermediate fix that seemed to stay around ;-)  This class is 
internal so I will leave this for later.
- The new names seem very reasonable.  The only suggestion I would have would 
be for the GateNonResizableEditPolicy.  I would suggest not using the 
term 'Fixed' since the border items are not fixed but 'restricted'.

Updated Suggested Names:
GateFigure	        BorderItemFigure
GateFigure.GateLocator 	BorderItemLocator
GatedFigure 	        BorderedFigure
GatedPaneFigure 	BorderedPane
GateEditPart 	        BorderItemEditPart
GatedShapeEditPart 	BorderedShapeEditPart
GatedCompartmentEditPart 	To be deleted
GateNonResizableEditPolicy 	BorderItemSelectionEditPolicy
GatedShapeCompartmentDragDropEditPolicy 	To be deleted
Comment 5 Cherie Revells CLA 2005-10-28 11:49:15 EDT
I got clarification over what some of these gate figures are used for.  I have 
made the following changes:
GatedFigure 		        BorderItemContainerFigure
GatedPaneFigure 		BorderedFigure
Comment 6 Steven R. Shaw CLA 2005-10-28 15:42:03 EDT
- PresentationPrintGlobalActionHandlerProvider should be public and renamed to 
DiagramPrintGlobalActionHandlerProvider.
- PresentationRenderedPrintGlobalActionHandler should have a corresponding 
Provider class. Can probably eliminate the word "Rendered" from these...
Comment 7 Cherie Revells CLA 2005-11-02 13:20:44 EST
Created attachment 29196 [details]
Public API renames about to take place.
Comment 8 Steven R. Shaw CLA 2005-11-14 09:29:02 EST
Created attachment 29864 [details]
Final document describing API changes

API changes
Comment 9 Cherie Revells CLA 2005-11-14 14:08:19 EST
This has been completed; howeer, the deprecated API is still available.
Comment 10 Cherie Revells CLA 2005-11-25 14:58:09 EST
Purpose: 
Removing deprecated classes after renaming activity .
Activities: 
Bugzilla#113157 gmf_head cmahoney 051125 Removing deprecated classes 

Code Reviewed by: 
Steve 

How tested: 
- Verified there were no compile errrors. 

Launching org.eclipse.gmf.tests.runtime.diagram.ui 
OK, Runs:        69, Fails:        0, Errors:        0, org.eclipse.gmf.tests.runtime.diagram.ui, Time:        94.266 

Launching org.eclipse.gmf.tests.runtime.draw2d.ui 
OK, Runs:        35, Fails:        0, Errors:        0, org.eclipse.gmf.tests.runtime.draw2d.ui, Time:        0.312 

Launching org.eclipse.gmf.tests.runtime.draw2d.ui.render 
OK, Runs:        3, Fails:        0, Errors:        0, org.eclipse.gmf.tests.runtime.draw2d.ui.render, Time:        5.344 
Comment 11 Richard Gronback CLA 2008-08-13 13:06:03 EDT
[target cleanup] 1.0 M3 was the original target milestone for this bug
Comment 12 Eclipse Webmaster CLA 2010-07-19 12:29:30 EDT
[GMF Restructure] Bug 319140 : product GMF and component
Runtime Diagram was the original product and component for this bug