Author: tmortagne
Date: 2007-10-01 18:51:42 +0200 (Mon, 01 Oct 2007)
New Revision: 5195
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/DefaultSuperDocument.java
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java
Log:
* Rename private methods for _methodName to methodName to better fit XWiki code
norm
* Improve javadoc
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-01 16:48:02 UTC (rev 5194)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/AbstractSuperClass.java
2007-10-01 16:51:42 UTC (rev 5195)
@@ -241,7 +241,9 @@
/**
* Constructor for AbstractSuperClass.
*
- * @param prefix Prefix of class document.
+ * @param prefix the prefix of class document.
+ * @see #AbstractSuperClass(String, String)
+ * @see #AbstractSuperClass(String, String, boolean)
*/
protected AbstractSuperClass(String prefix)
{
@@ -251,8 +253,10 @@
/**
* Constructor for AbstractSuperClass.
*
- * @param spaceprefix Space of class document.
- * @param prefix Prefix of class document.
+ * @param spaceprefix the space prefix of class document.
+ * @param prefix the prefix of class document.
+ * @see #AbstractSuperClass(String)
+ * @see #AbstractSuperClass(String, String, boolean)
*/
protected AbstractSuperClass(String spaceprefix, String prefix)
{
@@ -262,9 +266,11 @@
/**
* Constructor for AbstractSuperClass.
*
- * @param spaceprefix Space of class document.
- * @param prefix Prefix of class document.
- * @param dispatch Use XWiki applications space names.
+ * @param spaceprefix the space of class document.
+ * @param prefix the prefix of class document.
+ * @param dispatch Indicate if it had to use standard XWiki applications
space names.
+ * @see #AbstractSuperClass(String)
+ * @see #AbstractSuperClass(String, String)
*/
protected AbstractSuperClass(String spaceprefix, String prefix, boolean
dispatch)
{
@@ -311,16 +317,17 @@
* Check if all necessary documents for manage this class in this context
exists and update.
* Create if not exists. Thread safe.
*
- * @param context Context.
+ * @param context the XWiki context.
* @throws XWikiException
+ * @see #checkClassDocument(XWikiContext)
*/
protected void check(XWikiContext context) throws XWikiException
{
synchronized (databasesInitedMap) {
if (!this.databasesInitedMap.contains(context.getDatabase())) {
- _checkClassDocument(context);
- _checkClassSheetDocument(context);
- _checkClassTemplateDocument(context);
+ checkClassDocument(context);
+ checkClassSheetDocument(context);
+ checkClassTemplateDocument(context);
this.databasesInitedMap.add(context.getDatabase());
}
@@ -330,10 +337,10 @@
/**
* Check if class document exists in this context and update. Create if
not exists.
*
- * @param context Context.
+ * @param context the XWiki context.
* @throws XWikiException
*/
- private void _checkClassDocument(XWikiContext context) throws
XWikiException
+ private void checkClassDocument(XWikiContext context) throws XWikiException
{
XWikiDocument doc;
XWiki xwiki = context.getWiki();
@@ -369,10 +376,10 @@
/**
* Check if class sheet document exists in this context and update. Create
if not exists.
*
- * @param context Context.
+ * @param context the XWiki context.
* @throws XWikiException
*/
- private void _checkClassSheetDocument(XWikiContext context) throws
XWikiException
+ private void checkClassSheetDocument(XWikiContext context) throws
XWikiException
{
XWikiDocument doc;
XWiki xwiki = context.getWiki();
@@ -408,10 +415,10 @@
/**
* Check if class template document exists in this context and update.
Create if not exists.
*
- * @param context Context.
+ * @param context the XWiki context.
* @throws XWikiException
*/
- private void _checkClassTemplateDocument(XWikiContext context) throws
XWikiException
+ private void checkClassTemplateDocument(XWikiContext context) throws
XWikiException
{
XWikiDocument doc;
XWiki xwiki = context.getWiki();
@@ -443,8 +450,8 @@
/**
* Configure BaseClass.
*
- * @param baseClass BaseClass to configure.
- * @return boolean True if <code>baseClass</code> modified.
+ * @param baseClass the baseClass to configure.
+ * @return true if <code>baseClass</code> modified.
*/
protected boolean updateBaseClass(BaseClass baseClass)
{
@@ -568,11 +575,29 @@
context);
}
+ /**
+ * Find all XWikiDocument containing object of this XWiki class.
+ *
+ * @param context the XWiki context.
+ * @return a list of XWikiDocument containing object of this XWiki class.
+ * @throws XWikiException
+ * @see #getClassFullName()
+ */
public List searchItemDocuments(XWikiContext context) throws XWikiException
{
return searchItemDocumentsByFields(null, null, context);
}
+ /**
+ * Find XWikiDocument containing object of this XWiki class with provided
full name. Difference
+ * with [EMAIL PROTECTED] XWiki#getDocument(String, XWikiContext)} is that
it will not return "new"
+ * XWikiDocument.
+ *
+ * @param docFullName the full name of the document.
+ * @param context the XWiki context.
+ * @return a list with just one XWikiDocument containing object of this
XWiki class.
+ * @throws XWikiException
+ */
public List searchItemDocuments(String docFullName, XWikiContext context)
throws XWikiException
{
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/DefaultSuperDocument.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/DefaultSuperDocument.java
2007-10-01 16:48:02 UTC (rev 5194)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/DefaultSuperDocument.java
2007-10-01 16:51:42 UTC (rev 5195)
@@ -29,9 +29,13 @@
import com.xpn.xwiki.objects.BaseObject;
/**
- * Default implementation of SuperDocument.
+ * Default implementation of SuperDocument. This class manage an XWiki
document containing provided
+ * XWiki class. It add some specifics methods, getters and setters for this
type of object and
+ * fields. It also override [EMAIL PROTECTED] Document} (and then [EMAIL
PROTECTED] XWikiDocument}) isNew concept
+ * considering as new a document that does not contains an XWiki object of the
provided XWiki class.
*
* @see SuperDocument
+ * @see SuperClass
*/
public class DefaultSuperDocument extends Document implements SuperDocument
{
@@ -54,7 +58,7 @@
throws XWikiException
{
super(xdoc, context);
-
+
this.sclass = sclass;
reload(context);
@@ -64,10 +68,10 @@
{
getDoc().setFullName(docFullName, context);
}
-
+
/**
* [EMAIL PROTECTED]
- *
+ *
* @see com.xpn.xwiki.util.SuperDocument#reload(com.xpn.xwiki.api.Document,
* com.xpn.xwiki.XWikiContext)
*/
@@ -79,7 +83,7 @@
XWikiDocument docTemplate =
this.sclass.getClassTemplateDocument(context);
BaseObject templateObject =
docTemplate.getObject(this.sclass.getClassFullName());
-
+
if (templateObject != null)
object.merge(templateObject);
@@ -87,28 +91,28 @@
setParent(this.sclass.getClassFullName());
setContent(docTemplate.getContent());
}
-
+
this.isNew = true;
}
}
/**
* [EMAIL PROTECTED]
- *
+ *
* @see
com.xpn.xwiki.util.SuperDocument#merge(com.xpn.xwiki.util.SuperDocument)
*/
public void mergeBaseObject(SuperDocument sdoc)
{
if (getSuperClass() != sdoc.getSuperClass())
- return ;
-
+ return;
+
getDoc().getObject(this.sclass.getClassFullName()).merge(
sdoc.getDocument().getObject(this.sclass.getClassFullName()));
}
-
+
/**
* [EMAIL PROTECTED]
- *
+ *
* @see com.xpn.xwiki.util.SuperDocument#getSuperClass()
*/
public SuperClass getSuperClass()
@@ -118,7 +122,7 @@
/**
* [EMAIL PROTECTED]
- *
+ *
* @see com.xpn.xwiki.util.SuperDocument#isNew()
*/
public boolean isNew()
@@ -128,7 +132,7 @@
/**
* [EMAIL PROTECTED]
- *
+ *
* @see com.xpn.xwiki.util.SuperDocument#save(com.xpn.xwiki.XWikiContext)
*/
public void save() throws XWikiException
@@ -143,12 +147,11 @@
this.isNew = true;
}
-
/**
* @see com.xpn.xwiki.doc.XWikiDocument#getStringValue(java.lang.String)
*/
public String getStringValue(String fieldName)
- {
+ {
return this.doc.getStringValue(this.sclass.getClassFullName(),
fieldName);
}
@@ -164,10 +167,10 @@
* @see com.xpn.xwiki.doc.XWikiDocument#getStringValue(java.lang.String)
*/
public String getLargeStringValue(String fieldName)
- {
+ {
return this.doc.getStringValue(this.sclass.getClassFullName(),
fieldName);
}
-
+
/**
* @see
com.xpn.xwiki.doc.XWikiDocument#setLargeStringValue(java.lang.String,java.lang.String,java.lang.String)
*/
@@ -175,7 +178,7 @@
{
getDoc().setLargeStringValue(this.sclass.getClassFullName(),
fieldName, value);
}
-
+
/**
* @see com.xpn.xwiki.doc.XWikiDocument#getListValue(java.lang.String)
*/
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-01 16:48:02 UTC (rev 5194)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/core/doc/objects/classes/SuperClass.java
2007-10-01 16:51:42 UTC (rev 5195)
@@ -34,6 +34,10 @@
* <li>search in documents that contains this class with conditions on class
fields
* <li>support the XWiki norm about spaces and documents naming
* </ul>
+ *
+ * @todo See http://jira.xwiki.org/jira/browse/XWIKI-1571. When that issue is
applied in XWiki Core
+ * and when this plugin moves to the version of XWiki Core where it was
applied then remove
+ * this class.
*/
public interface SuperClass
{
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications
