From: <jbo...@li...> - 2006-01-07 18:39:54
|
Author: wrzep Date: 2006-01-07 13:39:27 -0500 (Sat, 07 Jan 2006) New Revision: 2019 Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByNameComparator.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByScoreComparator.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusDescriptor.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusNodeWatcher.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusPortlet.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTags.java trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTools.java Log: comments, cleanup http://jira.jboss.com/jira/browse/JBLAB-415 Pawel Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByNameComparator.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByNameComparator.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByNameComparator.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -27,9 +27,8 @@ import org.jboss.forge.common.projects.Projects; /** - * * @author Pawel Wrzeszcz - * + * Implements alphabetical projects order by name. */ public class ProjectsByNameComparator implements Comparator<String> { Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByScoreComparator.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByScoreComparator.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/ProjectsByScoreComparator.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -27,15 +27,17 @@ import org.jboss.forge.status.plugins.Plugin; /** - * * @author Pawel Wrzeszcz - * + * Implements projects order by score. */ public class ProjectsByScoreComparator implements Comparator<String> { private Plugin orderPlugin; + /** + * @param orderPlugin Plugin determining projects order + */ public ProjectsByScoreComparator(Plugin orderPlugin) { this.orderPlugin = orderPlugin; } Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -22,13 +22,13 @@ package org.jboss.forge.status; +import java.util.HashMap; import java.util.Map; import java.util.Set; import org.jboss.forge.common.projects.Projects; import org.jboss.forge.common.projects.ProjectsHelper; - import org.jboss.forge.common.XmlTools; import org.jboss.forge.common.projects.AbstractDescriptor; import org.jboss.forge.common.projects.permissions.NullPermissionsChecker; @@ -37,7 +37,6 @@ import org.w3c.dom.Node; - /** * @author Pawel Wrzeszcz * A class which handles Status Matrix information managment. @@ -50,14 +49,21 @@ /** Columns to display on the main page */ private Columns mainPageColumns; - /* Columns to display on the project specyfic page */ + /** Columns to display on the project specyfic page */ private Columns projectPageColumns; /** Plugins used in the Status Matrix */ private Plugins plugins; + /** Projects present in the Status Matrix */ private Projects projects; + /** + * @param portalName portal name + * @param statusRoot Node with Matrix properites + * @param statusPluginsRoot Node defining StatusPlugins used in the Matrix + * @param scorePluginsRoot Node defining ScorePlugins used in the Matrix + */ Status(String portalName, Node statusRoot, Node statusPluginsRoot, Node scorePluginsRoot) { // Get the projects @@ -85,8 +91,13 @@ mainPageColumns.fillContext(context); } - public void fillProjectContexts(Map<String,DelegateContext> contextsMap) { + /** + * @return Map binding project ids with DelegateContexts containing project information + */ + public Map<String, DelegateContext> getProjectContexts() { + Map<String,DelegateContext> contextsMap = new HashMap<String,DelegateContext>(); + Set<String> projectIdsSet = projects.getProjectIds( (PermissionsChecker) new NullPermissionsChecker(), null); @@ -97,5 +108,7 @@ contextsMap.put(projectId, context); } + + return contextsMap; } } \ No newline at end of file Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusDescriptor.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusDescriptor.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusDescriptor.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -22,19 +22,20 @@ package org.jboss.forge.status; +import java.util.Map; import java.io.IOException; -import java.util.HashMap; -import java.util.Map; -import org.apache.xerces.parsers.DOMParser; import org.jboss.portal.common.context.DelegateContext; import org.jboss.shotoku.ContentManager; import org.jboss.shotoku.exceptions.ResourceDoesNotExist; import org.w3c.dom.Node; + import org.xml.sax.InputSource; import org.xml.sax.SAXException; +import org.apache.xerces.parsers.DOMParser; + /** * @author Pawel Wrzeszcz * A class which handles xml parsing and accessing parsed feeds information. @@ -72,8 +73,7 @@ context = new DelegateContext(); status.fillContext(context); - projectContexts = new HashMap<String,DelegateContext>(); - status.fillProjectContexts(projectContexts); + projectContexts = status.getProjectContexts(); } public DelegateContext getContext() { Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusNodeWatcher.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusNodeWatcher.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusNodeWatcher.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -25,6 +25,7 @@ import org.jboss.forge.common.service.NodeWatcher; import org.jboss.forge.common.service.ResourceWatcher; + import org.jboss.shotoku.ContentManager; public class StatusNodeWatcher implements NodeWatcher { Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusPortlet.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusPortlet.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusPortlet.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -43,6 +43,7 @@ private static final String PROJECT_DETAILS_ACTION = "viewProjectDetails"; + @Override public void doView(JBossRenderRequest request, JBossRenderResponse response) throws IOException, PortletException { response.setContentType("text/html"); Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTags.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTags.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTags.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -24,7 +24,7 @@ /** * @author Pawel Wrzeszcz -* A class which handles Status Matrix information managment. +* Status Matrix xml tags. */ public class StatusTags { Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTools.java =================================================================== --- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTools.java 2006-01-07 18:07:55 UTC (rev 2018) +++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/StatusTools.java 2006-01-07 18:39:27 UTC (rev 2019) @@ -37,22 +37,37 @@ @Inject private static ContentManager cm; + /** + * Path to the xml file with the Status Matrix properties. + */ public static String getXmlCmPath(String portalName) { return portalName + "/" + STATUS_DIR + "/" + STATUS_XML; } + /** + * Path to the xml file defining StatusPlugins used in the Matrix. + */ public static String getXmlStatusPluginsCmPath(String portalName) { return portalName + "/" + STATUS_DIR + "/" + STATUS_PLUGINS_XML; } + /** + * Path to the xml file defining ScorePlugins used in the Matrix. + */ public static String getXmlScorePluginsCmPath(String portalName) { return portalName + "/" + STATUS_DIR + "/" + SCORE_PLUGINS_XML; } + /** + * Path to the projects.xml file. + */ public static String getProjectsXmlPath(String portalName) { return portalName + "/" + ProjectsHelper.PROJECTS_DESC; } + /** + * Set containing paths to project.xml files for all projects. + */ public static Set<String> getProjectXmlPathsSet(String portalName) { Set<String> pathsSet = new HashSet<String>(); @@ -71,12 +86,15 @@ } /** - * Path to the file displaying the Status Matrix + * Path to the jsp file responsible file displaying the Status Matrix. */ public static String getJspCmPath() { return STATUS_JSP_DIR + "/" + STATUS_JSP; } + /** + * Path to the jsp file responsible file displaying project details. + */ public static String getDetailsJspCmPath() { return STATUS_JSP_DIR + "/" + PROJECT_DETAILS_JSP; } |