[xwiki-devs] [Proposal] Add getEntityReference method to WikiMacro
Hi devs, I'm proposing we add the following method: DocumentReference getEntityReference(); to org.xwiki.rendering.macro.wikibridge.WikiMacro. This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached. Thanks, Anamaria
On Wed, Feb 24, 2010 at 18:19, Anamaria Stoica <[email protected]> wrote:
Hi devs,
I'm proposing we add the following method: DocumentReference getEntityReference();
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
It mainly depends if we want to make the entity part of the wiki macro definition. I guess it's ok since if it's not a part of the wiki macro definition then it's not more than a Macro. So +1 for me.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
Hi All, There is any graphical class diagram such as the generated by doxygen, and a database hypermap such as the generated by HyperSQL? Regards Robert On Wed, Feb 24, 2010 at 9:28 PM, Thomas Mortagne <[email protected]>wrote:
On Wed, Feb 24, 2010 at 18:19, Anamaria Stoica <[email protected]> wrote:
Hi devs,
I'm proposing we add the following method: DocumentReference getEntityReference();
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
It mainly depends if we want to make the entity part of the wiki macro definition. I guess it's ok since if it's not a part of the wiki macro definition then it's not more than a Macro.
So +1 for me.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- ca: M'agradaria millorar el món, però Déu no em dóna el codi font! de: Ich würde gern die Welt verbessern, doch Gott gibt mir den Quellcode nicht! en: I would like to improve the world, but God didn't give me the source code! es: Me gustaría mejorar el mundo, pero Dios no me da el código fuente! gpg fingerprint = 0800 D37B C187 CC6E 9D0C 0AF4 265D 0096 AC78 6412
Hi Anamaria, Anamaria Stoica wrote:
Hi devs,
I'm proposing we add the following method:
DocumentReference getEntityReference();
Why not getDocumentReference()? considering the returned type. +1 otherwise. Thanks, Marius
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi Marius, On Thu, Feb 25, 2010 at 9:59 AM, Marius Dumitru Florea <[email protected]> wrote:
Hi Anamaria,
Anamaria Stoica wrote:
Hi devs,
I'm proposing we add the following method:
DocumentReference getEntityReference();
Why not getDocumentReference()? considering the returned type.
Good observation, thanks! I put the return type as DocumentReference because this is what it got in the constructor of DefaultWikiMacro, but as DocumentReference extends EntityReference, we could make the new method return an EntityReference, thus have: EntityReference getEntityReference(); Question is now, does it make sense to have any Entity Reference as return type, or it must to be a document type? Thanks, Anamaria
+1 otherwise.
Thanks, Marius
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Anamaria Stoica wrote:
Hi Marius,
On Thu, Feb 25, 2010 at 9:59 AM, Marius Dumitru Florea <[email protected]> wrote:
Hi Anamaria,
Anamaria Stoica wrote:
Hi devs,
I'm proposing we add the following method: DocumentReference getEntityReference(); Why not getDocumentReference()? considering the returned type.
Good observation, thanks!
I put the return type as DocumentReference because this is what it got in the constructor of DefaultWikiMacro, but as DocumentReference extends EntityReference, we could make the new method return an EntityReference, thus have:
EntityReference getEntityReference();
Question is now, does it make sense to have any Entity Reference as return type, or it must to be a document type?
Currently wiki macros are defined as objects attached to wiki pages. I don't think this will be changed too soon so IMO returning a DocumentReference is fine. Thanks, Marius
Thanks, Anamaria
+1 otherwise.
Thanks, Marius
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi, I created the JIRA issue: http://jira.xwiki.org/jira/browse/XWIKI-4939 related to this proposal and attached a patch to it. Who would have some time to look at it? Thanks, Anamaria On Thu, Feb 25, 2010 at 11:52 AM, Marius Dumitru Florea <[email protected]> wrote:
Anamaria Stoica wrote:
Hi Marius,
On Thu, Feb 25, 2010 at 9:59 AM, Marius Dumitru Florea <[email protected]> wrote:
Hi Anamaria,
Anamaria Stoica wrote:
Hi devs,
I'm proposing we add the following method: DocumentReference getEntityReference(); Why not getDocumentReference()? considering the returned type.
Good observation, thanks!
I put the return type as DocumentReference because this is what it got in the constructor of DefaultWikiMacro, but as DocumentReference extends EntityReference, we could make the new method return an EntityReference, thus have:
EntityReference getEntityReference();
Question is now, does it make sense to have any Entity Reference as return type, or it must to be a document type?
Currently wiki macros are defined as objects attached to wiki pages. I don't think this will be changed too soon so IMO returning a DocumentReference is fine.
Thanks, Marius
Thanks, Anamaria
+1 otherwise.
Thanks, Marius
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi, On Thu, Feb 25, 2010 at 1:29 PM, Marius Dumitru Florea < [email protected]> wrote:
Hi Anamaria,
Anamaria Stoica wrote:
Hi devs,
I'm proposing we add the following method:
DocumentReference getEntityReference();
Why not getDocumentReference()? considering the returned type.
+1 for getDocumentReference() btw, there is a getDocumentName()::DocumentReference method in the DefaultWikiMacro class you might have to rename to avoid duplication. - Asiri
+1 otherwise.
Thanks, Marius
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Thu, Feb 25, 2010 at 08:59, Marius Dumitru Florea <[email protected]> wrote:
Hi Anamaria,
Anamaria Stoica wrote:
Hi devs,
I'm proposing we add the following method:
DocumentReference getEntityReference();
Why not getDocumentReference()? considering the returned type.
Indeed that's the right name.
+1 otherwise.
Thanks, Marius
to org.xwiki.rendering.macro.wikibridge.WikiMacro.
This way we'll have a simple way to retrieve the wiki Document having the corresponding XWiki.WikiMacroClass xObject attached.
Thanks, Anamaria _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
participants (5)
-
Anamaria Stoica -
Asiri Rathnayake -
Marius Dumitru Florea -
Robert Antoni -
Thomas Mortagne