Naming Conventions - programmer refuses to stick to them... what to do?

A fellow programmer on my team, though good, often refuses to abide by naming conventions, or seem even to be aware that many have existed and use that knowledge accordingly.
Today, for example, he created a class (not an interface) called Createable. I pointed out to him that convention over the years has been that classes ending in '-able' were usually interfaces, or might be suspected to BE interfaces by other programmers looking at his code.
He said he didn't care.
I then later noticed he had an interface defined in another package called 'Createable'. So he had made two classes of the same name in different packages, one an interface and one not.
Our boss doesn't seem to mind this kind of thing (he just wants us to get the work done and isn't interested in quibbling over things like naming convensions). Perhaps I'm a bit stern about these kinds of things, but it really gets my goat when this happens.
What's your opinion, Java Community?
- Tim
Edited by: user2052552 on Feb 3, 2011 12:41 PM

user2052552 wrote:
A fellow programmer on my team, though good, often refuses to abide by naming conventions, or seem even to be aware that many have existed and use that knowledge accordingly.
Many conventions? As in your team doesn't have a convention but you want them to follow one which is unspecified?
Today, for example, he created a class (not an interface) called Createable. I pointed out to him that convention over the years has been that classes ending in '-able' were usually interfaces, or might be suspected to BE interfaces by other programmers looking at his code.
English is a limited language.
Is 'Manager' suitable for the name of a class or an interface?
If only the latter then what do I call a class that represents something that "manages"?
He said he didn't care.
I then later noticed he had an interface defined in another package called 'Createable'. So he had made two classes of the same name in different packages, one an interface and one not.
Our boss doesn't seem to mind this kind of thing (he just wants us to get the work done and isn't interested in quibbling over things like naming convensions). Perhaps I'm a bit stern about these kinds of things, but it really gets my goat when this happens.
What's your opinion, Java Community?First it is a management problem.
Second there are proven techniques for producing better code. Coding conventions are not one of those.
Third if an organization is such that it is using other proven techniques, then coding conventions might have some measurable impact on quality, but lacking other techniques (or lacking all techniques) there can be no measurable impact as it would be less than the noise level caused by other correctable items.
Fourth as a point about what measurable techniques are the classes that the developer is creating actually Objects (Object Oriented Objects)? Versus random collections of functionality for example? The latter would be a far more serious problem than naming. And does that developer, and all of the other developers, use inheritence appropriately? Again misuse there would be a far more serious problem.

Similar Messages

Naming convention of calculated keyfigure

Hi Experts,
This is the first time we are creating any calculated keyfigure in our system and while creating we are getting authorization error. When we contacted our basis friends they told that its a naming convention issue. I want to know what would be the naming convention of a calculated key figure in our system. Can you please help me how to find this naming convention?
Thanks in advance for your help.
Regards,
Brahma Reddy

"You do not have authorization to add or create".
This message purely indicates it is authorization issue. Work with your Basis guys to get the required access.
May be some of the roles are not assigned to your user id. or
In which system you are making changes, if it is prodcution try not to make any changes and make changes in dev system and move to production system.
Hope this helps.
Regards,
Reddy

Is there naming conventions for variables, itabs?

Hi!
Is there an ad hoc naming convention standard for writing ABAP programs?
What prefixes, suffixes, etc. I should use when defining selection options, variables, internal tables, etc.
Thank you!

Hi,
We have to follow the naming conventions according to the client's coding standards.
For example
My present client.
I am following the conventions as follows:
Variables: v_variablename,
Constants: c_contant,
Select-options: S_selopt,
Internal tables: T_
Work Areas: K_
Etc.
Reward me if it is useful.

Naming convention in template css file

Is there a specific reason for having the theme "name" hardcoded in many css definitions ?
For example consider the css for the rows in a report:
In the css files for each theme it is defined in a different way:
Theme1: td.t1data
Theme2: td.t2data
Theme3: td.t3data
...Overriding these values and manipulating the styles using Javascript gets a bit cumbersome if it should work across themes.
Are there any naming conflicts or is it just for historic reasons that don't apply anymore in the 2.0 release?
In other words, would it be safe to use just td.data in new templates or will I run into problems doing this?
Thanks,
~Dietmar.

Hi Carl,
thanks for the clarification. I had figured that you had a good reason to do so.
It's a tradeoff, either approach has pros and cons.
Most likely we will stick with that type of naming convention, but we'll look into it again.I would like to throw in an idea. You can add multiple css classes to an html tag, e.g.
<td class="t12data data">The css for the class data would be empty.
This way we could have both, different class names for different themes, but also having the elements "tagged" the same way so that the javascript should work.
Haven't thought it out, it just came to my mind. You might consider it.
And yes using td.data should be just fineI guess I will go down that route.
I will create only a single theme and then use multiple css style sheets to modify the look and feel.
This way I can switch the theme on the fly by switching style sheets only.
Javascript modifications will work since the css class names are the same.
All customized region templates will only have to be created once (and not for all themes).
Thanks and a Happy New Year,
~Dietmar.

Private vs. protected, naming conventions etc.

