20 Sep
2012
20 Sep
'12
1:55 p.m.
Hello devs,
Why not XWikiWiki, XWikiSpace, XWikiDocument, XWikiObject and XWikiClass ?
In this case "XWiki" is not merely a prefix, it's really a description
of what the class represents : XWikiDocument is the concept of an
XWiki Document, and not just something related to XWiki. Or using "XW"
to shorten instead of "X" would avoid confusion between "XWiki" and
"Wiki prefixed by 'X' ".
Not really "at ease" to contribute to this pure dev topic, but I
couldn't resist ;-)
Br,
Jeremie
2012/9/14 Jean-Vincent Drean <jv(a)xwiki.com>om>:
On Fri, Sep 14, 2012 at 9:29 AM, Vincent Massol
<vincent(a)massol.net> wrote:
Hi devs,
As you may have seen, I've been working on the new model in a branch.
We need to decide on the naming of the Entity classes (wiki, space, document, object,
object definition, etc).
We have several possibilities I know of for naming them:
1) Wiki, Space, Document, Object, ObjectDefinition
2) WikiEntity, SpaceEntity, DocumentEntity, ObjectDefinitionEntity
3) Wiki, Space, Document, XObject, XObjectDefinition (or simply ObjectDefinition)
4) XWiki, XSpace, XDocument, XObject, XObjectDefinition
5) Some other name for objects.
Some concerns:
* Using Object as in 1) is a bit of a pain since there's java.lang.Object which
forces to use the FQN name when coding in Java. Which is why I've put proposals 2) and
3)
* In proposal 3) there's a bit of an inconsistency with the X in XObject which is not
present in the other entity names, hence proposal 4 and 2)
* In proposal 1) there can be some other clashes. For example Document can clash with the
DOM Document object
My personal vote goes to 2), even though it makes the entity names a bit longer.
In the list above my preferences goes to 2) but we've been using the
term Class for years and I'm afraid we'd be mixing
ObjectDefinition/Class everywhere. It seems safer to me, even if it's
not perfect for the reasons mentioned in the thread, to go for:
WikiEntity, SpaceEntity, DocumentEntity, ObjectEntity, ClassEntity
JV.
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs