Author: vmassol
Date: 2007-09-12 17:43:32 +0200 (Wed, 12 Sep 2007)
New Revision: 4879
Added:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/SuperClass.java
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/SuperDocument.java
Removed:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperClass.java
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperDocument.java
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/AbstractSuperClass.java
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/DefaultSuperDocument.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/test/java/com/xpn/xwiki/doc/objects/classes/TestAbstractSuperClassTest.java
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServer.java
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServerClass.java
Log:
XAAM-1: XWiki Application format
* Renamed interfaces to leave out the "I" prefix to follow current coding
conventions
* Minor cleanup
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/AbstractSuperClass.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/AbstractSuperClass.java
2007-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/AbstractSuperClass.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -29,12 +29,12 @@
import com.xpn.xwiki.objects.classes.BaseClass;
/**
- * Abstract implementation of ISuperClass.
+ * Abstract implementation of SuperClass.
* @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 abstract class AbstractSuperClass implements ISuperClass
+public abstract class AbstractSuperClass implements SuperClass
{
/**
* Space prefix of class document.
@@ -123,7 +123,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassSpace()
+ * @see com.xpn.xwiki.util.SuperClass#getClassSpace()
*/
public String getClassSpace()
{
@@ -133,7 +133,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassPrefix()
+ * @see com.xpn.xwiki.util.SuperClass#getClassPrefix()
*/
public String getClassPrefix()
{
@@ -143,7 +143,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassName()
*/
public String getClassName()
{
@@ -153,7 +153,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassFullName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassFullName()
*/
public String getClassFullName()
{
@@ -163,7 +163,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassTemplateName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassTemplateName()
*/
public String getClassTemplateSpace()
{
@@ -173,7 +173,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassTemplateName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassTemplateName()
*/
public String getClassTemplateName()
{
@@ -183,7 +183,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassTemplateFullName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassTemplateFullName()
*/
public String getClassTemplateFullName()
{
@@ -193,7 +193,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassSheetName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassSheetName()
*/
public String getClassSheetSpace()
{
@@ -203,7 +203,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassSheetName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassSheetName()
*/
public String getClassSheetName()
{
@@ -213,7 +213,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassSheetFullName()
+ * @see com.xpn.xwiki.util.SuperClass#getClassSheetFullName()
*/
public String getClassSheetFullName()
{
@@ -342,7 +342,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassSheetDefaultContent()
+ * @see com.xpn.xwiki.util.SuperClass#getClassSheetDefaultContent()
*/
public String getClassSheetDefaultContent()
{
@@ -381,7 +381,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getClassTemplateDefaultContent()
+ * @see com.xpn.xwiki.util.SuperClass#getClassTemplateDefaultContent()
*/
public String getClassTemplateDefaultContent()
{
@@ -444,7 +444,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperClass#getBaseClass()
+ * @see com.xpn.xwiki.util.SuperClass#getBaseClass()
*/
public BaseClass getBaseClass()
{
@@ -459,7 +459,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperClass#getClassDocument(com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.util.SuperClass#getClassDocument(com.xpn.xwiki.XWikiContext)
*/
public XWikiDocument getClassDocument(XWikiContext context) throws
XWikiException
{
@@ -471,7 +471,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperClass#getClassSheetDocument(com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.util.SuperClass#getClassSheetDocument(com.xpn.xwiki.XWikiContext)
*/
public XWikiDocument getClassSheetDocument(XWikiContext context) throws
XWikiException
{
@@ -483,7 +483,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperClass#getClassTemplateDocument(com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.util.SuperClass#getClassTemplateDocument(com.xpn.xwiki.XWikiContext)
*/
public XWikiDocument getClassTemplateDocument(XWikiContext context) throws
XWikiException
{
@@ -495,7 +495,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperClass#isInstanceOf(com.xpn.xwiki.doc.XWikiDocument,
+ * @see
com.xpn.xwiki.util.SuperClass#isInstanceOf(com.xpn.xwiki.doc.XWikiDocument,
* com.xpn.xwiki.XWikiContext)
*/
public boolean isInstance(XWikiDocument doc, XWikiContext context)
@@ -506,7 +506,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperClass#getItemDocumentName(java.lang.String)
+ * @see com.xpn.xwiki.util.SuperClass#getItemDocumentName(java.lang.String)
*/
public String getItemDocumentDefaultName(String itemName, XWikiContext
context)
{
@@ -518,7 +518,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperClass#getItemDocumentFullName(java.lang.String)
+ * @see
com.xpn.xwiki.util.SuperClass#getItemDocumentFullName(java.lang.String)
*/
public String getItemDocumentDefaultFullName(String itemName, XWikiContext
context)
{
@@ -526,7 +526,7 @@
}
/* (non-Javadoc)
- * @see
com.xpn.xwiki.doc.objects.classes.ISuperClass#getItemDefaultName(java.lang.String,
com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.doc.objects.classes.SuperClass#getItemDefaultName(java.lang.String,
com.xpn.xwiki.XWikiContext)
*/
public String getItemDefaultName(String docFullName, XWikiContext context)
{
@@ -534,7 +534,7 @@
}
/* (non-Javadoc)
- * @see com.xpn.xwiki.util.ISuperClass#getItemDocument(java.lang.String,
com.xpn.xwiki.XWikiContext)
+ * @see com.xpn.xwiki.util.SuperClass#getItemDocument(java.lang.String,
com.xpn.xwiki.XWikiContext)
*/
public XWikiDocument getItemDocument(String itemName, XWikiContext
context) throws XWikiException
{
@@ -552,7 +552,7 @@
}
/* (non-Javadoc)
- * @see
com.xpn.xwiki.doc.objects.classes.ISuperClass#searchItemDocumentsByField(java.lang.String,
java.lang.String, java.lang.String, com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.doc.objects.classes.SuperClass#searchItemDocumentsByField(java.lang.String,
java.lang.String, java.lang.String, com.xpn.xwiki.XWikiContext)
*/
public List searchItemDocumentsByField(String fieldName, String
fieldValue, String fieldType,
XWikiContext context) throws XWikiException
@@ -561,7 +561,7 @@
}
/* (non-Javadoc)
- * @see
com.xpn.xwiki.doc.objects.classes.ISuperClass#searchItemDocumentsByFields(java.lang.String,
java.lang.String[][], com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.doc.objects.classes.SuperClass#searchItemDocumentsByFields(java.lang.String,
java.lang.String[][], com.xpn.xwiki.XWikiContext)
*/
public List searchItemDocumentsByFields(String docFullName, String[][]
fieldDescriptors, XWikiContext context) throws XWikiException
{
@@ -591,25 +591,25 @@
}
/* (non-Javadoc)
- * @see
com.xpn.xwiki.doc.objects.classes.ISuperClass#newSuperDocument(com.xpn.xwiki.doc.XWikiDocument,
com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.doc.objects.classes.SuperClass#newSuperDocument(com.xpn.xwiki.doc.XWikiDocument,
com.xpn.xwiki.XWikiContext)
*/
- public ISuperDocument newSuperDocument(XWikiDocument doc, XWikiContext
context) throws XWikiException
+ public SuperDocument newSuperDocument(XWikiDocument doc, XWikiContext
context) throws XWikiException
{
return new DefaultSuperDocument(this, doc, context);
}
/* (non-Javadoc)
- * @see com.xpn.xwiki.util.ISuperClass#newSuperDocument(java.lang.String,
com.xpn.xwiki.XWikiContext)
+ * @see com.xpn.xwiki.util.SuperClass#newSuperDocument(java.lang.String,
com.xpn.xwiki.XWikiContext)
*/
- public ISuperDocument newSuperDocument(String docFullName, XWikiContext
context) throws XWikiException
+ public SuperDocument newSuperDocument(String docFullName, XWikiContext
context) throws XWikiException
{
return newSuperDocument(context.getWiki().getDocument(docFullName,
context), context);
}
/* (non-Javadoc)
- * @see
com.xpn.xwiki.util.ISuperClass#newSuperDocument(com.xpn.xwiki.XWikiContext)
+ * @see
com.xpn.xwiki.util.SuperClass#newSuperDocument(com.xpn.xwiki.XWikiContext)
*/
- public ISuperDocument newSuperDocument(XWikiContext context) throws
XWikiException
+ public SuperDocument newSuperDocument(XWikiContext context) throws
XWikiException
{
return newSuperDocument(new XWikiDocument(), context);
}
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/DefaultSuperDocument.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/DefaultSuperDocument.java
2007-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/DefaultSuperDocument.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -28,26 +28,26 @@
import com.xpn.xwiki.objects.BaseObject;
/**
- * Default implementation of ISuperDocument.
+ * Default implementation of SuperDocument.
*/
-public class DefaultSuperDocument extends Document implements ISuperDocument
+public class DefaultSuperDocument extends Document implements SuperDocument
{
- protected ISuperClass sclass;
+ protected SuperClass sclass;
protected boolean isNew = false;
- public DefaultSuperDocument(ISuperClass sclass, XWikiContext context)
throws XWikiException
+ public DefaultSuperDocument(SuperClass sclass, XWikiContext context)
throws XWikiException
{
this(sclass, new XWikiDocument(), context);
}
- public DefaultSuperDocument(ISuperClass sclass, String docFullName,
XWikiContext context)
+ public DefaultSuperDocument(SuperClass sclass, String docFullName,
XWikiContext context)
throws XWikiException
{
this(sclass, context.getWiki().getDocument(docFullName, context),
context);
}
- public DefaultSuperDocument(ISuperClass sclass, XWikiDocument xdoc,
XWikiContext context)
+ public DefaultSuperDocument(SuperClass sclass, XWikiDocument xdoc,
XWikiContext context)
throws XWikiException
{
super(xdoc, context);
@@ -65,7 +65,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperDocument#reload(com.xpn.xwiki.api.Document,
+ * @see com.xpn.xwiki.util.SuperDocument#reload(com.xpn.xwiki.api.Document,
* com.xpn.xwiki.XWikiContext)
*/
public void reload(XWikiContext context) throws XWikiException
@@ -92,9 +92,9 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperDocument#merge(com.xpn.xwiki.util.ISuperDocument)
+ * @see
com.xpn.xwiki.util.SuperDocument#merge(com.xpn.xwiki.util.SuperDocument)
*/
- public void mergeBaseObject(ISuperDocument sdoc)
+ public void mergeBaseObject(SuperDocument sdoc)
{
if (getSuperClass() != sdoc.getSuperClass())
return ;
@@ -106,9 +106,9 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperDocument#getSuperClass()
+ * @see com.xpn.xwiki.util.SuperDocument#getSuperClass()
*/
- public ISuperClass getSuperClass()
+ public SuperClass getSuperClass()
{
return this.sclass;
}
@@ -116,7 +116,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperDocument#isNew()
+ * @see com.xpn.xwiki.util.SuperDocument#isNew()
*/
public boolean isNew()
{
@@ -126,7 +126,7 @@
/*
* (non-Javadoc)
*
- * @see com.xpn.xwiki.util.ISuperDocument#save(com.xpn.xwiki.XWikiContext)
+ * @see com.xpn.xwiki.util.SuperDocument#save(com.xpn.xwiki.XWikiContext)
*/
public void save() throws XWikiException
{
@@ -137,7 +137,7 @@
/*
* (non-Javadoc)
*
- * @see
com.xpn.xwiki.util.ISuperDocument#delete(com.xpn.xwiki.XWikiContext)
+ * @see com.xpn.xwiki.util.SuperDocument#delete(com.xpn.xwiki.XWikiContext)
*/
public void delete(XWikiContext context) throws XWikiException
{
Deleted:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperClass.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperClass.java
2007-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperClass.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -1,273 +0,0 @@
-/*
- * Copyright 2006-2007, XpertNet SARL, and individual contributors.
- *
- * This is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * This software is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this software; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
- */
-
-package com.xpn.xwiki.doc.objects.classes;
-
-import java.util.List;
-
-import com.xpn.xwiki.XWikiContext;
-import com.xpn.xwiki.XWikiException;
-import com.xpn.xwiki.doc.XWikiDocument;
-import com.xpn.xwiki.objects.classes.BaseClass;
-
-public interface ISuperClass
-{
- /**
- * Default class document suffix.
- */
- static final String XWIKI_CLASS_SUFFIX = "Class";
-
- /**
- * Default class sheet document suffix.
- */
- static final String XWIKI_CLASSSHEET_SUFFIX = "ClassSheet";
-
- /**
- * Default class template document suffix.
- */
- static final String XWIKI_CLASSTEMPLATE_SUFFIX = "ClassTemplate";
-
- /**
- * Default class document space.
- */
- static final String XWIKI_CLASS_SPACE_PREFIX = "XWiki";
-
- /**
- * Default class document space.
- */
- static final String XWIKI_CLASS_SPACE_SUFFIX = "Classes";
-
- /**
- * Default class document space.
- */
- static final String XWIKI_CLASSSHEET_SPACE_SUFFIX = "Sheets";
-
- /**
- * Default class document space.
- */
- static final String XWIKI_CLASSTEMPLATE_SPACE_SUFFIX = "Templates";
-
- // ///
-
- /**
- * @return String Space prefix of class document.
- */
- String getClassSpacePrefix();
-
- /**
- * @return String Space of class document.
- */
- String getClassSpace();
-
- /**
- * @return String Prefix of class document.
- */
- String getClassPrefix();
-
- /**
- * @return String Name of class document.
- */
- String getClassName();
-
- /**
- * @return String Full name of class document.
- */
- String getClassFullName();
-
- /**
- * @return String Name of class template document.
- */
- String getClassTemplateName();
-
- /**
- * @return String Full name of class template document.
- */
- String getClassTemplateFullName();
-
- /**
- * @return String Name of class sheet document.
- */
- String getClassSheetName();
-
- /**
- * @return String Full name of class sheet document.
- */
- String getClassSheetFullName();
-
- /**
- * @return BaseClass BaseClass object managed.
- */
- BaseClass getBaseClass() throws XWikiException;
-
- /**
- * Return super class document for this context.
- *
- * @param context Context.
- *
- * @return XWikiDocument Class document for this context.
- */
- XWikiDocument getClassDocument(XWikiContext context) throws XWikiException;
-
- /**
- * Return super class sheet document content.
- *
- * @return String Default new class sheet document content.
- */
- String getClassSheetDefaultContent();
-
- /**
- * Return super class sheet document for this context.
- *
- * @param context Context.
- *
- * @return XWikiDocument Class sheet document for this context.
- */
- XWikiDocument getClassSheetDocument(XWikiContext context) throws
XWikiException;
-
- /**
- * Return super class template document content.
- *
- * @return String Default new class template document content.
- */
- String getClassTemplateDefaultContent();
-
- /**
- * Return super class template document for this context.
- *
- * @param context Context.
- *
- * @return XWikiDocument Class template document for this context.
- */
- XWikiDocument getClassTemplateDocument(XWikiContext context) throws
XWikiException;
-
- /**
- * Determines if the specified <code>doc</code> is compatible with this
xwiki class (if he contains class object).
- *
- * @param doc XWikidocument to test.
- * @param context Context.
- *
- * @return boolean True if <code>doc</code> support this class.
- *
- * @throws XWikiException
- */
- boolean isInstance(XWikiDocument doc, XWikiContext context) throws
XWikiException;
-
- /**
- * Get document name for item name <code>item</code>.
- *
- * @param itemName Name of the item.
- * @param context Context.
- *
- * @return String Name of the document.
- */
- String getItemDocumentDefaultName(String itemName, XWikiContext context);
-
- /**
- * Get document full name for item name <code>itemName</code>.
- *
- * @param itemName Full name of the item.
- * @param context Context.
- *
- * @return String Full name of the document.
- */
- String getItemDocumentDefaultFullName(String itemName, XWikiContext
context);
-
- /**
- * Get item name extracted from document full name.
- *
- * @param docFullName Full name of the document.
- * @param context Context.
- *
- * @return String Item Name.
- */
- public String getItemDefaultName(String docFullName, XWikiContext context);
-
- /**
- * Get document by full name for item name <code>itemName</code>.
- *
- * @param itemName Full name of the item.
- * @param context Context.
- *
- * @return String Full name of the document.
- *
- * @throws XWikiException
- */
- XWikiDocument getItemDocument(String itemName, XWikiContext context)
throws XWikiException;
-
- /**
- * Search in instances of this document class.
- * @param fieldName Name of field.
- * @param fieldValue Value of field.
- * @param fieldType Type of field.
- * @param context Context.
- *
- * @return List List of found XWikiDocuments.
- *
- * @throws XWikiException
- */
- List searchItemDocumentsByField(String fieldName, String fieldValue,
String fieldType, XWikiContext context) throws XWikiException;
-
- /**
- * Search in instances of this document class.
- *
- * @param docFullName Full name of the document. If Null, it is not
consider.
- * @param fieldDescriptors List of fields name/value constraints.
- * @param context Context.
- *
- * @return List List of found XWikiDocuments.
- *
- * @throws XWikiException
- */
- List searchItemDocumentsByFields(String docFullName, String[][]
fieldDescriptors, XWikiContext context) throws XWikiException;
-
- /**
- * Create new super document.
- *
- * @param doc Document to encapsulate.
- * @param context Context.
- *
- * @return ISuperDocument Super document.
- *
- * @throws XWikiException
- */
- ISuperDocument newSuperDocument(XWikiDocument doc, XWikiContext context)
throws XWikiException;
-
- /**
- * Create new empty super document.
- *
- * @param context Context.
- *
- * @return ISuperDocument Super document.
- *
- * @throws XWikiException
- */
- ISuperDocument newSuperDocument(XWikiContext context) throws
XWikiException;
-
- /**
- * Create new super document.
- *
- * @param docFullName Full name of document to encapsulate.
- * @param context Context.
- *
- * @return ISuperDocument Super document.
- *
- * @throws XWikiException
- */
- ISuperDocument newSuperDocument(String docFullName, XWikiContext context)
throws XWikiException;
-}
Deleted:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperDocument.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperDocument.java
2007-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperDocument.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -1,67 +0,0 @@
-/*
- * Copyright 2006-2007, XpertNet SARL, and individual contributors.
- *
- * This is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * This software is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this software; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
- */
-
-package com.xpn.xwiki.doc.objects.classes;
-
-import com.xpn.xwiki.XWikiContext;
-import com.xpn.xwiki.XWikiException;
-import com.xpn.xwiki.doc.XWikiDocument;
-
-/**
- * SuperDocument inteface.
- */
-public interface ISuperDocument
-{
- /**
- * Reload document.
- *
- * @param context Context.
- *
- * @throws XWikiException
- */
- void reload(XWikiContext context) throws XWikiException;
-
- /**
- * Merge two documents BaseObject.
- *
- * @param sdoc Document to merge.
- */
- void mergeBaseObject(ISuperDocument sdoc);
-
- /**
- * Return super class.
- *
- * @return ISuperClass Class manager for this document.
- */
- ISuperClass getSuperClass();
-
- /**
- * Indicate if document already exists in database.
- *
- * @return boolean True if this is a new document of this class (this
document can exist but not for this class).
- */
- boolean isNew();
-
- /**
- * Return the document.
- *
- * @return XWikiDocument The document.
- */
- XWikiDocument getDocument();
-}
Copied:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/SuperClass.java
(from rev 4872,
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperClass.java)
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperClass.java
2007-09-12 08:11:31 UTC (rev 4872)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/SuperClass.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -0,0 +1,273 @@
+/*
+ * Copyright 2006-2007, XpertNet SARL, and individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+package com.xpn.xwiki.doc.objects.classes;
+
+import java.util.List;
+
+import com.xpn.xwiki.XWikiContext;
+import com.xpn.xwiki.XWikiException;
+import com.xpn.xwiki.doc.XWikiDocument;
+import com.xpn.xwiki.objects.classes.BaseClass;
+
+public interface SuperClass
+{
+ /**
+ * Default class document suffix.
+ */
+ static final String XWIKI_CLASS_SUFFIX = "Class";
+
+ /**
+ * Default class sheet document suffix.
+ */
+ static final String XWIKI_CLASSSHEET_SUFFIX = "ClassSheet";
+
+ /**
+ * Default class template document suffix.
+ */
+ static final String XWIKI_CLASSTEMPLATE_SUFFIX = "ClassTemplate";
+
+ /**
+ * Default class document space.
+ */
+ static final String XWIKI_CLASS_SPACE_PREFIX = "XWiki";
+
+ /**
+ * Default class document space.
+ */
+ static final String XWIKI_CLASS_SPACE_SUFFIX = "Classes";
+
+ /**
+ * Default class document space.
+ */
+ static final String XWIKI_CLASSSHEET_SPACE_SUFFIX = "Sheets";
+
+ /**
+ * Default class document space.
+ */
+ static final String XWIKI_CLASSTEMPLATE_SPACE_SUFFIX = "Templates";
+
+ // ///
+
+ /**
+ * @return String Space prefix of class document.
+ */
+ String getClassSpacePrefix();
+
+ /**
+ * @return String Space of class document.
+ */
+ String getClassSpace();
+
+ /**
+ * @return String Prefix of class document.
+ */
+ String getClassPrefix();
+
+ /**
+ * @return String Name of class document.
+ */
+ String getClassName();
+
+ /**
+ * @return String Full name of class document.
+ */
+ String getClassFullName();
+
+ /**
+ * @return String Name of class template document.
+ */
+ String getClassTemplateName();
+
+ /**
+ * @return String Full name of class template document.
+ */
+ String getClassTemplateFullName();
+
+ /**
+ * @return String Name of class sheet document.
+ */
+ String getClassSheetName();
+
+ /**
+ * @return String Full name of class sheet document.
+ */
+ String getClassSheetFullName();
+
+ /**
+ * @return BaseClass BaseClass object managed.
+ */
+ BaseClass getBaseClass() throws XWikiException;
+
+ /**
+ * Return super class document for this context.
+ *
+ * @param context Context.
+ *
+ * @return XWikiDocument Class document for this context.
+ */
+ XWikiDocument getClassDocument(XWikiContext context) throws XWikiException;
+
+ /**
+ * Return super class sheet document content.
+ *
+ * @return String Default new class sheet document content.
+ */
+ String getClassSheetDefaultContent();
+
+ /**
+ * Return super class sheet document for this context.
+ *
+ * @param context Context.
+ *
+ * @return XWikiDocument Class sheet document for this context.
+ */
+ XWikiDocument getClassSheetDocument(XWikiContext context) throws
XWikiException;
+
+ /**
+ * Return super class template document content.
+ *
+ * @return String Default new class template document content.
+ */
+ String getClassTemplateDefaultContent();
+
+ /**
+ * Return super class template document for this context.
+ *
+ * @param context Context.
+ *
+ * @return XWikiDocument Class template document for this context.
+ */
+ XWikiDocument getClassTemplateDocument(XWikiContext context) throws
XWikiException;
+
+ /**
+ * Determines if the specified <code>doc</code> is compatible with this
xwiki class (if he contains class object).
+ *
+ * @param doc XWikidocument to test.
+ * @param context Context.
+ *
+ * @return boolean True if <code>doc</code> support this class.
+ *
+ * @throws XWikiException
+ */
+ boolean isInstance(XWikiDocument doc, XWikiContext context) throws
XWikiException;
+
+ /**
+ * Get document name for item name <code>item</code>.
+ *
+ * @param itemName Name of the item.
+ * @param context Context.
+ *
+ * @return String Name of the document.
+ */
+ String getItemDocumentDefaultName(String itemName, XWikiContext context);
+
+ /**
+ * Get document full name for item name <code>itemName</code>.
+ *
+ * @param itemName Full name of the item.
+ * @param context Context.
+ *
+ * @return String Full name of the document.
+ */
+ String getItemDocumentDefaultFullName(String itemName, XWikiContext
context);
+
+ /**
+ * Get item name extracted from document full name.
+ *
+ * @param docFullName Full name of the document.
+ * @param context Context.
+ *
+ * @return String Item Name.
+ */
+ public String getItemDefaultName(String docFullName, XWikiContext context);
+
+ /**
+ * Get document by full name for item name <code>itemName</code>.
+ *
+ * @param itemName Full name of the item.
+ * @param context Context.
+ *
+ * @return String Full name of the document.
+ *
+ * @throws XWikiException
+ */
+ XWikiDocument getItemDocument(String itemName, XWikiContext context)
throws XWikiException;
+
+ /**
+ * Search in instances of this document class.
+ * @param fieldName Name of field.
+ * @param fieldValue Value of field.
+ * @param fieldType Type of field.
+ * @param context Context.
+ *
+ * @return List List of found XWikiDocuments.
+ *
+ * @throws XWikiException
+ */
+ List searchItemDocumentsByField(String fieldName, String fieldValue,
String fieldType, XWikiContext context) throws XWikiException;
+
+ /**
+ * Search in instances of this document class.
+ *
+ * @param docFullName Full name of the document. If Null, it is not
consider.
+ * @param fieldDescriptors List of fields name/value constraints.
+ * @param context Context.
+ *
+ * @return List List of found XWikiDocuments.
+ *
+ * @throws XWikiException
+ */
+ List searchItemDocumentsByFields(String docFullName, String[][]
fieldDescriptors, XWikiContext context) throws XWikiException;
+
+ /**
+ * Create new super document.
+ *
+ * @param doc Document to encapsulate.
+ * @param context Context.
+ *
+ * @return SuperDocument Super document.
+ *
+ * @throws XWikiException
+ */
+ SuperDocument newSuperDocument(XWikiDocument doc, XWikiContext context)
throws XWikiException;
+
+ /**
+ * Create new empty super document.
+ *
+ * @param context Context.
+ *
+ * @return SuperDocument Super document.
+ *
+ * @throws XWikiException
+ */
+ SuperDocument newSuperDocument(XWikiContext context) throws XWikiException;
+
+ /**
+ * Create new super document.
+ *
+ * @param docFullName Full name of document to encapsulate.
+ * @param context Context.
+ *
+ * @return SuperDocument Super document.
+ *
+ * @throws XWikiException
+ */
+ SuperDocument newSuperDocument(String docFullName, XWikiContext context)
throws XWikiException;
+}
Copied:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/SuperDocument.java
(from rev 4872,
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperDocument.java)
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/ISuperDocument.java
2007-09-12 08:11:31 UTC (rev 4872)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/doc/objects/classes/SuperDocument.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -0,0 +1,67 @@
+/*
+ * Copyright 2006-2007, XpertNet SARL, and individual contributors.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+package com.xpn.xwiki.doc.objects.classes;
+
+import com.xpn.xwiki.XWikiContext;
+import com.xpn.xwiki.XWikiException;
+import com.xpn.xwiki.doc.XWikiDocument;
+
+/**
+ * SuperDocument inteface.
+ */
+public interface SuperDocument
+{
+ /**
+ * Reload document.
+ *
+ * @param context Context.
+ *
+ * @throws XWikiException
+ */
+ void reload(XWikiContext context) throws XWikiException;
+
+ /**
+ * Merge two documents BaseObject.
+ *
+ * @param sdoc Document to merge.
+ */
+ void mergeBaseObject(SuperDocument sdoc);
+
+ /**
+ * Return super class.
+ *
+ * @return SuperClass Class manager for this document.
+ */
+ SuperClass getSuperClass();
+
+ /**
+ * Indicate if document already exists in database.
+ *
+ * @return boolean True if this is a new document of this class (this
document can exist but not for this class).
+ */
+ boolean isNew();
+
+ /**
+ * Return the document.
+ *
+ * @return XWikiDocument The document.
+ */
+ XWikiDocument getDocument();
+}
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-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/main/java/com/xpn/xwiki/plugin/applicationmanager/doc/XWikiApplicationClass.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -26,7 +26,7 @@
import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.doc.XWikiDocument;
import com.xpn.xwiki.doc.objects.classes.AbstractSuperClass;
-import com.xpn.xwiki.doc.objects.classes.ISuperDocument;
+import com.xpn.xwiki.doc.objects.classes.SuperDocument;
import com.xpn.xwiki.objects.classes.StaticListClass;
import com.xpn.xwiki.objects.StringProperty;
import com.xpn.xwiki.objects.classes.BaseClass;
@@ -251,8 +251,8 @@
return
(XWikiApplication)newSuperDocument(getApplicationDocument(appName, context,
validate), context);
}
- public ISuperDocument newSuperDocument(XWikiDocument doc, XWikiContext
context)
+ public SuperDocument newSuperDocument(XWikiDocument doc, XWikiContext
context)
{
- return
(ISuperDocument)doc.newDocument(XWikiApplication.class.getName(), context);
+ return
(SuperDocument)doc.newDocument(XWikiApplication.class.getName(), context);
}
}
Modified:
xwiki-platform/xwiki-plugins/trunk/application-manager/src/test/java/com/xpn/xwiki/doc/objects/classes/TestAbstractSuperClassTest.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/application-manager/src/test/java/com/xpn/xwiki/doc/objects/classes/TestAbstractSuperClassTest.java
2007-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/application-manager/src/test/java/com/xpn/xwiki/doc/objects/classes/TestAbstractSuperClassTest.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -116,15 +116,21 @@
private static final String CLASS_SPACE_PREFIX = "Space";
private static final String CLASS_PREFIX = "Prefix";
- private static final String CLASS_NAME = CLASS_PREFIX +
ISuperClass.XWIKI_CLASS_SUFFIX;
- private static final String CLASSSHEET_NAME = CLASS_PREFIX +
ISuperClass.XWIKI_CLASSSHEET_SUFFIX;
- private static final String CLASSTEMPLATE_NAME = CLASS_PREFIX +
ISuperClass.XWIKI_CLASSTEMPLATE_SUFFIX;
+ private static final String CLASS_NAME = CLASS_PREFIX +
com.xpn.xwiki.doc.objects.classes.SuperClass
+ .XWIKI_CLASS_SUFFIX;
+ private static final String CLASSSHEET_NAME = CLASS_PREFIX +
com.xpn.xwiki.doc.objects.classes.SuperClass
+ .XWIKI_CLASSSHEET_SUFFIX;
+ private static final String CLASSTEMPLATE_NAME = CLASS_PREFIX +
com.xpn.xwiki.doc.objects.classes.SuperClass
+ .XWIKI_CLASSTEMPLATE_SUFFIX;
- private static final String DISPATCH_CLASS_SPACE = CLASS_SPACE_PREFIX +
ISuperClass.XWIKI_CLASS_SPACE_SUFFIX;
+ private static final String DISPATCH_CLASS_SPACE = CLASS_SPACE_PREFIX +
com.xpn.xwiki.doc.objects.classes.SuperClass
+ .XWIKI_CLASS_SPACE_SUFFIX;
private static final String DISPATCH_CLASS_FULLNAME = DISPATCH_CLASS_SPACE
+ "." + CLASS_NAME;
- private static final String DISPATCH_CLASSSHEET_SPACE = CLASS_SPACE_PREFIX
+ ISuperClass.XWIKI_CLASSSHEET_SPACE_SUFFIX;
+ private static final String DISPATCH_CLASSSHEET_SPACE = CLASS_SPACE_PREFIX
+ com.xpn.xwiki.doc.objects.classes.SuperClass
+ .XWIKI_CLASSSHEET_SPACE_SUFFIX;
private static final String DISPATCH_CLASSSHEET_FULLNAME =
DISPATCH_CLASSSHEET_SPACE + "." + CLASSSHEET_NAME;
- private static final String DISPATCH_CLASSTEMPLATE_SPACE =
CLASS_SPACE_PREFIX + ISuperClass.XWIKI_CLASSTEMPLATE_SPACE_SUFFIX;
+ private static final String DISPATCH_CLASSTEMPLATE_SPACE =
CLASS_SPACE_PREFIX + com.xpn.xwiki.doc.objects.classes.SuperClass
+ .XWIKI_CLASSTEMPLATE_SPACE_SUFFIX;
private static final String DISPATCH_CLASSTEMPLATE_FULLNAME =
DISPATCH_CLASSTEMPLATE_SPACE + "." + CLASSTEMPLATE_NAME;
private static final String NODISPATCH_CLASS_SPACE = CLASS_SPACE_PREFIX;
Modified:
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServer.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServer.java
2007-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServer.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -16,7 +16,6 @@
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
-
package com.xpn.xwiki.plugin.multiwiki.doc;
import org.apache.commons.logging.Log;
@@ -31,9 +30,6 @@
{
protected static final Log LOG = LogFactory.getLog(XWikiServer.class);
- // ///////////////////////////////////////////////////////////////////
- // object section
-
public XWikiServer(XWikiDocument xdoc, XWikiContext context) throws
XWikiException
{
super(XWikiServerClass.getInstance(context), xdoc, context);
@@ -42,22 +38,8 @@
public void delete() throws XWikiException
{
super.delete(context);
-
- /*XWiki xwiki = context.getWiki();
-
- try {
- // delete database
- xwiki.getStore().deleteWiki(getWikiName(), context);
- } catch (XWikiException e) {
- if (LOG.isWarnEnabled()) {
- LOG.warn("Wiki delete \"" + getWikiName()
- + "\" failed: wiki database delete threw exception", e);
- }
- }*/
}
- // ///
-
public String getWikiName()
{
return sclass.getItemDefaultName(getFullName(), context);
@@ -128,12 +110,9 @@
setStringValue(XWikiServerClass.FIELD_state, state);
}
- // ///
-
- /*
- * (non-Javadoc)
- *
- * @see java.lang.Object#toString()
+ /**
+ * [EMAIL PROTECTED]
+ * @see Object#toString()
*/
public String toString()
{
Modified:
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServerClass.java
===================================================================
---
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServerClass.java
2007-09-12 13:28:47 UTC (rev 4878)
+++
xwiki-platform/xwiki-plugins/trunk/multiwiki/src/main/java/com/xpn/xwiki/plugin/multiwiki/doc/XWikiServerClass.java
2007-09-12 15:43:32 UTC (rev 4879)
@@ -23,7 +23,7 @@
import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.doc.XWikiDocument;
import com.xpn.xwiki.doc.objects.classes.AbstractSuperClass;
-import com.xpn.xwiki.doc.objects.classes.ISuperDocument;
+import com.xpn.xwiki.doc.objects.classes.SuperDocument;
import com.xpn.xwiki.objects.classes.BaseClass;
import com.xpn.xwiki.objects.classes.UsersClass;
import com.xpn.xwiki.plugin.multiwiki.WikiManagerException;
@@ -216,8 +216,8 @@
context);
}
- public ISuperDocument newSuperDocument(XWikiDocument doc, XWikiContext
context)
+ public SuperDocument newSuperDocument(XWikiDocument doc, XWikiContext
context)
{
- return (ISuperDocument)doc.newDocument(XWikiServer.class.getName(),
context);
+ return (SuperDocument)doc.newDocument(XWikiServer.class.getName(),
context);
}
}
_______________________________________________
notifications mailing list
[email protected]
http://lists.xwiki.org/mailman/listinfo/notifications