I've been grappling with a couple of frustrations with Forte, and I'm
interested in feedback from others on this list regarding approaches
they may have adopted to address these.
One is that in the Forte workshops there is no way to view only the
public methods and attributes of a class (we're still using V2 here; I'm
assuming that V3 has not changed this). While referring to appropriate
technical documentation for a class is obviously important, I still find
myself opening up classes in the workshops to inspect the methods and
attributes available. (What I really want to see is an integrated class
browser. I sure hope Forte is working on something like this, or will
open up their development environment to support third-party extensions.
But that's an aside.)
A convention I just recently adopted in my work is to name private
methods and attributes with a beginning underscore ("_"). That way the
private elements are sorted to the top of the list and can be easily
differentiated from public elements. I'm curious, though, whether others
have adopted similar or different approaches.
I've also felt a bit frustrated over the lack of support for protected
attributes/methods for TOOL classes. This strikes me as a rather
bothersome shortcoming. The only approach I can think of is to make such
elements public, but adopt the same or similar naming conventions as a
strong hint to developers to avoid using these in clients of these
classes. Again, I'd be very interested in hearing how others have dealt
with this issue.
Thanks.
Michael Brennan
Programmer/Analyst
Amgen Inc.

I sent this once before, but the list seemed to be having trouble late last
week. If you get two copies of it... my apologies.
OK, I couldn't resist joining the fray...
At 10:56 AM 11/6/97 -0800, Michael Brennan wrote:
>
A convention I just recently adopted in my work is to name private
methods and attributes with a beginning underscore ("_"). That way the
private elements are sorted to the top of the list and can be easily
differentiated from public elements. I'm curious, though, whether others
have adopted similar or different approaches.You might even designate a single character before the underscore to denote
that, just in case some environment (CORBA) doesn't like the "_". You could
make it something like "Q" or "Z" or something that wouldn't normally be
used alone at the start of a name.
>
I've also felt a bit frustrated over the lack of support for protected
attributes/methods for TOOL classes. This strikes me as a rather
bothersome shortcoming. The only approach I can think of is to make such
elements public, but adopt the same or similar naming conventions as a
strong hint to developers to avoid using these in clients of these
classes. I share your desire for protected methods, but I have to disagree about
protected attributes. Philosophically speaking, protected and public
attributes are EVIL!! (I say "philosophically speaking" because, in the
Forte environment, there are some valid reasons for using them based upon
the visibility constraints of the language. In other languages, C++ and
Java, for example, it's not even philosophically speaking - they're just
evil!!)
One of the principal reasons for adopting the object paradigm is to
tightly control the impact of change - to provide good boundaries of
encapsulation that change does not ripple beyond. If you think about it,
one of the measures of the success of a superclass is the number of
subclasses that it has (especially for a good dabstract interface). This
says you have very nicely captured the semantics of the application domain
in the interface of the superclass. So, let's imagine a superclass with
protected attributes that are used by each of its 100 subclasses (probably
more than you would have, but I'm illustrating my point - incidentally, I'm
not talking about a hierarchy 100 deep; I'm talking about 100 subclasses
that are all direct decendants of the superclass). Now you go and change
one of the attributes. You must go look at all 100 subclasses to determine
the impact of change. This is exactly the kind of thing the object paradigm
was designed to eliminate.
Protected methods, on the other hand, would be nice.
And At 12:06 PM 11/6/97 -0800, Mark S. Potts wrote:
>
Forte inherits in a strange way when attributes are private. A
superclass attribute that is made private is not accessible from any of
its subclasses - this means that many of what you would consider private
attributes in fact have to be public. Well, the definition of private means "not visible outside of the class
where it is defined". I find it useful to think of the level of visibility
the same as secrets. There are things that are not really secrets at all -
it's ok if anyone knows them ("My name is Stephen"). These are public.
Then, there are things that it's ok if my family knows, but I don't want
the world to know - familial secrets, if you will ("I belch at the dinner
table when I'm at home"). These are visible to descendant classes and we
call them protected. Finally, there are things we don't want anyone else
to know, no matter who they are ("I poisoned my mother-in-law"). These are
private. We don't want anyone outside of ourselves to know these things.
These are the classic definitions of public, protected and private (perhaps
classic only because C++ defined them that way and everyone else just
copied what it meant).
Private attributes are not meant to be inherited by their subclasses.
That's why they're private. And, yes, I would argue that that is completely
correct. What you want, if you want them to be visible to subclasses, is
"protected". Now, Forte doesn't support protected, but that's a different
arguement - perhaps even an enhancement request.
We also should not confuse what we need to do in a language/environment
with what good OO principles are. For example, good OO design principles
state that you do not have public or protected attributes. Period! You
access them via accessors and mutators defined on the appropriate class.
Now, in some environments, this will not give you the performance you need,
so you open things up a bit. But, you shouldn't convince yourself that
doing this is the ideal design, just that it was necessary for performance.
The real problem here is that the performance of accessor and mutator
functions is not fast enough. That's why we open it up. Not because it is
good design. The proper way to fix the problem is to make accessors and
mutators fast enough so that they can be used (C++, for example, does this
with "inline" - not that C++ is my favorite language, it's not. But they
have fixed this one area nicely.)
Some would argue that this is correct and that inheritance does break thepure rules
of encapsulation I don't think inheritance, properly handled (and Forte does properly
handle it) breaks any rules of encapsulation. I would argure that the way
they treat private attributes is quite correct.
- but these people dont build applications!Hmmm... let's see... started building OO applications in 1985 (and building
them ever since) in complex application domains like CAD/CAM/CAE, Air
Traffic Control, Graphics/Imaging, Telecommunications, e-commerce,
entertainment,... ...wrote (and teach) the Forte OO Analysis and Design
course.
I guess you're right. I don't build applications. I build robust,
maintainable, extendable applications. ( ;-) ...nudge, nudge!)
Stephen

Storage Location Naming Convention without WM!

