Author: tmortagne Date: 2007-10-16 16:28:18 +0200 (Tue, 16 Oct 2007) New Revision: 5400
Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/pom.xml xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerException.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/plugin/XWikiPluginMessageTool.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplicationClass.java xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/sheets/XAppSheets.XWikiApplicationClassSheet.vm Log: * Codestyle and javadoc corrections. Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/pom.xml =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/pom.xml 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/pom.xml 2007-10-16 14:28:18 UTC (rev 5400) @@ -1,4 +1,6 @@ -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> <parent> <artifactId>xwiki-plugins</artifactId> <groupId>com.xpn.xwiki.platform.plugins</groupId> @@ -8,14 +10,16 @@ <artifactId>xwiki-plugin-application-manager</artifactId> <name>XWiki Platform - Plugins - Application Manager</name> <version>1.0-SNAPSHOT</version> - <description>XWiki Platform - Plugins - Application Manager</description> + <description> + XWiki Platform - Plugins - Application Manager + </description> <dependencies> <dependency> <groupId>com.xpn.xwiki.platform</groupId> <artifactId>xwiki-core</artifactId> <!-- Currently this Application Manager plugin is used by XEM which is based on XWiki Core - version 1.1.x, hence this dependency on 1.1.X and not on 1.2.x. If this becomes a - problem we can branch this plugin. --> + version 1.1.x, hence this dependency on 1.1.X and not on 1.2.x. If this becomes a + problem we can branch this plugin. --> <version>1.1-SNAPSHOT</version> </dependency> <dependency> Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManager.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -196,7 +196,7 @@ } throw new ApplicationManagerException( - ApplicationManagerException.ERROR_APPLICATIONMANAGER_APPDOC_ALREADY_EXISTS, + ApplicationManagerException.ERROR_AM_APPDOCALREADYEXISTS, "Application \"" + userAppSuperDoc.getAppName() + "\" document already exist"); } else if (LOG.isWarnEnabled()) { LOG.warn("Application creation (" + userAppSuperDoc Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerException.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerException.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerException.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -35,14 +35,14 @@ public static final int MODULE_PLUGIN_APPLICATIONMANAGER = 60; /** - * Error used when trying to create application descriptor that already exist in the database. + * Error when trying to create application descriptor that already exist in the database. */ - public static final int ERROR_APPLICATIONMANAGER_APPDOC_ALREADY_EXISTS = 60010; + public static final int ERROR_AM_APPDOCALREADYEXISTS = 60010; /** * Error when trying to get application descriptor that does not exist in the database. */ - public static final int ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST = 60011; + public static final int ERROR_AM_DOESNOTEXIST = 60011; /** * The default ApplicationManagerException. Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/ApplicationManagerPluginApi.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -142,12 +142,12 @@ * <p> * Error codes can be : * <ul> - * <li> [EMAIL PROTECTED] XWikiExceptionApi#ERROR_NOERROR} : action finished with no error. + * <li> [EMAIL PROTECTED] XWikiExceptionApi#ERROR_NOERROR} : method succeed with no error.</li> * <li> [EMAIL PROTECTED] XWikiException#ERROR_XWIKI_ACCESS_DENIED} : context's user don't have - * rights to do this action. + * rights to do this action.</li> * <li> - * [EMAIL PROTECTED] ApplicationManagerException#ERROR_APPLICATIONMANAGER_APPDOC_ALREADY_EXISTS} : - * application descriptor already exists. + * [EMAIL PROTECTED] ApplicationManagerException#ERROR_AM_APPDOCALREADYEXISTS} : + * application descriptor already exists.</li> * </ul> * @throws XWikiException all error that does not caused by user of this method. */ @@ -190,7 +190,7 @@ * <li> [EMAIL PROTECTED] XWikiExceptionApi#ERROR_NOERROR} : action finished with no error. * <li> [EMAIL PROTECTED] XWikiException#ERROR_XWIKI_ACCESS_DENIED} : context's user don't have * rights to do this action. - * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST} : + * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_AM_DOESNOTEXIST} : * provided application does not exist. * </ul> * @throws XWikiException all error that does not caused by user of this method. @@ -245,7 +245,7 @@ * [EMAIL PROTECTED] #CONTEXT_LASTERRORCODE} field and exception in context's * [EMAIL PROTECTED] #CONTEXT_LASTEXCEPTION} field. Error codes can be : * <ul> - * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST} : + * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_AM_DOESNOTEXIST} : * provided application does not exist. * </ul> * @throws XWikiException all error that does not caused by user of this method. @@ -277,7 +277,7 @@ * Error codes can be : * <ul> * <li> [EMAIL PROTECTED] XWikiExceptionApi#ERROR_NOERROR} : action finished with no error. - * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST} : + * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_AM_DOESNOTEXIST} : * provided application does not exist. * </ul> * @throws XWikiException all error that does not caused by user of this method. @@ -301,7 +301,7 @@ * Error codes can be : * <ul> * <li> [EMAIL PROTECTED] XWikiExceptionApi#ERROR_NOERROR} : action finished with no error. - * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST} : + * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_AM_DOESNOTEXIST} : * provided application does not exist. * </ul> * @throws XWikiException all error that does not caused by user of this method. @@ -341,7 +341,7 @@ * <li> [EMAIL PROTECTED] XWikiExceptionApi#ERROR_NOERROR} : action finished with no error. * <li> [EMAIL PROTECTED] XWikiException#ERROR_XWIKI_ACCESS_DENIED} : context's user don't have * rights to do this action. - * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST} : + * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_AM_DOESNOTEXIST} : * provided application does not exist. * </ul> * @throws XWikiException all error that does not caused by user of this method. @@ -388,7 +388,7 @@ * <li> [EMAIL PROTECTED] XWikiExceptionApi#ERROR_NOERROR} : action finished with no error. * <li> [EMAIL PROTECTED] XWikiException#ERROR_XWIKI_ACCESS_DENIED} : context's user don't have * rights to do this action. - * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST} : + * <li> [EMAIL PROTECTED] ApplicationManagerException#ERROR_AM_DOESNOTEXIST} : * provided application does not exist. * </ul> * @throws XWikiException all error that does not caused by user of this method. Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -215,18 +215,18 @@ classSpace = dispatch ? classSpacePrefix + XWIKI_CLASS_SPACE_SUFFIX : classSpacePrefix; className = classPrefix + XWIKI_CLASS_SUFFIX; - classFullName = classSpace + SuperClass.SPACE_DOC_SEPARATOR + className; + classFullName = classSpace + SuperDocument.SPACE_DOC_SEPARATOR + className; classSheetSpace = dispatch ? classSpacePrefix + XWIKI_CLASSSHEET_SPACE_SUFFIX : classSpacePrefix; classSheetName = classPrefix + XWIKI_CLASSSHEET_SUFFIX; - classSheetFullName = classSheetSpace + SuperClass.SPACE_DOC_SEPARATOR + classSheetName; + classSheetFullName = classSheetSpace + SuperDocument.SPACE_DOC_SEPARATOR + classSheetName; classTemplateSpace = dispatch ? classSpacePrefix + XWIKI_CLASSTEMPLATE_SPACE_SUFFIX : classSpacePrefix; classTemplateName = classPrefix + XWIKI_CLASSTEMPLATE_SUFFIX; classTemplateFullName = - classTemplateSpace + SuperClass.SPACE_DOC_SEPARATOR + classTemplateName; + classTemplateSpace + SuperDocument.SPACE_DOC_SEPARATOR + classTemplateName; classSheetDefaultContent = "## you can modify this page to customize the presentation of your object\n\n" @@ -637,7 +637,7 @@ */ public String getItemDocumentDefaultFullName(String itemName, XWikiContext context) { - return getClassSpacePrefix() + SuperClass.SPACE_DOC_SEPARATOR + return getClassSpacePrefix() + SuperDocument.SPACE_DOC_SEPARATOR + getItemDocumentDefaultName(itemName, context); } @@ -649,7 +649,7 @@ public String getItemDefaultName(String docFullName) { return docFullName.substring( - (getClassSpacePrefix() + SuperClass.SPACE_DOC_SEPARATOR + getClassPrefix()).length()) + (getClassSpacePrefix() + SuperDocument.SPACE_DOC_SEPARATOR + getClassPrefix()).length()) .toLowerCase(); } Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -41,13 +41,8 @@ * this class. */ public interface SuperClass -{ +{ /** - * The separator between space name and document name in document full name. - */ - String SPACE_DOC_SEPARATOR = "."; - - /** * Default suffix for the document containing the class. */ String XWIKI_CLASS_SUFFIX = "Class"; Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperDocument.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -33,6 +33,16 @@ public interface SuperDocument { /** + * The separator between space name and document name in document full name. + */ + String SPACE_DOC_SEPARATOR = "."; + + /** + * The separator between wiki name and space name and document extended full name. + */ + String WIKI_SPACE_SEPARATOR = ":"; + + /** * Reload XWiki document from database using Document full name. * * @param context the XWiki context. Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/plugin/XWikiPluginMessageTool.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/plugin/XWikiPluginMessageTool.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/plugin/XWikiPluginMessageTool.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -27,6 +27,15 @@ } /** + * @param bundle the default Resource Bundle to fall back to if no document bundle is found when + * trying to get a key + */ + public XWikiPluginMessageTool(ResourceBundle bundle) + { + super(bundle, null); + } + + /** * [EMAIL PROTECTED] * <p> * Start calling <code>context</code>'s [EMAIL PROTECTED] XWikiMessageTool#get(String)} then if nothing @@ -36,9 +45,14 @@ */ protected String getTranslation(String key) { - String translation = this.context.getMessageTool().get(key); + String translation = key; + + if (context != null) { + translation = this.context.getMessageTool().get(key); + } - // Want to know if XWikiMessageTool.get return excatly what it get means it found nothing + // Want to know if XWikiMessageTool.get return exactly the provided key string (means it + // found nothing). if (translation == key) { try { translation = this.bundle.getString(key); Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplication.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -34,7 +34,7 @@ import com.xpn.xwiki.doc.XWikiDocument; /** - * This class manage an XWiki document containing XWiki.XWikiApplicationClass object. It add some + * This class manage an XWiki document containing XApp.XWikiApplicationClass object. It add some * specifics methods, getters and setters for this type of object and fields. * * @version $Id: $ @@ -57,7 +57,7 @@ * <li>getting XWikiApplicationClass instance.</li> * <li>or when calling [EMAIL PROTECTED] #reload(XWikiContext)}</li> * </ul> - * @see com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.DefaultSuperDocument#DefaultSuperDocument(com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.SuperClass, + * @see DefaultSuperDocument#DefaultSuperDocument(com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes.SuperClass, * XWikiDocument, XWikiContext) */ public XWikiApplication(XWikiDocument xdoc, XWikiContext context) throws XWikiException Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplicationClass.java =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplicationClass.java 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplicationClass.java 2007-10-16 14:28:18 UTC (rev 5400) @@ -50,7 +50,7 @@ /** * Default list separators of XAppClasses.XWikiApplicationClass fields. */ - public static final String FIELDS_DESCRIPTION = "|"; + public static final String DEFAULT_FIELDS = "|"; /** * Name of field <code>appname</code> for the XWiki class XAppClasses.XWikiApplicationClass. @@ -237,27 +237,27 @@ needsUpdate |= baseClass.addStaticListField(FIELD_DEPENDENCIES, FIELDPN_DEPENDENCIES, 80, true, "", - DEFAULT_FIELDDT, FIELDS_DESCRIPTION); + DEFAULT_FIELDDT, DEFAULT_FIELDS); needsUpdate |= baseClass.addStaticListField(FIELD_APPLICATIONS, FIELDPN_APPLICATIONS, 80, true, "", - DEFAULT_FIELDDT, FIELDS_DESCRIPTION); + DEFAULT_FIELDDT, DEFAULT_FIELDS); needsUpdate |= baseClass.addStaticListField(FIELD_DOCUMENTS, FIELDPN_DOCUMENTS, 80, true, "", - DEFAULT_FIELDDT, FIELDS_DESCRIPTION); + DEFAULT_FIELDDT, DEFAULT_FIELDS); needsUpdate |= baseClass.addStaticListField(FIELD_DOCSTOINCLUDE, FIELDPN_DOCSTOINCLUDE, 80, true, - "", DEFAULT_FIELDDT, FIELDS_DESCRIPTION); + "", DEFAULT_FIELDDT, DEFAULT_FIELDS); needsUpdate |= baseClass.addStaticListField(FIELD_DOCSTOLINK, FIELDPN_DOCSTOLINK, 80, true, "", - DEFAULT_FIELDDT, FIELDS_DESCRIPTION); + DEFAULT_FIELDDT, DEFAULT_FIELDS); needsUpdate |= baseClass.addStaticListField(FIELD_TRANSLATIONDOCS, FIELDPN_TRANSLATIONDOCS, 80, - true, "", DEFAULT_FIELDDT, FIELDS_DESCRIPTION); + true, "", DEFAULT_FIELDDT, DEFAULT_FIELDS); return needsUpdate; } @@ -291,9 +291,9 @@ * * @param appName the name of the application. * @param context the XWiki context. - * @param validate indicate if it return new XWikiDocument or throw exception if application - * descriptor does not exist. - * @return the XWikiDocument representing application descriptor. + * @param validate indicate if it return new [EMAIL PROTECTED] XWikiDocument} or throw exception if + * application descriptor does not exist. + * @return the [EMAIL PROTECTED] XWikiDocument} representing application descriptor. * @throws XWikiException error when searching for application descriptor document. * @see #getApplication(String, XWikiContext, boolean) */ @@ -309,7 +309,7 @@ if (listApp.size() == 0) { if (validate) { throw new ApplicationManagerException( - ApplicationManagerException.ERROR_APPLICATIONMANAGER_DOES_NOT_EXIST, + ApplicationManagerException.ERROR_AM_DOESNOTEXIST, appName + " application does not exist"); } else { return xwiki.getDocument(getItemDocumentDefaultFullName(appName, context), Modified: xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/sheets/XAppSheets.XWikiApplicationClassSheet.vm =================================================================== --- xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/sheets/XAppSheets.XWikiApplicationClassSheet.vm 2007-10-16 14:21:28 UTC (rev 5399) +++ xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/resources/sheets/XAppSheets.XWikiApplicationClassSheet.vm 2007-10-16 14:28:18 UTC (rev 5400) @@ -39,7 +39,7 @@ #elseif($context.action == "view" && $prop.name == "applications") <dd> #foreach($appname in $app.getApplications()) - [$appname>$Appmanager.getApplicationDocument($object.appname).fullName] + [$appname>$Appmanager.getApplicationDocument($appname).fullName] #end </dd> #else _______________________________________________ notifications mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/notifications
