ADF Naming and Project Layout Guidelines v2.00

81 views
Skip to first unread message

Aino

unread,
Apr 24, 2013, 6:06:31 PM4/24/13
to ADF Enterprise Methodology Group
Hi all,

I'd like to thank Chris for the documents on ADF coding guidelines and naming and project structure guidelines. I think they are great and we're happy to use them at our projects and not 'invent' and write them down every time we'll start a new project.
On the one hand I don't mind that much what the actual standards are but I think it's important on a project that everybody applies the same ones. Having them provided by Oracle are a great help, especially because we can now prevent endless project discussions on this subject. I also realize that standards are a general agreement that apply to most situations and that there are always exceptions.

That said, there are a few naming guidelines that I'd like to discuss and hear your opinion about.  
  1. The guidelines advise to organize the BC's by type use plural for that, e.g. .entities or .views etc. But I prefer a singular name because from the object's point of view it's one entity and not more. ( [ADFng1-03006] - [ADFng1-03016] )
  2. We're used and advised to organize the BC's by type. That means that you always have to navigate multiple packages for the related objects, like the entity and view. Wouldn't it be a good idea to organize them more functionally and put them together in a logically named package?
  3. The advise is to use a suffix for the ViewObjects, ViewLinks, Associations, ViewCriteria etc. but not for the entities (ADFng1-04004). In my opinion this is a bit inconsistent. I think that a suffix it makes the entity better identifiable when used with other BC's, e.g. with an entity based ViewObject and that it allows the use of a logical / not suffixed (and not numerical suffixed) name for accessors or other uses instead of using the 'main' name to access the entity. 
  4. I suggest to start a bindparameter with a capital B instead of a p (ADFng1-04022). Although the bind parameter looks better with a p inn the declarative editor, the getters and setters look horrible and also because attributes are also capitalized. And even the usage of this B prefix (hungarian notation) is still under my own discussion ;-). By the way, the preferences for packages and suffixes work great and create the rightly named objects. 
  5. I always apply the convention that View Object instance names must be logical names, often the view's name, but don't include the ViewObject's suffix 'view' (as is advised). I agree that the numerical suffixes must be removed immediately. (ADFng1-04001). This means that normally my entity and viewobject have the same 'base' name with different suffixes and that they are normally the same as the database table or view and that the logical 'translation' is done the View Object instance as that's the interface to the UI.

I'm looking forward to your opinion.

Regards

  Aino

Chris Muir

unread,
Apr 24, 2013, 6:21:53 PM4/24/13
to adf-met...@googlegroups.com, ADF Enterprise Methodology Group
Hi Aino

Thanks for the feedback. However as the document requests please take these issues to the ADF EMG issue tracker, so we don't bombard the main mailing lists with discussions on each individual point.

Thanks,

CM.

--
--
You received this message because you are subscribed to the ADF Enterprise Methodology Group (http://groups.google.com/group/adf-methodology). To unsubscribe send email to adf-methodolo...@googlegroups.com
 
All content to the ADF EMG lies under the Creative Commons Attribution 3.0 Unported License (http://creativecommons.org/licenses/by/3.0/). Any content sourced must be attributed back to the ADF EMG with a link to the Google Group (http://groups.google.com/group/adf-methodology).
 
---
You received this message because you are subscribed to the Google Groups "ADF Enterprise Methodology Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to adf-methodolo...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 
Reply all
Reply to author
Forward
0 new messages