Dear all
We are facing serious problem in our Storage Location for Raw Material.
We have 4 types of Raw Material Seating (S), Panel (P), Metal (M), Wood (W). And they are all stored under Storage Location: RWSL.
Requirement:
Although we have visual guideline as to which industrial rack will store the type of Material, it is insufficient. We need a more refined storage location down to which BIN of the rack we will put the Raw Material.
Due to limited time and resource, we cannot have WM implemented right now. Thus, we have come out with 2 alternative to overcome this problem:
Alternative 01:
We will use the Fixed Bin field in Storage Data 02 by putting the Bin number assigned to each Rack.
E.g. For Seating material code:SEAT01, we will maintain the Fixed Bin as R12A01/A02, it means this Seating material SEAT01 will be stored at Rack 12, fixed bin A01 or A02.
Question to Alternative 01: Will it cause problem in GR, GR, Transfer Posting and Stock Count?
Alternative 02:
Instead of going into details to put Fixed Bin field in Storage Data 2, we will abandan the existing Storage Location RMSL by introducing new format for Storage Location
Here is the example of Alternative 02:
For raw materials, we will use 4 digits location numbers, consistent with other Storage locations, the 4 digits storage location will start with u201CR _ _ _u201D to represent each location
And,
R _ _ _ is:
R = Raw materials
2nd digit = Division (S= Seating, P =Panel, W=Wood, M=Metal and W=Wood)
3rd digit = Rack Number (A, B, C, Du2026 and etc.)
4th digit = Rack Zone - each rack will broken down into zone, each rack can possibility have 2 to 3 zone. 1 Zone can be 1 colume of the Rack
An example of a possible location and its meaning will be
RSA1 = Raw materials warehouse, Seating division, Rack A, Zone 1
RPB3 = Raw materials warehouse, Panel Division, Rack B, Zone 3
The challenge of this is that instead of having 1 Raw Material Storage Location like RMSL, we will have a lot more storage locations each for division of Raw material due to the Rack Number we have as well as the Rack Zone.
Question to Alternative 02:
If we use this alternative, will it impact our future implementation of WM? From design wise, is it feasible?
Please advise what is the best approach and the feasible design on it.
Many thanks in advance.
Edited by: Daimos on May 13, 2009 10:15 AM

Hi, here is the Pro and Co of both approaches:
Method 01: Use existing SLOC and add the Storage Bin info
e.g. SLOC: STM1
         Storage Bin: RSC3, where RS = Rack Seating, C3 = column 3
Pro 01:
It will cause less effort as we only need to use LSMW for material master to add in the Storage Bin data for all material of SCM.
Pro 02:
I have tested out that in TCode MIGO, apart from SLOC, the pertaining Storage Bin data also appear. Based on my discuss with Xian Chen, sometimes they use MB1C(GR), MB1A(GI) rather than MIGO due to speed issue, I will need to check the field status if can have Storage Bin field APPEAR, if can, it will solve the problem
Con 01:
The Storage Bin information will only appear in MMBE (Stock Overview) but will not appear in the standard SAP Inventory Report (e.g. MB52 Warehouse Stock). To view it from SAP Inventory Report, we may need to customize the standard report to show the new field Storage Bin. It needs Abap effort.
Con 02:
We must have a very good naming convention for Storage Bin. And again, in the above example, if a material is put in SLOC STM1 at Storage Bin RA A1 or C4, it will set a very rigid rule in the future if we need to change it, as I fear that one the Storage Bin has been used up. It will not allow us to change (need to do testing to find out)
Con 03:
Do we have the time to define all the Storage Bin for each SLOC? Operation wise, the store personnel needs to design it
Method 02: Use the new SLOC
Pro 01:
RSA1 = Raw materials warehouse, Seating division, Rack A, Zone 1. More organized. Easy to tell the material is at which Rack and which Zone of the Rack.
Assumption:
01. we must not have too many rack for one Seating division and also not too many Zone for each
      Division, else it will cause confusion
02. 1 material should stick to 1 Rack 1 zone as much as possible, else later the PP consultant will
     have hard to to perform GI due to too many SLOC assigned to a material.
Pro 02:
In report wise, we are able to show the SLOC in inventory report. No need to enhance the existing inventory report as we do not use Storage Bin.
Con 01:
If there are too many SLOC creation due to it. It may cause problem for PP perform GI as too many selection available for a material. This can be avoided if stick to the General Rule that one material is tied with one SLOC.
Edited by: Daimos on May 16, 2009 5:07 AM

Is it possible to control the naming convention used by Aperture when importing photos? If so, how

