Err, Oliver, I think we all agree with your comments, but they're
kind of out-of-scope with the subject at hand ;)
g
On Jun 15, 2007, at 14:38 , Oliver Lietz wrote:
Am Mittwoch, 13. Juni 2007 schrieb Grégory Joseph:
Hi guys,
some comments inline...
On Jun 13, 2007, at 16:09 , Philipp Bracher wrote:
Reverting API changes:
- we should keep the new interfaces HierarchyManager, Content,
NodeData in there original core package
- keeping them in the same package would facilitate updating a lot
- since we plan other changes in the api we should not make an
extra tour for three classes now!
As some of you have noticed, we extracted the interface of the
HierarchyManager class a while ago. The implementation has been
renamed DefaultHierarchyManager, stayed in the same package. We first
moved the interface in a new info.magnolia.api package; we will now
revert this to the old package, for lack of a conscensus on the
naming.
The same treatment will soon be applied to the Content and NodeData
classes.
At first I was confused about the names:
Content --> Node
NodeData --> Property
I had chosen MgnlNode and MgnlProperty as names for the wrapper
classes, in my
opinion more self-explanatory.
The reasons of extracting the interfaces:
* testing
* integration of 3rd party tools (it will be trivial to expose a
Content instance as a javax.jcr.Node)
Ultimately, we'd like to move these to a new package for the
following reasons:
* general cleanup of the package structure and naming
* having a separate jar containing only the public api of Magnolia,
on which external projects/modules/.. could depend
Since we're not happy with the info.magnolia.api naming right now,
we'll just keep on using the current package name for a while.
[...]
- use singular form for package names: servlet instead of servlets
- use Base prefix instead of Simple, Default, etc prefix and Impl
suffix, make
it consistent: BaseControl instead of ControlImpl...
AbstractExpressionImpl ;) - this one gets beaten only by openwfe.org.*
- use common Java naming scheme for classes: EditDialog instead of
DialogEdit
and EditBar instead of BarEdit
- use either Mgnl or Magnolia as prefix, not both
- cache and mail are modules but don't live in a module package
namespace like
other modules
- control, controlx...
- two interfaces with name Control in related context: one from
control, other
from controlx
- the use of core and cms is not obvious, move filters and servlets to
info.magnolia.web.*
- manager classes in package .beans.config, create a business or
manager
package
- beans.runtime... runtime?
I know that it's not always easy to keep a growing application
consistent and
find proper names, but sorry - I'm a qualified Bürokaufmann - it's
in my
nature...
O.
----------------------------------------------------------------
for list details see
http://documentation.magnolia.info/docs/en/editor/stayupdated.html
----------------------------------------------------------------
----------------------------------------------------------------
for list details see
http://documentation.magnolia.info/docs/en/editor/stayupdated.html
----------------------------------------------------------------
