[Jboss-svn-commits] JBL Code SVN: r1845 - trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status

[<jbo...@li...>]

Author: wrzep
Date: 2005-12-18 10:15:02 -0500 (Sun, 18 Dec 2005)
New Revision: 1845

Modified:
   trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Column.java
   trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java
Log:
comments

http://jira.jboss.com/jira/browse/JBLAB-415

Pawel


Modified: trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Column.java
===================================================================
--- trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Column.java	2005-12-18 14:45:47 UTC (rev 1844)
+++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Column.java	2005-12-18 15:15:02 UTC (rev 1845)
@@ -26,22 +26,40 @@
 
 /**
 * @author Pawel Wrzeszcz
+* A class holding column information in the Status Matrix.
 */
 public class Column {
 	
+	/** Column name */
 	String name;
+	
+	/** Plugin used to generate values in project rows */
 	Plugin plugin;
 	
+	/**
+	 * @param name Column name
+	 * @param plugin Plugin to be used to generate values in project rows
+	 */
 	public Column(String name, Plugin plugin) {
 		this.name = name;
 		this.plugin = plugin;
 		System.out.println("Column " + name + " / " + (plugin == null ? "null" : plugin.getId()));
 	}
 
+	/**
+	 * @return Column name
+	 */
 	public String getName() {
 		return name;
 	}
 
+	/**
+	 * Fills the given context with the appropiate Status Matrix cell,
+	 * located in the project row and this column.
+	 * 
+	 * @param projectContext context to fill
+	 * @param projectId id of the project to fill value for
+	 */
 	public void fillProjectContext(DelegateContext projectContext, String projectId) {
 		DelegateContext entryContext = projectContext.next("entry");
 		entryContext.put("value", plugin.getValue(projectId));

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	2005-12-18 14:45:47 UTC (rev 1844)
+++ trunk/forge/portal-extensions/forge-status/src/java/org/jboss/forge/status/Status.java	2005-12-18 15:15:02 UTC (rev 1845)
@@ -22,9 +22,6 @@
 
 package org.jboss.forge.status;
 
-import java.util.Set;
-import java.util.HashSet;
-
 import org.jboss.forge.common.projects.Projects;
 import org.jboss.forge.common.projects.ProjectsHelper;
 
@@ -39,22 +36,27 @@
 
 /**
 * @author Pawel Wrzeszcz
+* A class which handles Status Matrix information managment. 
 */
 public class Status extends AbstractDescriptor {
 	
 	private static final String MAIN_PAGE_COLLUMNS_TAG 		= "main";
-	//private static final String PROJECT_PAGE_COLLUMNS_TAG 	= "project";
+	//private static final String PROJECT_PAGE_COLLUMNS_TAG = "project";
+	//TODO displaying project-specyfic pages
 	
-	private Projects projects;
-	
+	/** Columns to display on the main page */
 	private Columns mainPageColumns;
+							
+	/* Columns to display on the project specyfic page */
+	//private Columns projectPageColumns;					
 	
+	/** Plugins used in the Status Matrix */
 	private Plugins plugins;
 	
 	Status(String portalName, Node statusRoot, Node statusPluginsRoot, Node scorePluginsRoot) {
 		
 		// Get the projects
-		projects = ProjectsHelper.getProjects(portalName);
+		Projects projects = ProjectsHelper.getProjects(portalName);
 		
 		// Get the status plugins
 		NodeList statusPluginsNodes = statusPluginsRoot.getChildNodes();
@@ -70,11 +72,11 @@
 	}
 
 	/**
-	 * Fills the given context with podcast information.
+	 * Fills the given context with the Status Matrix information.
 	 * 
 	 * @param context Context to fill.
 	 */
 	public void fillContext(DelegateContext context) {	
 		mainPageColumns.fillContext(context);
 	}
-}
+}
\ No newline at end of file