[225701,246188] documentation, move non API packages to under internal
diff --git a/plugins/org.eclipse.actf.visualization.blind.html/src/org/eclipse/actf/visualization/blind/html/BlindVisualizerHtml.java b/plugins/org.eclipse.actf.visualization.blind.html/src/org/eclipse/actf/visualization/blind/html/BlindVisualizerHtml.java
index c9afe0d..a5cbd02 100644
--- a/plugins/org.eclipse.actf.visualization.blind.html/src/org/eclipse/actf/visualization/blind/html/BlindVisualizerHtml.java
+++ b/plugins/org.eclipse.actf.visualization.blind.html/src/org/eclipse/actf/visualization/blind/html/BlindVisualizerHtml.java
@@ -33,8 +33,8 @@
import org.eclipse.actf.visualization.engines.blind.html.VisualizeEngine;
import org.eclipse.actf.visualization.engines.blind.html.eval.HtmlErrorLogListener;
import org.eclipse.actf.visualization.engines.blind.html.util.HandleFramePage;
+import org.eclipse.actf.visualization.eval.CheckTargetFactory;
import org.eclipse.actf.visualization.eval.EvaluationUtil;
-import org.eclipse.actf.visualization.eval.HtmlCheckTargetImpl;
import org.eclipse.actf.visualization.eval.IHtmlCheckTarget;
import org.eclipse.actf.visualization.eval.IHtmlChecker;
import org.eclipse.actf.visualization.eval.guideline.GuidelineHolder;
@@ -204,8 +204,8 @@
//
// BrowserAndStyleInfo data =
// webBrowser.getBrowserAndStyleInfo();
- IHtmlCheckTarget checkTarget = new HtmlCheckTargetImpl(document,
- webBrowser.getURL(), null, edu);
+ IHtmlCheckTarget checkTarget = CheckTargetFactory.createHtmlCheckTarget(document, webBrowser.getURL(), null,
+ edu);
for (int i = 0; i < checkers.length; i++) {
if (checkers[i] instanceof IHtmlChecker) {
diff --git a/plugins/org.eclipse.actf.visualization.blind.odfbyhtml/src/org/eclipse/actf/visualization/blind/odfbyhtml/BlindVisualizerOdfByHtml.java b/plugins/org.eclipse.actf.visualization.blind.odfbyhtml/src/org/eclipse/actf/visualization/blind/odfbyhtml/BlindVisualizerOdfByHtml.java
index 0fe3d47..20185ea 100644
--- a/plugins/org.eclipse.actf.visualization.blind.odfbyhtml/src/org/eclipse/actf/visualization/blind/odfbyhtml/BlindVisualizerOdfByHtml.java
+++ b/plugins/org.eclipse.actf.visualization.blind.odfbyhtml/src/org/eclipse/actf/visualization/blind/odfbyhtml/BlindVisualizerOdfByHtml.java
@@ -33,7 +33,7 @@
import org.eclipse.actf.visualization.engines.blind.html.VisualizeEngine;
import org.eclipse.actf.visualization.engines.blind.html.eval.HtmlErrorLogListener;
import org.eclipse.actf.visualization.engines.blind.html.util.VisualizeReportUtil;
-import org.eclipse.actf.visualization.eval.CheckTargetImpl;
+import org.eclipse.actf.visualization.eval.CheckTargetFactory;
import org.eclipse.actf.visualization.eval.EvaluationUtil;
import org.eclipse.actf.visualization.eval.ICheckTarget;
import org.eclipse.actf.visualization.eval.IChecker;
@@ -141,7 +141,7 @@
1024);
Document odfDoc = modelService.getDocument();
- ICheckTarget checkTarget = new CheckTargetImpl(odfDoc, modelService
+ ICheckTarget checkTarget = CheckTargetFactory.createCheckTarget(odfDoc, modelService
.getURL());
checkTarget.setAdditionalDocument("html", document);
IChecker[] checkers = EvaluationUtil.getCheckers();
diff --git a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/CheckTargetFactory.java b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/CheckTargetFactory.java
new file mode 100644
index 0000000..a983779
--- /dev/null
+++ b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/CheckTargetFactory.java
@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright (c) 2008 IBM Corporation and Others
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Kentarou FUKUDA - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.actf.visualization.eval;
+
+import org.eclipse.actf.model.ui.editor.browser.IWebBrowserStyleInfo;
+import org.eclipse.actf.visualization.eval.html.HtmlEvalUtil;
+import org.eclipse.actf.visualization.internal.eval.CheckTargetImpl;
+import org.eclipse.actf.visualization.internal.eval.HtmlCheckTargetImpl;
+import org.w3c.dom.Document;
+
+/**
+ * Factory class for {@link ICheckTarget}
+ */
+public class CheckTargetFactory {
+
+ /**
+ * Constructor of {@link ICheckTarget}
+ *
+ * @param target
+ * evaluation target {@link Document}
+ * @param targetUrl
+ * target URL
+ */
+ public static ICheckTarget createCheckTarget(Document target,
+ String targetUrl) {
+ return new CheckTargetImpl(target, targetUrl);
+ }
+
+ /**
+ * Constructor of {@link IHtmlCheckTarget}
+ *
+ * @param target
+ * target {@link Document}
+ * @param targetUrl
+ * target URL
+ * @param browserStyleInfo
+ * current style information
+ * @param htmlEvalUtil
+ * target {@link HtmlEvalUtil}
+ */
+ public static IHtmlCheckTarget createHtmlCheckTarget(Document target,
+ String targetUrl, IWebBrowserStyleInfo browserStyleInfo,
+ HtmlEvalUtil htmlEvalUtil) {
+ return new HtmlCheckTargetImpl(target, targetUrl, browserStyleInfo,
+ htmlEvalUtil);
+ }
+
+}
diff --git a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/EvaluationResultImpl.java b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/EvaluationResultImpl.java
index 2556d95..24e0371 100644
--- a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/EvaluationResultImpl.java
+++ b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/EvaluationResultImpl.java
@@ -45,6 +45,9 @@
private LineStyleListener lsl = new HighlightStringListener();
+ public EvaluationResultImpl() {
+ }
+
public void setProblemList(List<IProblemItem> problemList) {
if (problemList == null) {
problemList = new ArrayList<IProblemItem>();
diff --git a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/problem/IProblemItem.java b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/problem/IProblemItem.java
index a6eb590..a4a7191 100644
--- a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/problem/IProblemItem.java
+++ b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/problem/IProblemItem.java
@@ -15,84 +15,191 @@
import org.eclipse.swt.graphics.Image;
import org.w3c.dom.Node;
+/**
+ *
+ */
+public interface IProblemItem {// extends IEvaluationItem {
+ /**
+ *
+ */
+ public static final int SEV_ERROR = IEvaluationItem.SEV_ERROR;
-public interface IProblemItem{// extends IEvaluationItem {
+ /**
+ *
+ */
+ public static final int SEV_WARNING = IEvaluationItem.SEV_WARNING;
- public static final int SEV_ERROR = IEvaluationItem.SEV_ERROR;
+ /**
+ *
+ */
+ public static final int SEV_INFO = IEvaluationItem.SEV_INFO;
- public static final int SEV_WARNING = IEvaluationItem.SEV_WARNING;
+ /**
+ * @return
+ */
+ public abstract IEvaluationItem getEvaluationItem();
- public static final int SEV_INFO = IEvaluationItem.SEV_INFO;
-
- public static final String COMMA = ",";
+ /**
+ * @return
+ */
+ public abstract String getDescription();
- public abstract IEvaluationItem getEvaluationItem();
+ /**
+ * @return
+ */
+ public abstract int getSerialNumber();
- public abstract String getDescription();
+ /**
+ * @return
+ */
+ public abstract Node getTargetNode();
- public abstract int getSerialNumber();
+ /**
+ * @return
+ */
+ public abstract String getTargetString();
- public abstract Node getTargetNode();
+ /**
+ * @return
+ */
+ public abstract String getTargetStringForHPB();
- public abstract String getTargetString();
+ /**
+ * @return
+ */
+ public abstract boolean isCanHighlight();
- public abstract String getTargetStringForHPB();
+ /**
+ * @param canHighlight
+ */
+ public abstract void setCanHighlight(boolean canHighlight);
- public abstract boolean isCanHighlight();
+ /**
+ * @param checkItem
+ */
+ public abstract void setCheckItem(IEvaluationItem checkItem);
- public abstract void setCanHighlight(boolean canHighlight);
+ /**
+ * @param description
+ */
+ public abstract void setDescription(String description);
- public abstract void setCheckItem(IEvaluationItem checkItem);
+ /**
+ * @param serialNumber
+ */
+ public abstract void setSerialNumber(int serialNumber);
- public abstract void setDescription(String description);
+ /**
+ * @param targetNodeInfo
+ */
+ void setHighlightTargetNodeInfo(HighlightTargetNodeInfo targetNodeInfo);
- public abstract void setSerialNumber(int serialNumber);
+ /**
+ * @return
+ */
+ HighlightTargetNodeInfo getHighlightTargetNodeInfo();
- void setHighlightTargetNodeInfo(HighlightTargetNodeInfo targetNodeInfo);
-
- HighlightTargetNodeInfo getHighlightTargetNodeInfo();
-
- void setHighlightTargetIds(HighlightTargetId targetId);
-
- void setHighlightTargetIds(HighlightTargetId[] targetIds);
+ /**
+ * @param targetId
+ */
+ void setHighlightTargetIds(HighlightTargetId targetId);
- HighlightTargetId[] getHighlightTargetIds();
+ /**
+ * @param targetIds
+ */
+ void setHighlightTargetIds(HighlightTargetId[] targetIds);
- public abstract void setTargetNode(Node targetNode);
+ /**
+ * @return
+ */
+ HighlightTargetId[] getHighlightTargetIds();
- public abstract void setTargetString(String targetString);
+ /**
+ * @param targetNode
+ */
+ public abstract void setTargetNode(Node targetNode);
- public abstract void setTargetStringForHPB(String targetString);
+ /**
+ * @param targetString
+ */
+ public abstract void setTargetString(String targetString);
- public abstract int getLine();
+ /**
+ * @param targetString
+ */
+ public abstract void setTargetStringForHPB(String targetString);
- public abstract String getLineStr();
+ /**
+ * @return
+ */
+ public abstract int getLine();
- public abstract void setLine(int line);
+ /**
+ * @return
+ */
+ public abstract String getLineStr();
- public abstract String getLineStrMulti();
+ /**
+ * @param line
+ */
+ public abstract void setLine(int line);
- void setHighlightTargetSourceInfo(HighlightTargetSourceInfo targetSourceInfo);
+ /**
+ * @return
+ */
+ public abstract String getLineStrMulti();
- void setHighlightTargetSourceInfo(HighlightTargetSourceInfo[] targetSourceInfo);
+ /**
+ * @param targetSourceInfo
+ */
+ void setHighlightTargetSourceInfo(HighlightTargetSourceInfo targetSourceInfo);
- HighlightTargetSourceInfo[] getHighlightTargetSoruceInfo();
+ /**
+ * @param targetSourceInfo
+ */
+ void setHighlightTargetSourceInfo(
+ HighlightTargetSourceInfo[] targetSourceInfo);
- public abstract void accept(IProblemItemVisitor visitor);
-
-
- //TODO
- public String getId();
+ /**
+ * @return
+ */
+ HighlightTargetSourceInfo[] getHighlightTargetSoruceInfo();
- public int getSeverity();
-
- public String getSeverityStr();
-
- public int[] getMetricsScores();
-
- public Image[] getMetricsIcons();
-
- public String[] getTableDataGuideline();
+ /**
+ * @param visitor
+ */
+ public abstract void accept(IProblemItemVisitor visitor);
+
+ // TODO
+ /**
+ * @return
+ */
+ public String getId();
+
+ /**
+ * @return
+ */
+ public int getSeverity();
+
+ /**
+ * @return
+ */
+ public String getSeverityStr();
+
+ /**
+ * @return
+ */
+ public int[] getMetricsScores();
+
+ /**
+ * @return
+ */
+ public Image[] getMetricsIcons();
+
+ /**
+ * @return
+ */
+ public String[] getTableDataGuideline();
}
diff --git a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/CheckTargetImpl.java b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/internal/eval/CheckTargetImpl.java
similarity index 92%
rename from plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/CheckTargetImpl.java
rename to plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/internal/eval/CheckTargetImpl.java
index a0e3f59..dd137c6 100644
--- a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/CheckTargetImpl.java
+++ b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/internal/eval/CheckTargetImpl.java
@@ -9,10 +9,11 @@
* Kentarou FUKUDA - initial API and implementation
*******************************************************************************/
-package org.eclipse.actf.visualization.eval;
+package org.eclipse.actf.visualization.internal.eval;
import java.util.HashMap;
+import org.eclipse.actf.visualization.eval.ICheckTarget;
import org.w3c.dom.Document;
/**
diff --git a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/HtmlCheckTargetImpl.java b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/internal/eval/HtmlCheckTargetImpl.java
similarity index 93%
rename from plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/HtmlCheckTargetImpl.java
rename to plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/internal/eval/HtmlCheckTargetImpl.java
index 685014c..ad1b2f4 100644
--- a/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/eval/HtmlCheckTargetImpl.java
+++ b/plugins/org.eclipse.actf.visualization.eval/src/org/eclipse/actf/visualization/internal/eval/HtmlCheckTargetImpl.java
@@ -8,9 +8,10 @@
* Contributors:
* Kentarou FUKUDA - initial API and implementation
*******************************************************************************/
-package org.eclipse.actf.visualization.eval;
+package org.eclipse.actf.visualization.internal.eval;
import org.eclipse.actf.model.ui.editor.browser.IWebBrowserStyleInfo;
+import org.eclipse.actf.visualization.eval.IHtmlCheckTarget;
import org.eclipse.actf.visualization.eval.html.HtmlEvalUtil;
import org.w3c.dom.Document;
