You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@taverna.apache.org by st...@apache.org on 2016/08/21 12:59:35 UTC

[18/50] [abbrv] incubator-taverna-common-activities git commit: javadocs

javadocs


Project: http://git-wip-us.apache.org/repos/asf/incubator-taverna-common-activities/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-taverna-common-activities/commit/4e8f8d09
Tree: http://git-wip-us.apache.org/repos/asf/incubator-taverna-common-activities/tree/4e8f8d09
Diff: http://git-wip-us.apache.org/repos/asf/incubator-taverna-common-activities/diff/4e8f8d09

Branch: refs/heads/cwl-browse
Commit: 4e8f8d0938ce74d987bc1ed28aefde288ba658ac
Parents: 8d05379
Author: ThilinaManamgoda <ma...@gmail.com>
Authored: Sun Jul 17 02:54:53 2016 +0530
Committer: ThilinaManamgoda <ma...@gmail.com>
Committed: Sun Jul 17 02:54:53 2016 +0530

----------------------------------------------------------------------
 .../taverna/cwl/ui/view/CwlContextualView.java  | 79 ++++++++++++--------
 1 file changed, 49 insertions(+), 30 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-taverna-common-activities/blob/4e8f8d09/taverna-cwl-activity-ui/src/main/java/org/apache/taverna/cwl/ui/view/CwlContextualView.java
----------------------------------------------------------------------
diff --git a/taverna-cwl-activity-ui/src/main/java/org/apache/taverna/cwl/ui/view/CwlContextualView.java b/taverna-cwl-activity-ui/src/main/java/org/apache/taverna/cwl/ui/view/CwlContextualView.java
index 87abca1..5b8cfaa 100644
--- a/taverna-cwl-activity-ui/src/main/java/org/apache/taverna/cwl/ui/view/CwlContextualView.java
+++ b/taverna-cwl-activity-ui/src/main/java/org/apache/taverna/cwl/ui/view/CwlContextualView.java
@@ -112,35 +112,41 @@ public class CwlContextualView extends HTMLBasedActivityContextualView {
 		return null;
 	}
 
