Bug 311589 - [Help] CriterionValueDefinition has bad copy constructor

10 files changed, 416 insertions, 6 deletions

diff --git a/org.eclipse.help/src/org/eclipse/help/internal/criteria/CriterionValueDefinition.java b/org.eclipse.help/src/org/eclipse/help/internal/criteria/CriterionValueDefinition.java
index 0745a4470..9b15b97b4 100644
--- a/org.eclipse.help/src/org/eclipse/help/internal/criteria/CriterionValueDefinition.java
+++ b/org.eclipse.help/src/org/eclipse/help/internal/criteria/CriterionValueDefinition.java
@@ -10,7 +10,6 @@
  *******************************************************************************/
 package org.eclipse.help.internal.criteria;
 
-import org.eclipse.help.ICriterionDefinition;
 import org.eclipse.help.ICriterionValueDefinition;
 import org.eclipse.help.internal.UAElement;
 import org.w3c.dom.Element;
@@ -21,7 +20,7 @@ public class CriterionValueDefinition extends UAElement implements ICriterionVal
 	public static final String ATTRIBUTE_ID = "id"; //$NON-NLS-1$
 	public static final String ATTRIBUTE_NAME = "name"; //$NON-NLS-1$
 	
-	public CriterionValueDefinition(ICriterionDefinition src) {
+	public CriterionValueDefinition(ICriterionValueDefinition src) {
 		super(NAME, src);
 		setId(src.getId());
 		setName(src.getName());
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/AllCriteriaTests.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/AllCriteriaTests.java
index a6b2fa6e6..0fc0b9bc1 100644
--- a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/AllCriteriaTests.java
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/AllCriteriaTests.java
@@ -31,6 +31,7 @@ public class AllCriteriaTests extends TestSuite {
 	public AllCriteriaTests() {
 		addTestSuite(ParseTocWithCriteria.class);
 		addTestSuite(CriteriaUtilitiesTest.class);
+		addTestSuite(CriteriaDefinitionTest.class);
 		addTestSuite(ParseCriteriaDefinition.class);
 		addTestSuite(TestCriteriaProvider.class);
 	}
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/CriteriaDefinitionTest.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/CriteriaDefinitionTest.java
new file mode 100644
index 000000000..206153e93
--- /dev/null
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/CriteriaDefinitionTest.java
@@ -0,0 +1,143 @@
+/*******************************************************************************
+ * Copyright (c) 2010 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:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.ua.tests.help.criteria;
+
+import junit.framework.Test;
+import junit.framework.TestCase;
+import junit.framework.TestSuite;
+
+import org.eclipse.help.ICriterionDefinition;
+import org.eclipse.help.ICriterionValueDefinition;
+import org.eclipse.help.internal.UAElement;
+import org.eclipse.help.internal.UAElementFactory;
+import org.eclipse.help.internal.criteria.CriterionDefinition;
+import org.eclipse.help.internal.criteria.CriterionValueDefinition;
+import org.eclipse.ua.tests.help.other.UserCriterionDefinition;
+import org.eclipse.ua.tests.help.other.UserCriterionValueDefinition;
+
+public class CriteriaDefinitionTest extends TestCase {
+
+	private static final String VALUEID1 = "valueid1";
+	private static final String VALUENAME1 = "first value";
+	private static final String VALUEID2 = "valueid2";
+	private static final String VALUENAME2 = "second value";	
+	private static final String CRITERIONID1 = "criterionid1";
+	private static final String CRITERIONNAME1 = "first criterion";
+	
+	public static Test suite() {
+		return new TestSuite(CriteriaDefinitionTest.class);
+	}
+	
+	// Criterion Value
+
+	public void testCriterionValueDefinition() {
+		UserCriterionValueDefinition valueDefinition = new UserCriterionValueDefinition(VALUEID1, VALUENAME1);
+		assertEquals(VALUEID1, valueDefinition.getId());
+		assertEquals(VALUENAME1, valueDefinition.getName());
+		assertEquals(0, valueDefinition.getChildren().length);
+	}
+	
+	public void testCopyCriterionValueDefinition() {
+		UserCriterionValueDefinition valueDefinition = new UserCriterionValueDefinition(VALUEID1, VALUENAME1);
+		ICriterionValueDefinition copy = new CriterionValueDefinition(valueDefinition);
+		assertEquals(VALUEID1, copy.getId());
+		assertEquals(VALUENAME1, copy.getName());
+		assertEquals(0, copy.getChildren().length);
+	}
+	
+	public void testFactoryCreateValueDefinition() {
+		UserCriterionValueDefinition valueDefinition = new UserCriterionValueDefinition(VALUEID1, VALUENAME1);
+		UAElement element = UAElementFactory.newElement(valueDefinition);
+		assertNotNull(element);
+		assertTrue(element instanceof ICriterionValueDefinition);
+		ICriterionValueDefinition copy = (ICriterionValueDefinition) element;
+		assertEquals(VALUEID1, copy.getId());
+		assertEquals(VALUENAME1, copy.getName());
+		assertEquals(0, copy.getChildren().length);
+	}
+	
+	// Criterion - no children
+	
+	public void testCriterionDefinition() {
+		UserCriterionDefinition definition = new UserCriterionDefinition(CRITERIONID1, CRITERIONNAME1);
+		assertEquals(CRITERIONID1, definition.getId());
+		assertEquals(CRITERIONNAME1, definition.getName());
+		assertEquals(0, definition.getChildren().length);
+	}
+	
+	public void testCopyCriterionDefinition() {
+		UserCriterionDefinition definition = new UserCriterionDefinition(CRITERIONID1, CRITERIONNAME1);
+		ICriterionDefinition copy = new CriterionDefinition(definition);
+		assertEquals(CRITERIONID1, copy.getId());
+		assertEquals(CRITERIONNAME1, copy.getName());
+		assertEquals(0, copy.getChildren().length);
+	}
+	
+	public void testFactoryCreateDefinition() {
+		UserCriterionDefinition definition = new UserCriterionDefinition(CRITERIONID1, CRITERIONNAME1);
+		UAElement element = UAElementFactory.newElement(definition);
+		assertNotNull(element);
+		assertTrue(element instanceof ICriterionDefinition);
+		ICriterionDefinition copy = (ICriterionDefinition) element;
+		assertEquals(CRITERIONID1, copy.getId());
+		assertEquals(CRITERIONNAME1, copy.getName());
+		assertEquals(0, copy.getChildren().length);
+	}
+
+	public void testCriterionDefinitionWithValues() {
+		UserCriterionDefinition definition;
+		definition = createDefinitionWithValues();
+		checkDefinitionWithValues(definition);
+	}
+
+	public void testCopyCriterionDefinitionWithValues() {
+		UserCriterionDefinition definition;
+		definition = createDefinitionWithValues();
+		ICriterionDefinition copy = new CriterionDefinition(definition);
+		checkDefinitionWithValues(copy);
+	}
+	
+	public void testFactoryCreateCriterionDefinitionWithValues() {
+		UserCriterionDefinition definition;
+		definition = createDefinitionWithValues();
+		UAElement element = UAElementFactory.newElement(definition);
+		assertNotNull(element);
+		assertTrue(element instanceof ICriterionDefinition);
+		ICriterionDefinition copy = (ICriterionDefinition) element;
+		checkDefinitionWithValues(copy);
+	}
+
+	private UserCriterionDefinition createDefinitionWithValues() {
+		UserCriterionDefinition definition;
+		definition = new UserCriterionDefinition(CRITERIONID1, CRITERIONNAME1);
+		UserCriterionValueDefinition valueDefinition1 = new UserCriterionValueDefinition(
+				VALUEID1, VALUENAME1);
+		UserCriterionValueDefinition valueDefinition2 = new UserCriterionValueDefinition(
+				VALUEID2, VALUENAME2);
+		definition.addValue(valueDefinition1);
+		definition.addValue(valueDefinition2);
+		return definition;
+	}
+
+	private void checkDefinitionWithValues(ICriterionDefinition copy) {
+		assertEquals(CRITERIONID1, copy.getId());
+		assertEquals(CRITERIONNAME1, copy.getName());
+		ICriterionValueDefinition[] values = copy.getCriterionValueDefinitions();
+		assertEquals(2, values.length);
+		assertEquals(VALUEID1, values[0].getId());
+		assertEquals(VALUENAME1, values[0].getName());
+		assertEquals(VALUEID2, values[1].getId());
+		assertEquals(VALUENAME2, values[1].getName());
+	}
+
+		
+}
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/SampleCriteriaDefinitionProvider.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/SampleCriteriaDefinitionProvider.java
new file mode 100644
index 000000000..bbd6fe2af
--- /dev/null
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/SampleCriteriaDefinitionProvider.java
@@ -0,0 +1,55 @@
+package org.eclipse.ua.tests.help.criteria;
+
+import org.eclipse.help.AbstractCriteriaDefinitionProvider;
+import org.eclipse.help.ICriteriaDefinitionContribution;
+import org.eclipse.ua.tests.help.other.UserCriteriaDefinition;
+import org.eclipse.ua.tests.help.other.UserCriteriaDefinitionContribution;
+import org.eclipse.ua.tests.help.other.UserCriterionDefinition;
+import org.eclipse.ua.tests.help.other.UserCriterionValueDefinition;
+
+public class SampleCriteriaDefinitionProvider extends
+		AbstractCriteriaDefinitionProvider {
+
+	public ICriteriaDefinitionContribution[] getCriteriaDefinitionContributions(
+			String locale) {
+		if (locale.startsWith("es")) {
+			return getSpanishCriteriaDefinitionContributions();
+		}
+		return getDefaultCriteriaDefinitionContributions();
+	}
+
+	private ICriteriaDefinitionContribution[] getDefaultCriteriaDefinitionContributions() {
+		UserCriteriaDefinition criteriaDefinition = new UserCriteriaDefinition();
+		UserCriterionDefinition criterionDefinition = new UserCriterionDefinition(
+				SampleCriteriaProvider.CONTAINS_LETTER,
+				"Title contains the letter");
+		UserCriteriaDefinitionContribution contribution = new UserCriteriaDefinitionContribution();
+		criteriaDefinition.addDefinition(criterionDefinition);
+		criterionDefinition.addValue(new UserCriterionValueDefinition("t", "letter t"));
+		criterionDefinition.addValue(new UserCriterionValueDefinition("k", "letter k"));
+		criterionDefinition.addValue(new UserCriterionValueDefinition("v", "letter v"));
+		criterionDefinition.addValue(new UserCriterionValueDefinition("c", "letter c"));
+		contribution.setLocale("");
+		contribution.setCriteriaDefinition(criteriaDefinition);
+		contribution.setId("en_Def");
+		return new ICriteriaDefinitionContribution[] { contribution } ;
+	}
+
+	private ICriteriaDefinitionContribution[] getSpanishCriteriaDefinitionContributions() {
+		UserCriteriaDefinition criteriaDefinition = new UserCriteriaDefinition();
+		UserCriterionDefinition criterionDefinition = new UserCriterionDefinition(
+				SampleCriteriaProvider.CONTAINS_LETTER, 
+				"Letras en titulo");
+		UserCriteriaDefinitionContribution contribution = new UserCriteriaDefinitionContribution();
+		criteriaDefinition.addDefinition(criterionDefinition);
+		criterionDefinition.addValue(new UserCriterionValueDefinition("t", "letra t"));
+		criterionDefinition.addValue(new UserCriterionValueDefinition("k", "letra k"));
+		criterionDefinition.addValue(new UserCriterionValueDefinition("v", "letra v"));
+		criterionDefinition.addValue(new UserCriterionValueDefinition("c", "letra c"));
+		contribution.setLocale("");
+		contribution.setCriteriaDefinition(criteriaDefinition);
+		contribution.setId("es_Def");
+		return new ICriteriaDefinitionContribution[] { contribution } ;
+	}
+
+}
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/SampleCriteriaProvider.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/SampleCriteriaProvider.java
index aaafc64be..82d73d366 100644
--- a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/SampleCriteriaProvider.java
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/criteria/SampleCriteriaProvider.java
@@ -21,6 +21,8 @@ import org.eclipse.ua.tests.help.other.UserCriteria;
 
 public class SampleCriteriaProvider extends AbstractCriteriaProvider {
 
+	public static final String CONTAINS_LETTER = "containsLetter";
+
 	public ICriteria[] getCriteria(ITopic topic) {
 		return getCriteriaFromLabel(topic.getLabel());
 	}
@@ -35,16 +37,16 @@ public class SampleCriteriaProvider extends AbstractCriteriaProvider {
 			return new UserCriteria[0];
 		}
 		if (label.toLowerCase().indexOf('t') >= 0) {
-			criteria.add( new UserCriteria("containsLetter", "t", true) );
+			criteria.add( new UserCriteria(CONTAINS_LETTER, "t", true) );
 		}
 		if (label.toLowerCase().indexOf('k') >= 0) {
-			criteria.add( new UserCriteria("containsLetter", "k", true) );
+			criteria.add( new UserCriteria(CONTAINS_LETTER, "k", true) );
 		}
 		if (label.toLowerCase().indexOf('v') >= 0) {
-			criteria.add( new UserCriteria("containsLetter", "v", true) );
+			criteria.add( new UserCriteria(CONTAINS_LETTER, "v", true) );
 		}
 		if (label.toLowerCase().indexOf('c') >= 0) {
-			criteria.add( new UserCriteria("containsLetter", "c", true) );
+			criteria.add( new UserCriteria(CONTAINS_LETTER, "c", true) );
 		}
 		return (UserCriteria[]) criteria.toArray(new UserCriteria[criteria.size()]);
 	}	
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriteriaDefinition.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriteriaDefinition.java
new file mode 100644
index 000000000..40768002f
--- /dev/null
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriteriaDefinition.java
@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright (c) 2010 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:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.ua.tests.help.other;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.core.expressions.IEvaluationContext;
+import org.eclipse.help.ICriteriaDefinition;
+import org.eclipse.help.ICriterionDefinition;
+import org.eclipse.help.IUAElement;
+
+public class UserCriteriaDefinition implements ICriteriaDefinition {
+
+	private List children = new ArrayList();
+	
+	public boolean isEnabled(IEvaluationContext context) {
+		return true;
+	}
+
+	public ICriterionDefinition[] getCriterionDefinitions() {
+		return (ICriterionDefinition[]) children.toArray(new ICriterionDefinition[0]);
+	}
+	
+	public void addDefinition(ICriterionDefinition definition) {
+		children.add(definition);
+	}
+
+	public IUAElement[] getChildren() {
+		return getCriterionDefinitions();
+	}
+
+
+}
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriteriaDefinitionContribution.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriteriaDefinitionContribution.java
new file mode 100644
index 000000000..cd2167f4e
--- /dev/null
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriteriaDefinitionContribution.java
@@ -0,0 +1,52 @@
+/*******************************************************************************
+ * Copyright (c) 2010 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:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.ua.tests.help.other;
+
+import org.eclipse.core.expressions.IEvaluationContext;
+import org.eclipse.help.ICriteriaDefinition;
+import org.eclipse.help.ICriteriaDefinitionContribution;
+
+public class UserCriteriaDefinitionContribution implements ICriteriaDefinitionContribution {
+
+	private ICriteriaDefinition criteriaDefinition;
+	private String id;
+	private String locale;
+	
+	public boolean isEnabled(IEvaluationContext context) {
+		return true;
+	}
+
+	public void setCriteriaDefinition(ICriteriaDefinition criteriaDefinition) {
+		this.criteriaDefinition = criteriaDefinition;
+	}
+
+	public ICriteriaDefinition getCriteriaDefinition() {
+		return criteriaDefinition;
+	}
+
+	public void setId(String id) {
+		this.id = id;
+	}
+
+	public String getId() {
+		return id;
+	}
+
+	public void setLocale(String locale) {
+		this.locale = locale;
+	}
+
+	public String getLocale() {
+		return locale;
+	}
+
+}
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriterionDefinition.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriterionDefinition.java
new file mode 100644
index 000000000..3f2160490
--- /dev/null
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriterionDefinition.java
@@ -0,0 +1,65 @@
+/*******************************************************************************
+ * Copyright (c) 2010 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:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.ua.tests.help.other;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.eclipse.core.expressions.IEvaluationContext;
+import org.eclipse.help.ICriterionDefinition;
+import org.eclipse.help.ICriterionValueDefinition;
+import org.eclipse.help.IUAElement;
+
+public class UserCriterionDefinition implements ICriterionDefinition {
+
+	private String id;
+	private String name;
+	private List children = new ArrayList();
+	
+	public UserCriterionDefinition(String id, String name) {
+		this.id = id;
+		this.name = name;
+	}
+	
+	public boolean isEnabled(IEvaluationContext context) {
+		return true;
+	}
+
+	public void setId(String id) {
+		this.id = id;
+	}
+
+	public String getId() {
+		return id;
+	}
+
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	public String getName() {
+		return name;
+	}
+
+	public IUAElement[] getChildren() {
+        return getCriterionValueDefinitions();
+	}
+
+	public ICriterionValueDefinition[] getCriterionValueDefinitions() {
+		return (ICriterionValueDefinition[]) children.toArray(new ICriterionValueDefinition[0]);
+	}
+	
+	public void addValue(ICriterionValueDefinition value) {
+		children.add(value);
+	}
+
+}
diff --git a/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriterionValueDefinition.java b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriterionValueDefinition.java
new file mode 100644
index 000000000..557d7cef2
--- /dev/null
+++ b/org.eclipse.ua.tests/help/org/eclipse/ua/tests/help/other/UserCriterionValueDefinition.java
@@ -0,0 +1,44 @@
+/*******************************************************************************
+ * Copyright (c) 2010 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:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package org.eclipse.ua.tests.help.other;
+
+import org.eclipse.core.expressions.IEvaluationContext;
+import org.eclipse.help.ICriterionValueDefinition;
+import org.eclipse.help.IUAElement;
+
+public class UserCriterionValueDefinition implements ICriterionValueDefinition {
+
+	private String id;
+	private String name;
+	
+	public UserCriterionValueDefinition(String id, String name) {
+		this.id = id;
+		this.name = name;
+	}
+	
+	public boolean isEnabled(IEvaluationContext context) {
+		return true;
+	}
+
+	public String getId() {
+		return id;
+	}
+
+	public String getName() {
+		return name;
+	}
+
+	public IUAElement[] getChildren() {
+        return new IUAElement[0];
+	}
+
+}
diff --git a/org.eclipse.ua.tests/plugin.xml b/org.eclipse.ua.tests/plugin.xml
index 7c644d8c3..df4942749 100644
--- a/org.eclipse.ua.tests/plugin.xml
+++ b/org.eclipse.ua.tests/plugin.xml
@@ -650,5 +650,11 @@
             id="tscope">
       </scope>
    </extension>
+   <extension
+         point="org.eclipse.help.criteriaDefinition">
+      <criteriaDefinitionProvider
+            class="org.eclipse.ua.tests.help.criteria.SampleCriteriaDefinitionProvider">
+      </criteriaDefinitionProvider>
+   </extension>
 
 </plugin>