When I import photos from my camera, I have them placed into projects based on the date the photos were taken. However, I do not like the naming convention used by Aperture as it causes the projects to sort into a non-chronologial order. The convention is MMM-DD-YYYY and I want to change it to YYYY-MM-DD. Is it possible in Aperture 3.2.4 to do this?

In the Import panel you can edit the preset for the file name format to "Image year - image month - image day - index" for example; the preset for folder names seems to be gone in Aperture 3,3 - at least I cannot find it any longer. You only seem to be able to enter the folder name manually in the Import panel.

Naming conventions to store automation testing scripts

Hi,
Can anyone provide the solution for Naming conventions to store automation testing scripts in oracle application testing suite?
Regards,
Sairam

Hi Sairam
There are no naming conventions you can call them anything you like.
Regards
Alex

Data Modeler - Naming Conventions

I was using Oracle Designer for several year.
This product could drive you crazy because sometimes, but the strength was in my opinion the datamodelling part.
It saved you a lot of time because you kept stuck to the logical model generated your relational model and had all scripts satisfying all naming conventions you needed.
In Data Modeler i really miss the naming conventions and can't understand some parts, sometimes somebody here can help me if i have overseen something or it is just not implemented.
Naming conventions as example:
We work with surrogate keys.
Two well known tables - Employees (abbreviation EMP), Departments (abbreviation DEP)
They have one relation 1:N one department has many employees
In Designer i would define the EMPLOYEE entity, would set the table-abbreviation, the attributes and the primary key.
The same with DEPARTMENT. I would design it WITHOUT any column for the foreign key constraint.
Then i would create a relation between this two tables.
Last step is to generate the relational model.
a) Designer automatically adds ID as surrogate key on every table (you could configure that, it was dependent on a domain)
b) it automatically adds the table abbreviation as prefix on every column (even here it's configurable)
c) it automatically adds the a foreign key column in the child table with the prefix of the master table (f.e. EMP_DEP_ID or DEP_ID if you prefer not to prefix every column... what i do)
It was really easy to get your scripts.
Things i don't understand in Data Modeler:
In a logical model you should design entities, attributes and relations and don't mess around with FK-columns.
Is there any support for surrogate keys? I don't wanna add an ID manually with every table.
In Data Modeler an additional COLUMN(!) is added with every Foreign key relation, i could live with that, but there is no way to tell
Data Modeler to prefix it automatically. The name can just be changed in the Relational View afterward.
P.S.
Surrogate Keys.... There are some pros and cons for/against this out there. I have seen a lot of Oracle Projects and in all except one i always had a surrogate key column. It really makes life
easier. In the one no-surrogate-key-project we began to add surrogate keys after a while...

COLUMN(!) is added with every Foreign key relation, i could live with that, but there is no way to tell
Data Modeler to prefix it automaticallyLook at "General options>Naming Standard>templates" - you can define template for FK columns/attributes and then apply them for whole relational/logical model using "Apply Naming .." functionality from pop-up menu in the browser. For Logical model (FK attributes) - you also need to clear related setting at "General options>Logical>Keep as the name of originating attribute".
Templates are also used when objects are created, thus when new FK is created, then templates are used to generate name for foreign key and FK columns. Well you have to define table and column abbreviation in order to get them used in generated names - Re: Data Modeler: Naming
There is no support for surrogate keys in current release.
Philip

Question about CEP Naming Conventions and or Standards

Hello,
CEP is new to the organization that I am working with. I have been asked to draft a few standards around CEP to help promote standardization and proper reuse of CEP artifacts. Can anyone share with me examples of CEP artifacts with a naming convention or their experiences with naming conventions around CEP in general. This is a living standards document for us. We plan on using CEP heavily going forward. Your experiences will help us start off on the right foot.
Thanks in advance,
JJE
Spelling Edited by: JJ.Everett on Sep 7, 2010 11:16 PM