-	// format long description using html <p> tags
-	private String paragraphToHtml(String summery, String paragraph) {
+	/**
+	 * This method creates HTML representation of the String paragraph
+	 * @param summary
+	 * @param paragraph
+	 * @return
+	 */
+	private String paragraphToHtml(String summary, String paragraph) {
 
-		summery += "<tr><td colspan='2' align='left'>";
+		summary += "<tr><td colspan='2' align='left'>";
 		paragraph = formatParagraph(paragraph);
 		for (String line : paragraph.split("[\n|\r]"))
-			summery += "<p>" + line + "</p>";
+			summary += "<p>" + line + "</p>";
 
-		summery += "</td></tr>";
+		summary += "</td></tr>";
 
-		return summery;
+		return summary;
 	}
 
 	@Override
 	protected String getRawTableRowsHtml() {
-		String summery = "<table border=\"" + TABLE_BORDER + "\" style=\"width:" + TABLE_WIDTH + "\" cellpadding=\"" + TABLE_CELL_PADDING + "\" >";
+		String summary = "<table border=\"" + TABLE_BORDER + "\" style=\"width:" + TABLE_WIDTH + "\" cellpadding=\"" + TABLE_CELL_PADDING + "\" >";
 
 		String description = "";
-
+		//Get the CWL tooll Description
 		if (CwlMap.has(DESCRIPTION)) {
 			description = CwlMap.get(DESCRIPTION).asText();
-			summery = paragraphToHtml(summery, description);
+			summary = paragraphToHtml(summary, description);
 
 		}
+		//Get the CWL tool Label
 		if (CwlMap.has(LABEL)) {
-			summery += "<tr><th colspan='2' align='left'>Label</th></tr>";
-			summery += "<tr><td colspan='2' align='left'>" + CwlMap.get(LABEL).asText() + "</td></tr>";
+			summary += "<tr><th colspan='2' align='left'>Label</th></tr>";
+			summary += "<tr><td colspan='2' align='left'>" + CwlMap.get(LABEL).asText() + "</td></tr>";
 		}
-		summery += "<tr><th colspan='2' align='left'>Inputs</th></tr>";
+		summary += "<tr><th colspan='2' align='left'>Inputs</th></tr>";
 
 		Map<String, PortDetail> inputs = cwlutil.processInputDetails();
 		Map<String, Integer> inputDepths = cwlutil.processInputDepths();
@@ -149,10 +155,10 @@ public class CwlContextualView extends HTMLBasedActivityContextualView {
 			for (String id : inputs.keySet()) {
 				PortDetail detail = inputs.get(id);
 				if (inputDepths.containsKey(id))
-					summery = extractSummery(summery, id, detail, inputDepths.get(id));
+					summary = extractSummary(summary, id, detail, inputDepths.get(id));
 			}
 
-		summery += "<tr><th colspan='2' align='left'>Outputs</th></tr>";
+		summary += "<tr><th colspan='2' align='left'>Outputs</th></tr>";
 
 		Map<String, PortDetail> outPuts = cwlutil.processOutputDetails();
 		Map<String, Integer> outputDepths = cwlutil.processOutputDepths();
@@ -161,42 +167,55 @@ public class CwlContextualView extends HTMLBasedActivityContextualView {
 			for (String id : outPuts.keySet()) {
 				PortDetail detail = outPuts.get(id);
 				if (outputDepths.containsKey(id))
-					summery = extractSummery(summery, id, detail, outputDepths.get(id));
+					summary = extractSummary(summary, id, detail, outputDepths.get(id));
 			}
-		summery += "</table>";
-		return summery;
+		summary += "</table>";
+		return summary;
 	}
-
-	private String extractSummery(String summery, String id, PortDetail detail, int depth) {
-		summery += "<tr align='left'><td> ID: " + id + " </td><td>Depth: " + depth + "</td></tr>";
+/**
+ * This method creates the HTML tags and details of each input/output for service detail panel
+ * 
+ * @param summary current String summary
+ * @param id input/output Id
+ * @param detail PortDetail object of the input/output
+ * @param depth depth of the input/output
+ * @return
+ */
+	private String extractSummary(String summary, String id, PortDetail detail, int depth) {
+		summary += "<tr align='left'><td> ID: " + id + " </td><td>Depth: " + depth + "</td></tr>";
 		if (detail.getLabel() != null) {
-			summery += "<tr><td  align ='left' colspan ='2'>Label: " + detail.getLabel() + "</td></tr>";
+			summary += "<tr><td  align ='left' colspan ='2'>Label: " + detail.getLabel() + "</td></tr>";
 		}
 		if (detail.getDescription() != null) {
 
-			summery = paragraphToHtml(summery, detail.getDescription());
+			summary = paragraphToHtml(summary, detail.getDescription());
 
 		}
 		if (detail.getFormat() != null) {
-			summery += "<tr><td  align ='left' colspan ='2'>Format: ";
+			summary += "<tr><td  align ='left' colspan ='2'>Format: ";
 			ArrayList<String> formats = detail.getFormat();
 
 			int Size = formats.size();
 
 			if (Size == 1) {
-				summery += formats.get(0);
+				summary += formats.get(0);
 			} else {
 				for (int i = 0; i < (Size - 1); i++) {
-					summery += formats.get(i) + ", ";
+					summary += formats.get(i) + ", ";
 				}
-				summery += formats.get(Size - 1);
+				summary += formats.get(Size - 1);
 			}
-			summery += "</td></tr>";
+			summary += "</td></tr>";
 		}
-		summery += "<tr></tr>";
-		return summery;
+		summary += "<tr></tr>";
+		return summary;
 	}
-
+/**
+ * This method makes max length of a line in the paragraph into MAX_LINE_LENG.
+ * But if the line not contains a single space it's not going to be as it's.
+ * @param paragraph paragraph to be formated 
+ * @return
+ */
 	private String formatParagraph(String paragraph) {
 		String result = "";
 		for (String line : paragraph.split(LINE_BREAK)) {