Portal: Code formatiert, Dokumentation hinzugefügt.

git-svn-id: https://svn.libreccm.org/ccm/trunk@333 8810af33-2d31-482b-a856-94f89814c4df

ccm-ldn-portal/src/com/arsdigita/london/portal/portlet/ApplicationDirectoryPortlet.java

@@ -20,8 +20,12 @@ import com.arsdigita.london.portal.ui.portlet.ApplicationDirectoryPortletRendere
 import com.arsdigita.persistence.DataObject;
 import com.arsdigita.portal.Portlet;
 
+/**
+ * ApplicationDirectoryPortlet
+ *
+ * @version $Id: ApplicationDirectoryPortlet.java 1174 2006-06-14 14:14:15Z fabrice $ 
+ */
 public class ApplicationDirectoryPortlet extends Portlet {
-    public static final String versionId = "$Id: ApplicationDirectoryPortlet.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2003/08/08 05:59:54 $";
 
 	public static final String BASE_DATA_OBJECT_TYPE = "com.arsdigita.london.portal.portlet.ApplicationDirectoryPortlet";
 

ccm-ldn-portal/src/com/arsdigita/london/portal/portlet/FreeformHTMLPortlet.java

@@ -20,8 +20,12 @@ import com.arsdigita.london.portal.ui.portlet.FreeformHTMLPortletRenderer;
 import com.arsdigita.persistence.DataObject;
 import com.arsdigita.portal.Portlet;
 
+/**
+ * FreeformHTMLPortlet.
+ *
+ * @version $Id: FreeformHTMLPortlet.java 1174 2006-06-14 14:14:15Z fabrice $
+ */  
 public class FreeformHTMLPortlet extends Portlet {
-	public static final String versionId = "$Id: FreeformHTMLPortlet.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2003/08/08 05:59:54 $";
 
 	public static final String BASE_DATA_OBJECT_TYPE = "com.arsdigita.london.portal.portlet.FreeformHTMLPortlet";
 

ccm-ldn-portal/src/com/arsdigita/london/portal/portlet/LoginPortlet.java

@@ -20,19 +20,38 @@ import com.arsdigita.london.portal.ui.portlet.LoginPortletRenderer;
 import com.arsdigita.persistence.DataObject;
 import com.arsdigita.portal.Portlet;
 
+/**
+ * 
+ * @version $Id: LoginPortlet.java 1174 2006-06-14 14:14:15Z fabrice $
+ */
 public class LoginPortlet extends Portlet {
-	public static final String versionId = "$Id: LoginPortlet.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2003/08/08 05:59:54 $";
 
-	public static final String BASE_DATA_OBJECT_TYPE = "com.arsdigita.london.portal.portlet.LoginPortlet";
+    public static final String BASE_DATA_OBJECT_TYPE =
+                               "com.arsdigita.london.portal.portlet.LoginPortlet";
 
+    
+    /**
+     * Constructor
+     *
+     * @param dataObject
+     */
     public LoginPortlet(DataObject dataObject) {
         super(dataObject);
     }
 
+    /**
+     * Retrieve Base Data Object Type
+     *
+     * @return String BaseDataObjectType
+     */
     protected String getBaseDataObjectType() {
         return BASE_DATA_OBJECT_TYPE;
     }
 
+    /**
+     * 
+     * @return
+     */
     protected AbstractPortletRenderer doGetPortletRenderer() {
         return new LoginPortletRenderer(this);
     }

ccm-ldn-portal/src/com/arsdigita/london/portal/portlet/RSSFeedPortlet.java

@@ -20,8 +20,12 @@ import com.arsdigita.london.portal.ui.portlet.RSSFeedPortletRenderer;
 import com.arsdigita.persistence.DataObject;
 import com.arsdigita.portal.Portlet;
 
+/** 
+ * RSSFeedPortlet
+ *
+ * @version $Id: RSSFeedPortlet.java 1174 2006-06-14 14:14:15Z fabrice $
+ */ 
 public class RSSFeedPortlet extends Portlet {
-	public static final String versionId = "$Id: RSSFeedPortlet.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2003/08/08 05:59:54 $";
 
 	public static final String BASE_DATA_OBJECT_TYPE = "com.arsdigita.london.portal.portlet.RSSFeedPortlet";
 

ccm-ldn-portal/src/com/arsdigita/london/portal/portlet/TimeOfDayPortlet.java

@@ -20,8 +20,12 @@ import com.arsdigita.london.portal.ui.portlet.TimeOfDayPortletRenderer;
 import com.arsdigita.persistence.DataObject;
 import com.arsdigita.portal.Portlet;
 
+/** 
+ * TimeOfDayPortlet.
+ *
+ * @version $Id: TimeOfDayPortlet.java 1174 2006-06-14 14:14:15Z fabrice $ 
+ */
 public class TimeOfDayPortlet extends Portlet {
-	public static final String versionId = "$Id: TimeOfDayPortlet.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2003/08/08 05:59:54 $";
 
 	public static final String BASE_DATA_OBJECT_TYPE = "com.arsdigita.london.portal.portlet.TimeOfDayPortlet";
 

ccm-ldn-portal/src/com/arsdigita/london/portal/portlet/WorkspaceNavigatorPortlet.java

@@ -29,9 +29,14 @@ import com.arsdigita.portal.apportlet.AppPortlet;
 import com.arsdigita.web.Application;
 import com.arsdigita.xml.Element;
 
+/**
+ * WorkspaceNavigatorPortlet.
+ *
+ * @author dennis (2003/08/15)
+ * @version $Id: //portalserver/dev/src/com/arsdigita/portalserver/WorkspaceNavigatorPortlet.java $
+ */
 public class WorkspaceNavigatorPortlet extends AppPortlet {
 
-    public static final String versionId = "$Id: //portalserver/dev/src/com/arsdigita/portalserver/WorkspaceNavigatorPortlet.java#7 $ by $Author: dennis $, $DateTime: 2003/08/15 13:46:34 $";
 
     public static final String BASE_DATA_OBJECT_TYPE =
         "com.arsdigita.london.portal.portlet.WorkspaceNavigatorPortlet";

ccm-ldn-portal/src/com/arsdigita/london/portal/portlet/WorkspaceSummaryPortlet.java

@@ -34,10 +34,15 @@ import com.arsdigita.web.Application;
 import com.arsdigita.web.URL;
 import com.arsdigita.xml.Element;
 
+/**
+ * WorkspaceSummaryPortlet
+ *
+ *
+ * @author dennis (2003/08/15)
+ * @version $Id: //portalserver/dev/src/com/arsdigita/portalserver/WorkspaceSummaryPortlet.java $
+ */
 public class WorkspaceSummaryPortlet extends AppPortlet {
 
-    public static final String versionId = "$Id: //portalserver/dev/src/com/arsdigita/portalserver/WorkspaceSummaryPortlet.java#7 $ by $Author: dennis $, $DateTime: 2003/08/15 13:46:34 $";
-
     public static final String BASE_DATA_OBJECT_TYPE =
         "com.arsdigita.london.portal.portlet.WorkspaceSummaryPortlet";
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/LayoutForm.java

@@ -49,12 +49,12 @@ import com.arsdigita.util.UncheckedWrapperException;
  * <p>
  * <strong>Experimental</strong>
  * </p>
+ *
+ * @version $Id: LayoutForm.java 1174 2006-06-14 14:14:15Z fabrice $
  */
 public class LayoutForm extends Form implements FormProcessListener,
 		FormInitListener {
 
-	public static final String versionId = "$Id: LayoutForm.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2004/03/02 06:33:42 $";
-
 	private WorkspaceSelectionModel m_workspace;
 
 	private PortalSelectionModel m_portal;

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/ParticipantBrowsePane.java

@@ -45,13 +45,14 @@ import java.util.Iterator;
 
 import org.apache.log4j.Category;
 
+/**
+ * ParticipantBrowsePane.
+ *
+ * @author ashah (2003/08/15)
+ * @version $Id: //portalserver/src/com/arsdigita/portalserver/ui/ParticipantBrowsePane.java#7 $
+ +/
 public class ParticipantBrowsePane {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/ParticipantBrowsePane.java#7 $" +
-        "$Author: ashah $" +
-        "$DateTime: 2003/08/15 15:50:10 $";
-
     private static Category s_log = Category.getInstance
         (ParticipantBrowsePane.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/ParticipantDisplay.java

@@ -27,13 +27,13 @@ import com.arsdigita.london.portal.Workspace;
 
 import org.apache.log4j.Category;
 
+/**
+ * ParticipantDisplay.
+ *
+ * @author dennis (2003/08/15)
+ * @version $Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/PortalParticipants.java#3 $
 public class ParticipantDisplay extends CompoundComponent {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/PortalParticipants.java#3 $" +
-        "$Author: dennis $" +
-        "$DateTime: 2003/08/15 13:46:34 $";
-
     private static Category s_log = Category.getInstance
         (ParticipantDisplay.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/ParticipantEdit.java

@@ -38,17 +38,14 @@ import java.util.Iterator;
 import org.apache.log4j.Category;
 
 /**
+ * ParticipantEdit.
  *
- *
+ * @author ashah (2003/08/15)
  * @author Justin Ross &lt;<a href="mailto:jross@redhat.com">jross@redhat.com</a>&gt;
+ * @version $Id: com/arsdigita/portalserver/ui/ParticipantEdit.java $
  */
 public class ParticipantEdit extends CompoundComponent {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/ParticipantEdit.java#5 $" +
-        "$Author: ashah $" +
-        "$DateTime: 2003/08/15 15:50:10 $";
-
     private static Category s_log = Category.getInstance
         (ParticipantEdit.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/ParticipantListModel.java

@@ -27,13 +27,13 @@ import com.arsdigita.london.portal.Workspace;
 
 import org.apache.log4j.Category;
 
+/**
+ * ParticipantListModel
+ *
+ * @author dennis (2003/08/15)
+ * @version $Id: com/arsdigita/portalserver/ui/PortalParticipants.java $
 public class ParticipantListModel implements ListModel {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/PortalParticipants.java#3 $" +
-        "$Author: dennis $" +
-        "$DateTime: 2003/08/15 13:46:34 $";
-
     private static Category s_log = Category.getInstance
         (ParticipantListModel.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/ParticipantModel.java

@@ -28,13 +28,14 @@ import com.arsdigita.globalization.GlobalizedMessage;
 
 import org.apache.log4j.Category;
 
+/**
+ * ParticipantModel.
+ *
+ * Reimplementation using original arsdigita portalserver code. 
+ * @author dennis (2003/08/15)
+ * @version $Id: com/arsdigita/portalserver/ui/PortalParticipants.java $
 public class ParticipantModel implements PropertySheetModel {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/PortalParticipants.java#3 $" +
-        "$Author: dennis $" +
-        "$DateTime: 2003/08/15 13:46:34 $";
-
     private static Category s_log = Category.getInstance
         (ParticipantModel.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/PersistentPortal.java

@@ -78,7 +78,7 @@ import org.apache.log4j.Logger;
 
 // XXX this class is disgusting
 /**
- * PersitentPortals are able to have more than one column, and the constructor
+ * PersistentPortals are able to have more than one column, and the constructor
  * for PersitentPortal takes in an integer argument for number of columns.
  * 
  * HomepagePortals defined on the jsp page each construct instances of this

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/PersonalPortalPage.java

@@ -1,6 +1,5 @@
 package com.arsdigita.london.portal.ui;
 
-import org.apache.log4j.Logger;
 import com.arsdigita.bebop.Page;
 import com.arsdigita.bebop.event.RequestEvent;
 import com.arsdigita.bebop.event.RequestListener;
@@ -15,6 +14,13 @@ import com.arsdigita.london.portal.Workspace;
 import com.arsdigita.london.portal.util.GlobalizationUtil;
 import com.arsdigita.web.Application;
 
+import org.apache.log4j.Logger;
+
+
+/**
+ * 
+ * @author 
+ */
 public class PersonalPortalPage extends Page {
 
     private static final Logger s_log = Logger
@@ -30,12 +36,17 @@ public class PersonalPortalPage extends Page {
 
     public final static String PERSONAL_PORTAL_PATH = SLASH + URL + SLASH;
 
-	// constructor
+    /**
+     * Constructor
+     */
     public PersonalPortalPage() {
         addRequestListener(new PersonalPortalPageRequestListener());
         lock();
     }
 
+    /**
+     * 
+     */
     private class PersonalPortalPageRequestListener implements RequestListener {
 
         public void pageRequested(RequestEvent e) {
@@ -46,14 +57,13 @@ public class PersonalPortalPage extends Page {
 
             if (party == null) {
                 sUrl = Initializer.getURL(Initializer.LOGIN_PAGE_KEY);
-
             } else {
                 try {
                     user = User.retrieve(party.getOID());
 
                     // try to get the user's workspace first
-					s_log.debug("Attempting to retrieve the personal Workspace for User"
+                    s_log.debug("Attempting to retrieve the personal Workspace " +
-                                + user);
+                                "for User" + user);
                     Workspace personalWorkspace = Workspace
                                                   .retrievePersonalWorkspace(user);
 
@@ -93,8 +103,8 @@ public class PersonalPortalPage extends Page {
 
             // Redirect to the user's portal (or login)
             try {
-				DispatcherHelper.sendRedirect(e.getPageState().getRequest(), e
+                DispatcherHelper.sendRedirect(e.getPageState().getRequest(), 
-						.getPageState().getResponse(), sUrl);
+                                              e.getPageState().getResponse(), sUrl);
             } catch (java.io.IOException ioe) {
                 // this method can't throw an exception in this Interface, so
                 // ignore

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/PortalConstants.java

@@ -24,7 +24,6 @@ package com.arsdigita.london.portal.ui;
  * @version $Id: PortalConstants.java 1174 2006-06-14 14:14:15Z fabrice $
  */
 public class PortalConstants {
-	public static final String versionId = "$Id: PortalConstants.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2002/10/23 08:48:40 $";
 
 	public static final String PORTAL_XML_NS = "http://www.uk.arsdigita.com/portal/1.0";
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/PortalEditForm.java

@@ -34,15 +34,16 @@ import com.arsdigita.london.portal.WorkspacePage;
 import com.arsdigita.util.Assert;
 
 /**
+ * PortalEditForm.
  * <p>
  * <strong>Experimental</strong>
  * </p>
+ * 
+ * @version $Id: PortalEditForm.java 1174 2006-06-14 14:14:15Z fabrice $
  */
 public class PortalEditForm extends Form implements FormProcessListener,
 		FormInitListener {
 
-	public static final String versionId = "$Id: PortalEditForm.java 1174 2006-06-14 14:14:15Z fabrice $ by $Author: fabrice $, $DateTime: 2004/03/02 06:33:42 $";
-
 	private WorkspaceSelectionModel m_workspace;
 
 	private PortalSelectionModel m_portal;

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/admin/CategoryComponent.java

@@ -42,8 +42,12 @@ import com.arsdigita.util.LockableImpl;
 import com.arsdigita.web.Application;
 import com.arsdigita.web.Web;
 
+/** 
+ * CategoryComponent.
+ * 
+ * @version $Id: CategoryComponent.java 1174 2006-06-14 14:14:15Z fabrice $
+ */ 
 public class CategoryComponent extends SimpleContainer {
-	public static final String versionId = "$Id: CategoryComponent.java 1174 2006-06-14 14:14:15Z fabrice $ $Author: fabrice $, $DateTime: 2004/02/27 11:39:08 $";
 
 	private static final Logger s_log = Logger
 			.getLogger(CategoryComponent.class);

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/admin/Grant.java

@@ -25,11 +25,13 @@ import com.arsdigita.kernel.permissions.PrivilegeDescriptor;
 
 import org.apache.log4j.Logger;
 
+/**
+ * Grant.
+ *
+ * Reimplementation using Ardigita portal server code.
+ * @version $Id: //portalserver/dev/src/com/arsdigita/portalserver/permissions/Grant.java#3 $
+ */
 class Grant {
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/permissions/Grant.java#3 $" +
-        "$Author: dennis $" +
-        "$DateTime: 2003/08/15 13:46:34 $";
 
     private static Logger s_log = Logger.getLogger(Grant.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/admin/GrantsTable.java

@@ -42,13 +42,14 @@ import java.util.Iterator;
 
 import org.apache.log4j.Category;
 
+/**
+ * GrantsTable.
+ *
+ * @author dennis (2003/08/15)
+ * @version $Id: //portalserver/dev/src/com/arsdigita/portalserver/permissions/GrantsTable.java#2 $
+ */ 
 abstract class GrantsTable extends Table {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/permissions/GrantsTable.java#2 $" +
-        "$Author: dennis $" +
-        "$DateTime: 2003/08/15 13:46:34 $";
-
     private static Category s_log = Category.getInstance
         (GrantsTable.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/admin/PartyPermissionEdit.java

@@ -31,13 +31,14 @@ import java.util.List;
 
 import org.apache.log4j.Category;
 
+/**
+ * PartyPermissionEdit.
+ *
+ * @author dennis (2003/08/15)
+ * @version $Id: //portalserver/dev/src/com/arsdigita/portalserver/permissions/PartyPermissionEdit.java#2 $
+ */ 
 public class PartyPermissionEdit extends CompoundComponent {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/permissions/PartyPermissionEdit.java#2 $" +
-        "$Author: dennis $" +
-        "$DateTime: 2003/08/15 13:46:34 $";
-
     private static Category s_log = Category.getInstance
         (PartyPermissionEdit.class.getName());
 

ccm-ldn-portal/src/com/arsdigita/london/portal/ui/admin/PeoplePane.java

@@ -77,13 +77,14 @@ import java.util.ArrayList;
 
 import org.apache.log4j.Category;
 
+/**
+ * PeoplePane.
+ *
+ * @author ashah  (2003/08/15)
+ * @version $Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/admin/PeoplePane.java $
+ */ 
 public class PeoplePane extends SimpleContainer {
 
-    public static final String versionId =
-        "$Id: //portalserver/dev/src/com/arsdigita/portalserver/ui/admin/PeoplePane.java#7 $" +
-        "$Author: ashah $" +
-        "$DateTime: 2003/08/15 15:50:10 $";
-
     private static final Category s_log = Category.getInstance
         (PeoplePane.class.getName());