Hi,
Oracle CEP supports reuse of components in several ways. For example, you can design your application as a set of modules that can be deployed independently (different teams can develop each module). Modules can register services, such as an event source or event consumer, and these services can be used by other modules. So, it's possible to plug modules developed by different teams of developers together and reuse them in different applications or environments. A component instance registers itself as a service when its advertise attribute is set to true in the Spring application context that defines a module.
A component implementation can also register a factory as a service that allows instances of the component to be created by other modules. Section 13.1.5 in the CEP Developer Guide describes this. http://download.oracle.com/docs/cd/E14571_01/doc.1111/e14301/adapters.htm#CIHBHEDA
Hope that helps.
Regards,
Seth

Preferred package naming conventions for plug-ins?

Every combination seems to be in use already...
VIM plug-ins are vim-plugin_name
XFCE plug-ins are xfce4-plugin_name-plugin
GIMP plug-ins are (mostly) gimp-plugin-plugin_name
I plan on making some plug-in packages for a application what dose not currently have any available. So as the topic says what's preferred package naming convention? I personally like the GIMP format best but just figured I'd ask first (should really be in the guidelines IMO).

Ok well I guess I'll use the third option for now them.
While we're talking about naming conventions I was just searching for the python cairo library noticed binding library's could do with some guidance to...
cairo-perl
pycairo
ruby-rcairo
IMO language-library_name would be a nice guideline.

Logical System Naming Convention

Hi Guruz,
Is it mandatory to name your logical system starting with SAP system name. I went through SAP Documentation for creating logical system, it says <sap system name>CLNT<client number>. I didn't put my SAP system name for the first part<sap system name> instead some random letters. I know this question may sound stupid but I am right now in the middle of the integration so, I don't want to change it. Please confirm.

I'm work for the customer who has ~4000 logical systems defined (not all represent SAP boxes though). Which I find quite a lot, yet given the rules of naming convention helps a lot.
I would say that having the system name should be used whenever we talk about Logical Systems representing SAP boxes. But in case of external non-SAP applications, it is helpful to represent them by the external system.
Say, you have 20 SAP installations, each sending interface to application A. Then it is easier to monitor in XI/PI interfaces for single receiving logical system 'A'. But if you want to find out messages from given sending SAP system, then using SAP system name is recommended to extract such data quickly.
Regards,
Dominik Modrzejewski

Best practices in Internal table naming convention GT , GS , LT , LS ??

Hi Gurus,
 Are GT_ , GS_ , LT_ , LS_ --- the Best practices in Internal table naming convention ????
 I have seen this naming convetions adhered in standard programs .
 What each one of the below signify
 GT_ , GS_ , LT_ , LS_ ???????
Regards
Jaman
Message was edited by:
 ABAP Techie

Hello
I use the following naming conventions:
- G = global variable
- L = local variable
- T = internal table
- S = structure
- D = field
That's how the combinations look like:
- GT_ITAB = global itab
- GS_STRUC = global structure
- GD_FIELD = global field
- LT_ITAB = local itab
- LS_STRUC = local structure
- LD_FIELD = local field
Function module parameters have to stick to the following rules:
- I = importing
- E = exporting
- [C = changing -> never used]
- IT_ITAB = imported table type (itab)
- IS_STRUC = imported structure
- ID_FIELD = imported field
- ET_ITAB = exported table type (itab)
- ES_STRUC = exported structure
- ED_FIELD = exported field
Depending on their semantics TABLES parameters look like:
- IT_ITAB = imported data
- ET_ITAB = exported data
- XT_ITAB = changing data (import & export)
Here are the conventions for FORM routine parameters:
- UT_ITAB = using itab (data are usually treated like constants; no changes will be transfer - although possible - to the calling program)
- CT_ITAB = changing itab (if it is semantically an exporting itab then one of the very
first statements in the routine is: REFRESH ct_itab. )
- US_STRUCT
- UD_FIELD
- CS_STRUCT
- CS_FIELD
Conventions for class/interface parameters:
- IT_ITAB = importing table type
- IS_STRUC = importing structure
- ID_FIELD = importing field
- ET_ITAB = exporting table type
- ES_STRUC = exporting structure
- ED_FIELD = exporting field
- RT_ITAB = returning table type
- RS_STRUC = returning structure
- RD_FIELD = returning field
Conventions for class/interface attributes:
- MT_ITAB = table type
- MS_STRUC = structure
- MD_FIELD = field
- MC_CONST = constant
Question: Are there any advantages of such elaborated naming conventions?
My answer to this question is: Yes, definitively.
I believe that the advantage of semantically differentiating TABLES parameters of function modules is quite obvious:
CALL FUNCTION 'Z_BAD_NAMING'
 TABLES
 itab1 = ...
 itab2 = ...
 itab3 = ... .
