Mailing-List: contact ojb-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "OJB Developers List" <ojb-dev@db.apache.org>
Received-SPF: neutral (hermes.apache.org: local policy)
Mime-Version: 1.0 (Apple Message framework v619.2)
In-Reply-To: <224f3234050424060970a65b9e@mail.gmail.com>
References: <224f3234050424060970a65b9e@mail.gmail.com>
Content-Type: text/plain; charset=US-ASCII; format=flowed
Message-Id: <5106fe01a66d1391f84c72e0066f9270@apache.org>
Content-Transfer-Encoding: 7bit
From: Brian McCallister <brianm@apache.org>
Subject: Re: [vote] Naming standard
Date: Sun, 24 Apr 2005 21:08:38 -0400
To: "OJB Developers List" <ojb-dev@db.apache.org>


On Apr 24, 2005, at 9:09 AM, Thomas Dudziak wrote:

> Following our discussion, I thought it useful to vote about a naming
> standard and - if successful - apply it prior to releasing the first
> version of the 1.1 branch.
>
> In the discussion the following scheme has emerged so I hereby propose 
> it:
>
> * Interfaces for extension points have plain names, e.g. QueryFactory,
> PersistenceBroker etc.
>
> [X ] +1
> [ ] +/- 0
> [ ] -1
>
> * The class names of Implementations of such interfaces end in "Impl".
>
> [ ] +1
> [ ] +/- 0
> [X ] -1

Use a descriptive name instead.

>
> * Abstract base classes of such implementations have their name ending
> in "AbstractImpl"
>
> [ ] +1
> [ ] +/- 0
> [X ] -1

Would prefer BaseFoo or, even better a descriptive name, to 
FooAbstractImpl.

>
> * If OJB ships with one concrete implementation, and the interface is
> meant to be an extension point for users for their own implementations
> (e.g. ProxyFactory), then the implementation class name ends in
> "DefaultImpl".
>
> [ ] +1
> [ ] +/- 0
> [X ] -1

DefaultProxyFactory is way better than ProxyFactoryDefaultImpl

>
> * Static factory classes will be removed. To my knowledge there are
> only two such classes in the 1.1 branch: QueryFactory and
> PersistenceBrokerFactory. The former is not really necessary because
> the methods only wrap around a constructor class. The latter mainly
> wraps around methods in the OJB class. The most interesting methods
> (defaultPersistenceBroker, createPersistenceBroker, etc.) should be
> moved to the OJB class.
>
> [ ] +1
> [X ] +/- 0
> [ ] -1

The QueryFactory will throw people. It is useful.

>
> * Abbreviations where the unabbreviated name is used in OJB, are
> replaced with the unabbreviated name. E.g. PersistenceConfigurationKey
> instead of PCKey.
>
> [X ] +1
> [ ] +/- 0
> [ ] -1
>
> regards,
> Tom
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
> For additional commands, e-mail: ojb-dev-help@db.apache.org
>
>


---------------------------------------------------------------------
To unsubscribe, e-mail: ojb-dev-unsubscribe@db.apache.org
For additional commands, e-mail: ojb-dev-help@db.apache.org