CALL FUNCTION 'Z_GOOD_NAMING'
 TABLES
 it_itab1 = ...
 et_itab2 = ...
 xt_itab3 = ... .
I also believe that my naming conventions clearly enhance readability and maintainability of my programs.
Regards
Uwe

SAP Naming Conventions for DB Data Files

Hi Everyone!
We are about to install a SAP ECC 6.0 SR3 ABAP on Windows Server 2008 (R2) & SQL Server 2008 SP1 and we want to name the DB data files as follows:
<sid>DB_Data_001.MDF/NDF
Do you see any problem with this or think this could lead to a problem in the future?
We were unable to find a SAP note or SAP recommendation about this, we only found SAP Note 27428 but itu2019s for Oracle.
Thanks in advance!
Best Regards,
Nicolas

Hi Nicolas,
I thought about all corners where this could possibly lead to a problem (e.g. monitoring, DB13, ...) but couldn't think of a single report or transaction where this would cause problems.
To the database itself the names of the files do not matter at all and in the SAP transactions the datafiles are only read to display them in monitoring transactions like DB02 or RZ20. These transaction do not expect a certain naming convention so I don't see anything that would count against using different filenames.
Regards,
Beate Grötschnig

ADF BC naming convention suggestions

Ok, I havent found too many topics on this matter, but here is a list of naming conventions our team is debating over. I would also like to hear the rest of the community's thoughts.
Entity: Use underlying table's name and postfix with Eo. If the table is a W view, it should prefix with W.
eg. EmployeeEo, WEmployeeEo
View Object (Single entity based): Use the Entity's name postfix with Vo.
eg. EmployeeVo, WEmployeeVo
View Object (Multiple entity based): Use the primary entity's name followed by a "busniess task" name.
eg. DepartmentEmployeeSearchVo (employee search being the task).
View Object (Non-entity based): Use the primary query table name followed by a "busniess task" name.
eg.EmployeeCountVo
View Link & Association: Combine the master entity name and child entity name postfix with Vl/Ao.
eg. DepartmentEmployeeVl, DepartmentEmployeeAo
(The issue with this is our legacy tables are not that intuitivly named, so its hard to distinguish the master/child tables. I was thinking of splitting it with lets say 2, like Department2EmployeeVl)
Application Module: Apply a "busniess process" name and suffix with AppModule.
eg. AcmeAccountingAppModule.
If anyone has any suggestions or see any conventions left out please post them.
Thanks,
Z

Without discounting your object name conventions, don't forget the Java package they are placed in helps gives context for the object. This is what I tend to do:
com.acme.appmodules
com.acme.entities (all entities)
com.acme.entities.associations
com.acme.views (common VOs)
com.acme.views.links (common VO links)
com.acme.views.reference (common read only VO lookups)
com.acme.views.<business task> (to group logical business VOs together)
com.acme.views.<business task>.links
...the last 2 are repeated for each business task area (eg. HR, accounts, etc)
My ideas partially based on the SRDemo from the JDev team.
Hope this helps.
CM.

Naming Conventions - programmer refuses to stick to them... what to do?

Similar Messages

Maybe you are looking for