Attachment #114267 for bug #249496

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 1-12 Link Here

(-)src/org/eclipse/emf/validation/internal/service/ClientContextManager.java (-34 / +37 lines)
1	/******************************************************************************	1	/******************************************************************************
2	* Copyright (c) 2005, 2007 IBM Corporation and others.	2	* Copyright (c) 2005, 2008 IBM Corporation, Zeligsoft Inc., and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html	6	* http://www.eclipse.org/legal/epl-v10.html
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* Zeligsoft - Bug 249496
10	****************************************************************************/	11	****************************************************************************/
11		12
12	package org.eclipse.emf.validation.internal.service;	13	package org.eclipse.emf.validation.internal.service;
Lines 45-52 Link Here
45	private static final String E_BINDING = "binding"; //$NON-NLS-1$	46	private static final String E_BINDING = "binding"; //$NON-NLS-1$
46	private static final String A_CONTEXT = "context"; //$NON-NLS-1$	47	private static final String A_CONTEXT = "context"; //$NON-NLS-1$
47		48
48	private static final String A_CONSTRAINT = "constraint"; //$NON-NLS-1$	49	private static final String E_CONSTRAINT = "constraint"; //$NON-NLS-1$
49	private static final String A_CATEGORY = "category"; //$NON-NLS-1$	50	private static final String E_CATEGORY = "category"; //$NON-NLS-1$
		51	private static final String E_EXCLUDE_CONSTRAINT = "excludeConstraint"; //$NON-NLS-1$
		52	private static final String E_EXCLUDE_CATEGORY = "excludeCategory"; //$NON-NLS-1$
50	private static final String A_REF = "ref"; //$NON-NLS-1$	53	private static final String A_REF = "ref"; //$NON-NLS-1$
51		54
52	private static final ClientContextManager INSTANCE = new ClientContextManager();	55	private static final ClientContextManager INSTANCE = new ClientContextManager();
Lines 299-305 Link Here
299	// add the constraint to all default contexts so that we don't do	302	// add the constraint to all default contexts so that we don't do
300	// this computation again	303	// this computation again
301	for (ClientContext next : defaultContexts) {	304	for (ClientContext next : defaultContexts) {
302	next.bindConstraint(id);	305	next.includeConstraint(id);
303	}	306	}
304	}	307	}
305		308
Lines 400-446 Link Here
400	* @param config a particular <code><binding></config> element	403	* @param config a particular <code><binding></config> element
401	*/	404	*/
402	private void configureBindings(ClientContext context, IConfigurationElement config) {	405	private void configureBindings(ClientContext context, IConfigurationElement config) {
403	String id = config.getAttribute(A_CONSTRAINT);	406	String id = config.getAttribute(E_CONSTRAINT);
404		407
405	if (id != null) {	408	if (id != null) {
406	context.bindConstraint(id);	409	context.includeConstraint(id);
407	}	410	}
408		411
409	id = config.getAttribute(A_CATEGORY);	412	id = config.getAttribute(E_CATEGORY);
410		413
411	if (id != null) {	414	if (id != null) {
412	context.bindCategory(id);	415	context.includeCategory(id);
413	}	416	}
414		417
415	IConfigurationElement[] children = config.getChildren(A_CONSTRAINT);	418	IConfigurationElement[] children = config.getChildren();
416	for (IConfigurationElement element : children) {	419	for (IConfigurationElement element : children) {
		420	final String name = element.getName();
417	final String ref = element.getAttribute(A_REF);	421	final String ref = element.getAttribute(A_REF);
418		422
419	if (ref == null) {	423	if (ref == null) {
420	Log.warningMessage(	424	if (E_CONSTRAINT.equals(name) \|\| E_EXCLUDE_CONSTRAINT.equals(name)) {
421	EMFModelValidationStatusCodes.BINDING_NO_CONSTRAINT,	425	Log.warningMessage(
422	ValidationMessages.binding_noConstraintRef_WARN_,	426	EMFModelValidationStatusCodes.BINDING_NO_CONSTRAINT,
423	new Object[] {	427	ValidationMessages.binding_noConstraintRef_WARN_,
424	context.getId(),	428	new Object[] {
425	config.getDeclaringExtension().getNamespaceIdentifier()});	429	context.getId(),
426	} else {	430	config.getDeclaringExtension().getNamespaceIdentifier()});
427	context.bindConstraint(ref);	431	} else {
428	}	432	Log.errorMessage(
429	}	433	EMFModelValidationStatusCodes.BINDING_NO_CATEGORY,
430		434	ValidationMessages.binding_noCategoryRef_WARN_,
431	children = config.getChildren(A_CATEGORY);	435	new Object[] {
432	for (IConfigurationElement element : children) {	436	context.getId(),
433	final String ref = element.getAttribute(A_REF);	437	config.getDeclaringExtension().getNamespaceIdentifier()});
434		438	}
435	if (ref == null) {	439	} else if (E_CONSTRAINT.equals(name)) {
436	Log.errorMessage(	440	context.includeConstraint(ref);
437	EMFModelValidationStatusCodes.BINDING_NO_CATEGORY,	441	} else if (E_CATEGORY.equals(name)) {
438	ValidationMessages.binding_noCategoryRef_WARN_,	442	context.includeCategory(ref);
439	new Object[] {	443	} else if (E_EXCLUDE_CONSTRAINT.equals(name)) {
440	context.getId(),	444	context.excludeConstraint(ref);
441	config.getDeclaringExtension().getNamespaceIdentifier()});	445	} else if (E_EXCLUDE_CATEGORY.equals(name)) {
442	} else {	446	context.excludeCategory(ref);
443	context.bindCategory(ref);
444	}	447	}
445	}	448	}
446	}	449	}




/******************************************************************************
 * Copyright (c) 2005, 2008 IBM Corporation, Zeligsoft Inc., 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
 *    Zeligsoft - Bug 249496
 ****************************************************************************/

package org.eclipse.emf.validation.internal.service;

import java.util.Collection;
import java.util.Map;
import java.util.Set;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;

import org.eclipse.emf.validation.internal.EMFModelValidationPlugin;
import org.eclipse.emf.validation.internal.EMFModelValidationStatusCodes;
import org.eclipse.emf.validation.internal.l10n.ValidationMessages;

	private final IClientSelector selector;
	private final boolean isDefault;
	
	// map of String constraint IDs that are bound to me, the boolean value
	// indicating absolute inclusion or exclusion.  Absence of a value means
	// that we still need to compute
	private final Map<String, Boolean> constraintBindings = new java.util.HashMap<String, Boolean>();
	
	// set of String category IDs that are bound to me
	private BindingFilter filter = BindingFilter.NULL;
	
	/**
	 * Initializes me with my XML configuration.

	}

	public boolean includes(IModelConstraint constraint) {
		Boolean result;
		
		IConstraintDescriptor descriptor = constraint.getDescriptor();
		
		if (descriptor == null) {
			result = Boolean.FALSE;
		} else {
			result = constraintBindings.get(descriptor.getId());
			
			if (result == null) {
				// cache the result for this constraint
				result = filter.getBinding(descriptor);
				constraintBindings.put(descriptor.getId(), result);
				if (result) {
					// cache the result for this constraint
					bindConstraint(descriptor.getId());
				}
			}
		}
		

	}
	
	/**
	 * Adds a constraint inclusion binding to me.
	 * to me.
	 * 
	 * @param constraintId the ID of a constraint that is to be included in me
	 * @return <code>true</code> if any of the <code>categories</code> is bound,
	 *     or if any of their ancestors is bound; <code>false</code>, otherwise
	 */
	void includeConstraint(String constraintId) {
		filter = filter.includeConstraint(constraintId);
	}

	/**
	 * Adds a constraint exclusion binding to me.
	 * 
	 * @param constraintId the ID of a constraint that is to be excluded from me
	 */
	void excludeConstraint(String constraintId) {
		filter = filter.excludeConstraint(constraintId);
				
				while ((ancestor != null) && !result) {
					result = categoryBindings.contains(ancestor.getPath());
					ancestor = ancestor.getParent();
				}
				
				if (result) {
					// cache the original category for quicker results on the
					//    next constraint that it includes
					bindCategory(category.getPath());
				}
			}
		}
		
		return result;
	}

	/**
	 * Adds a constraint category inclusion to me.
	 * 
	 * @param categoryId the qualified ID (path) of a constraint category that
	 *     is to be included in me
	 */
	void includeCategory(String categoryId) {
		filter = filter.includeCategory(categoryId);
	}

	/**
	 * Adds a constraint category exclusion to me.
	 * 
	 * @param categoryId the qualified ID (path) of a constraint category that
	 *     is to be excluded from me
	 */
	void excludeCategory(String categoryId) {
		filter = filter.excludeCategory(categoryId);
	}

	/**

	public String toString() {
		return "ClientContext[" + getId() + ']'; //$NON-NLS-1$
	}
	
	
	/**
	 * A chain-structured constraint-binding filter.  Filters are chained in
	 * the order in which they are parsed from the extension point.  The head of
	 * the filter chain applies its filter and, if it doesn't find any match,
	 * delegates down the chain.  The chain is terminated by the {@link #NULL}
	 * filter, which always excludes the constraint.
	 * 
	 * @author Christian W. Damus (cdamus)
	 */
	private static class BindingFilter {
		private BindingFilter next;
		
		/** A filter that excludes every constraint. */
		static final BindingFilter NULL = new BindingFilter() {
			boolean getBinding(IConstraintDescriptor constraint) {return false;}
		};
		
		/**
		 * Queries whether the specified constraint is definitely included
		 * (<code>true</code>) or excluded (<code>false</code>) from the client
		 * context.  If I don't have definitive knowledge of this constraint,
		 * I delegate to the next in the chain.
		 * 
		 * @param constraint a constraint descriptor
		 * @return whether the constraint is included
		 */
		boolean getBinding(IConstraintDescriptor constraint) {
			return isExcluded(constraint)
				? false
				: isIncluded(constraint)
					? true
					: next().getBinding(constraint);
		}
		
		/**
		 * Queries whether I know that a constraint is included.
		 * 
		 * @param constraint a constraint descriptor
		 * @return <code>true</code> if the constraint is included, or
		 *     <code>false</code> if I do not know
		 */
		boolean isExcluded(IConstraintDescriptor constraint) {
			return false;
		}
		
		/**
		 * Queries whether I know that a constraint is excluded.
		 * 
		 * @param constraint a constraint descriptor
		 * @return <code>true</code> if the constraint is excluded, or
		 *     <code>false</code> if I do not know
		 */
		boolean isIncluded(IConstraintDescriptor constraint) {
			return false;
		}
		
		/**
		 * Obtains the next filter in my chain.
		 * 
		 * @return my next, or <code>null</code> if I am the end of the chain
		 */
		BindingFilter next() {
			return next;
		}
		
		/**
		 * Assigns my next filter.
		 * 
		 * @param next my new next
		 */
		void setNext(BindingFilter next) {
			this.next = next;
		}
		
		/**
		 * Obtains a filter, chaining me, that definitively includes the
		 * specified category and all of its constraints and sub-categories. The
		 * result may be optimized to be myself augmented with this category, if
		 * I am a filter of the appropriate kind. Or, the result may be a new
		 * filter chain.
		 * 
		 * @param category
		 *            a category to include
		 * 
		 * @return a filter that includes the category
		 */
		BindingFilter includeCategory(String category) {
			CategoryInclusion result = new CategoryInclusion(category);
			result.setNext(this);
			return result;
		}
		
		/**
		 * Obtains a filter, chaining me, that definitively excludes the
		 * specified category and all of its constraints and sub-categories. The
		 * result may be optimized to be myself augmented with this category, if
		 * I am a filter of the appropriate kind. Or, the result may be a new
		 * filter chain.
		 * 
		 * @param category
		 *            a category to exclude
		 * 
		 * @return a filter that excludes the category
		 */
		BindingFilter excludeCategory(String category) {
			CategoryExclusion result = new CategoryExclusion(category);
			result.setNext(this);
			return result;
		}

		/**
		 * Obtains a filter, chaining me, that definitively includes the
		 * specified constraint. The result may be optimized to be myself
		 * augmented with this category, if I am a filter of the appropriate
		 * kind. Or, the result may be a new filter chain.
		 * 
		 * @param constraint
		 *            a constraint to include
		 * 
		 * @return a filter that includes the constraint
		 */
		BindingFilter includeConstraint(String constraint) {
			ConstraintInclusion result = new ConstraintInclusion(constraint);
			result.setNext(this);
			return result;
		}
		
		/**
		 * Obtains a filter, chaining me, that definitively excludes the
		 * specified constraint. The result may be optimized to be myself
		 * augmented with this category, if I am a filter of the appropriate
		 * kind. Or, the result may be a new filter chain.
		 * 
		 * @param constraint
		 *            a constraint to exclude
		 * 
		 * @return a filter that excludes the constraint
		 */
		BindingFilter excludeConstraint(String constraint) {
			ConstraintExclusion result = new ConstraintExclusion(constraint);
			result.setNext(this);
			return result;
		}
	}
	
	/**
	 * A binding filter that definitively includes one or more constraints.
	 * 
	 * @author Christian W. Damus (cdamus)
	 */
	private static class ConstraintInclusion extends BindingFilter {
		private final Set<String> constraints = new java.util.HashSet<String>();
		
		ConstraintInclusion(String constraint) {
			constraints.add(constraint);
		}
		
		@Override
		boolean isIncluded(IConstraintDescriptor constraint) {
			return constraints.contains(constraint.getId());
		}
		
		@Override
		BindingFilter includeConstraint(String constraint) {
			constraints.add(constraint);
			return this;
		}
	}
	
	/**
	 * A binding filter that definitively excludes one or more constraints.
	 * 
	 * @author Christian W. Damus (cdamus)
	 */
	private static class ConstraintExclusion extends BindingFilter {
		private final Set<String> constraints = new java.util.HashSet<String>();
		
		ConstraintExclusion(String constraint) {
			constraints.add(constraint);
		}
		
		@Override
		boolean isExcluded(IConstraintDescriptor constraint) {
			return constraints.contains(constraint.getId());
		}
		
		@Override
		BindingFilter excludeConstraint(String constraint) {
			constraints.add(constraint);
			return this;
		}
	}
	
	/**
	 * A binding filter that definitively includes one or more categories.
	 * 
	 * @author Christian W. Damus (cdamus)
	 */
	private static class CategoryInclusion extends BindingFilter {
		private final CategorySet categories;
		
		CategoryInclusion(String category) {
			categories = new CategorySet(category);
		}
		
		@Override
		boolean isIncluded(IConstraintDescriptor constraint) {
			return categories.containsAny(constraint.getCategories());
		}
		
		@Override
		BindingFilter includeCategory(String category) {
			categories.add(category);
			return this;
		}
	}
	
	/**
	 * A binding filter that definitively excludes one or more categories.
	 * 
	 * @author Christian W. Damus (cdamus)
	 */
	private static class CategoryExclusion extends BindingFilter {
		private final CategorySet categories;
		
		CategoryExclusion(String category) {
			categories = new CategorySet(category);
		}
		
		@Override
		boolean isExcluded(IConstraintDescriptor constraint) {
			return categories.containsAny(constraint.getCategories());
		}
		
		@Override
		BindingFilter excludeCategory(String category) {
			categories.add(category);
			return this;
		}
	}
	
	private static final class CategorySet {
		private final Set<String> categories = new java.util.HashSet<String>();
		
		CategorySet(String category) {
			categories.add(category);
		}
		
		boolean containsAny(Collection<? extends Category> categories) {
			boolean result = false;
			
			for (Category next : categories) {
				if (contains(next)) {
					result = true;
					break;
				}
			}
			
			return result;
		}
		
		boolean contains(Category category) {
			boolean result = false;
			
			String path = category.getPath();
			result = categories.contains(path);
			
			if (!result) {
				// search the ancestors
				Category ancestor = category.getParent();
				
				while ((ancestor != null) && !result) {
					result = categories.contains(ancestor.getPath());
					ancestor = ancestor.getParent();
				}
				
				if (result) {
					// cache the original category for quicker results on the
					// next category that it contains
					add(path);
				}
			}
			
			return result;
		}
		
		void add(String category) {
			categories.add(category);
		}
	}
}

Lines 1-10 Link Here

(-)schema/constraintBindings.exsd (-40 / +80 lines)
1	<?xml version='1.0' encoding='UTF-8'?>	1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->	2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.emf.validation">	3	<schema targetNamespace="org.eclipse.emf.validation" xmlns="http://www.w3.org/2001/XMLSchema">
4	<annotation>	4	<annotation>
5	<appInfo>	5	<appinfo>
6	<meta.schema plugin="org.eclipse.emf.validation" id="constraintBindings" name="EMF Validation Constraint Bindings"/>	6	<meta.schema plugin="org.eclipse.emf.validation" id="constraintBindings" name="EMF Validation Constraint Bindings"/>
7	</appInfo>	7	</appinfo>
8	<documentation>	8	<documentation>
9	This extension point allows clients of the EMF Validation	9	This extension point allows clients of the EMF Validation
10	framework to define "client contexts" that describe the	10	framework to define "client contexts" that describe the
Lines 17-22 Link Here
17	<include schemaLocation="schema://org.eclipse.core.expressions/schema/expressionLanguage.exsd"/>	17	<include schemaLocation="schema://org.eclipse.core.expressions/schema/expressionLanguage.exsd"/>
18		18
19	<element name="extension">	19	<element name="extension">
		20	<annotation>
		21	<appinfo>
		22	<meta.element />
		23	</appinfo>
		24	</annotation>
20	<complexType>	25	<complexType>
21	<sequence>	26	<sequence>
22	<element ref="clientContext" minOccurs="0" maxOccurs="unbounded"/>	27	<element ref="clientContext" minOccurs="0" maxOccurs="unbounded"/>
Lines 41-49 Link Here
41	<documentation>	46	<documentation>
42		47
43	</documentation>	48	</documentation>
44	<appInfo>	49	<appinfo>
45	<meta.attribute translatable="true"/>	50	<meta.attribute translatable="true"/>
46	</appInfo>	51	</appinfo>
47	</annotation>	52	</annotation>
48	</attribute>	53	</attribute>
49	</complexType>	54	</complexType>
Lines 51-59 Link Here
51		56
52	<element name="clientContext">	57	<element name="clientContext">
53	<annotation>	58	<annotation>
54	<appInfo>	59	<appinfo>
55	<meta.element labelAttribute="id"/>	60	<meta.element labelAttribute="id"/>
56	</appInfo>	61	</appinfo>
57	<documentation>	62	<documentation>
58	<p>	63	<p>
59	Definition of a client context, representing a class of	64	Definition of a client context, representing a class of
Lines 110-118 Link Here
110	Identifies a class implementing the <code>org.eclipse.emf.validation.internal.model.IClientSelector</code>	115	Identifies a class implementing the <code>org.eclipse.emf.validation.internal.model.IClientSelector</code>
111	internal API interface.	116	internal API interface.
112	</documentation>	117	</documentation>
113	<appInfo>	118	<appinfo>
114	<meta.attribute kind="java" basedOn="org.eclipse.emf.validation.internal.model.IClientSelector"/>	119	<meta.attribute kind="java" basedOn="org.eclipse.emf.validation.internal.model.IClientSelector"/>
115	</appInfo>	120	</appinfo>
116	</annotation>	121	</annotation>
117	</attribute>	122	</attribute>
118	</complexType>	123	</complexType>
Lines 120-128 Link Here
120		125
121	<element name="binding">	126	<element name="binding">
122	<annotation>	127	<annotation>
123	<appInfo>	128	<appinfo>
124	<meta.element labelAttribute="context"/>	129	<meta.element labelAttribute="context"/>
125	</appInfo>	130	</appinfo>
126	<documentation>	131	<documentation>
127	<p>	132	<p>
128	Declares a binding between a client context and one or more	133	Declares a binding between a client context and one or more
Lines 131-136 Link Here
131	</p>	136	</p>
132	<p>	137	<p>
133	The constraints to be bound may be specified by either:	138	The constraints to be bound may be specified by either:
		139	</p>
134	<ul>	140	<ul>
135	<li>the <code>constraint</code> attribute, to reference	141	<li>the <code>constraint</code> attribute, to reference
136	a single constraint</li>	142	a single constraint</li>
Lines 141-153 Link Here
141	and/or <code>&lt;category&gt;</code> elements to	147	and/or <code>&lt;category&gt;</code> elements to
142	reference multiple constraints and/or categories</li>	148	reference multiple constraints and/or categories</li>
143	</ul>	149	</ul>
		150	<p>
		151	Since the 1.3 release, selective exclusion of constraints and sub-categories that are contained by included categories is supported. Within a <code>&lt;binding&gt;</code> element, ordering of inclusion and exclusion elements is significant: they are processed in the order in which they are declared in the extension. However, the order of inclusions and exclusions in separate bindings for the same context is undefined.
144	</p>	152	</p>
145	</documentation>	153	</documentation>
146	</annotation>	154	</annotation>
147	<complexType>	155	<complexType>
148	<sequence>	156	<sequence>
149	<element ref="constraint" minOccurs="0" maxOccurs="unbounded"/>	157	<choice minOccurs="0" maxOccurs="unbounded">
150	<element ref="category" minOccurs="0" maxOccurs="unbounded"/>	158	<element ref="category"/>
		159	<element ref="constraint"/>
		160	<element ref="excludeCategory"/>
		161	<element ref="excludeConstraint"/>
		162	</choice>
151	</sequence>	163	</sequence>
152	<attribute name="context" type="string" use="required">	164	<attribute name="context" type="string" use="required">
153	<annotation>	165	<annotation>
Lines 185-193 Link Here
185		197
186	<element name="constraint">	198	<element name="constraint">
187	<annotation>	199	<annotation>
188	<appInfo>	200	<appinfo>
189	<meta.element labelAttribute="ref"/>	201	<meta.element labelAttribute="ref"/>
190	</appInfo>	202	</appinfo>
191	<documentation>	203	<documentation>
192	Includes a constraint in a client context	204	Includes a constraint in a client context
193	<code>&lt;binding&gt;</code>.	205	<code>&lt;binding&gt;</code>.
Lines 209-217 Link Here
209		221
210	<element name="category">	222	<element name="category">
211	<annotation>	223	<annotation>
212	<appInfo>	224	<appinfo>
213	<meta.element labelAttribute="ref"/>	225	<meta.element labelAttribute="ref"/>
214	</appInfo>	226	</appinfo>
215	<documentation>	227	<documentation>
216	Includes a constraint category in a client context	228	Includes a constraint category in a client context
217	<code>&lt;binding&gt;</code>. All of the referenced	229	<code>&lt;binding&gt;</code>. All of the referenced
Lines 233-251 Link Here
233	</complexType>	245	</complexType>
234	</element>	246	</element>
235		247
		248	<element name="excludeCategory">
		249	<annotation>
		250	<documentation>
		251	Since 1.3. Excludes a constraint category from a client context
		252	<code>&lt;binding&gt;</code>. All of the referenced
		253	category's constraints and those of any sub-categories
		254	(recursively) are excluded. This is useful when including some parent category, to filter out selective sub-categories. Not only is it simpler than explicitly including all of the desired sub-categories, but it ensures that sub-categories that are added later will be included implicitly.
		255	</documentation>
		256	</annotation>
		257	<complexType>
		258	<attribute name="ref" type="string" use="required">
		259	<annotation>
		260	<documentation>
		261	References the fully-qualified ID of a constraint category to
		262	exclude from the client context. The category ID does not
		263	necessarily include its contributing plug-in ID, but is a
		264	path reflecting the hierarchical structure of categories.
		265	</documentation>
		266	</annotation>
		267	</attribute>
		268	</complexType>
		269	</element>
		270
		271	<element name="excludeConstraint">
		272	<annotation>
		273	<documentation>
		274	Since 1.3. Excludes a constraint from a client context
		275	<code>&lt;binding&gt;</code>. This is useful when including some parent category, to filter out selective constraints cointained within it. Not only is it simpler than explicitly including all of the desired constraints and sub-categories, but it ensures that constraints and sub-categories that are added later will be included implicitly.
		276	</documentation>
		277	</annotation>
		278	<complexType>
		279	<attribute name="ref" type="string" use="required">
		280	<annotation>
		281	<documentation>
		282	References the fully-qualified ID of a constraint to exclude
		283	from the client context. The ID includes the constraint's
		284	contributing plug-in ID, if it is not explicit in the XML
		285	definition of the constraint.
		286	</documentation>
		287	</annotation>
		288	</attribute>
		289	</complexType>
		290	</element>
		291
236	<annotation>	292	<annotation>
237	<appInfo>	293	<appinfo>
238	<meta.section type="since"/>	294	<meta.section type="since"/>
239	</appInfo>	295	</appinfo>
240	<documentation>	296	<documentation>
241	1.0	297	1.0
242	</documentation>	298	</documentation>
243	</annotation>	299	</annotation>
244		300
245	<annotation>	301	<annotation>
246	<appInfo>	302	<appinfo>
247	<meta.section type="examples"/>	303	<meta.section type="examples"/>
248	</appInfo>	304	</appinfo>
249	<documentation>	305	<documentation>
250	<p>	306	<p>
251	Example of a context which includes <code>EObjects</code> in *.library resources only, not	307	Example of a context which includes <code>EObjects</code> in *.library resources only, not
Lines 291-320 Link Here
291	</documentation>	347	</documentation>
292	</annotation>	348	</annotation>
293		349
294	<annotation>
295	<appInfo>
296	<meta.section type="apiInfo"/>
297	</appInfo>
298	<documentation>
299
300	</documentation>
301	</annotation>
302		350
303	<annotation>
304	<appInfo>
305	<meta.section type="implementation"/>
306	</appInfo>
307	<documentation>
308
309	</documentation>
310	</annotation>
311		351
312	<annotation>	352	<annotation>
313	<appInfo>	353	<appinfo>
314	<meta.section type="copyright"/>	354	<meta.section type="copyright"/>
315	</appInfo>	355	</appinfo>
316	<documentation>	356	<documentation>
317	Copyright (c) 2005 IBM Corporation and others.<br>	357	Copyright (c) 2005, 2008 IBM Corporation, Zeligsoft Inc., and others.<br>
318	All rights reserved. This program and the accompanying materials	358	All rights reserved. This program and the accompanying materials
319	are made available under the terms of the Eclipse Public License v1.0	359	are made available under the terms of the Eclipse Public License v1.0
320	which accompanies this distribution, and is available at	360	which accompanies this distribution, and is available at

Lines 1-7 Link Here

(-)src/org/eclipse/emf/validation/internal/service/impl/tests/AllTests.java (-1 / +4 lines)
1	/**	1	/**
2	* <copyright>	2	* <copyright>
3	*	3	*
4	* Copyright (c) 2003, 2006 IBM Corporation and others.	4	* Copyright (c) 2003, 2008 IBM Corporation, Zeligsoft Inc., and others.
5	* All rights reserved. This program and the accompanying materials	5	* All rights reserved. This program and the accompanying materials
6	* are made available under the terms of the Eclipse Public License v1.0	6	* are made available under the terms of the Eclipse Public License v1.0
7	* which accompanies this distribution, and is available at	7	* which accompanies this distribution, and is available at
Lines 9-14 Link Here
9	*	9	*
10	* Contributors:	10	* Contributors:
11	* IBM - Initial API and implementation	11	* IBM - Initial API and implementation
		12	* Zeligsoft - Bug 249496
12	*	13	*
13	* </copyright>	14	* </copyright>
14	*	15	*
Lines 43-47 Link Here
43		44
44	addTestSuite(BatchValidatorTest.class);	45	addTestSuite(BatchValidatorTest.class);
45	addTestSuite(LiveValidatorTest.class);	46	addTestSuite(LiveValidatorTest.class);
		47
		48	addTest(ClientContextTest.suite());
46	}	49	}
47	}	50	}




         </eclass>
      </traversalStrategy>
   </extension>
   
   <!-- Constraints only used for client-context inclusion/exclusion testing -->
   <extension name="Contraints for client-context testing" point="org.eclipse.emf.validation.constraintProviders">
     <category id="clientContextTest" name="JUnit Client Context Testing Context"/>
     <category id="clientContextTest/one" name="First level of nesting"/>
     <category id="clientContextTest/one/two" name="Second level of nesting"/>
     <category id="clientContextTest/one/twoA" name="Second level of nesting (A)"/>
     <category id="clientContextTest/one/two/three" name="Third level of nesting"/>
     <category id="clientContextTest/one/two/threeA" name="Third level of nesting (A)"/>
     <constraintProvider>
         <package namespaceUri="http://www.eclipse.org/emf/2002/Ecore" />
         <constraints categories="clientContextTest/one">
            <constraint name="Dummy1.1" statusCode="1" lang="OCL" id="clientContext.1.1">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
            <constraint name="Dummy1.2" statusCode="1" lang="OCL" id="clientContext.1.2">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
         </constraints>
         <constraints categories="clientContextTest/one/two">
            <constraint name="Dummy2.1" statusCode="1" lang="OCL" id="clientContext.2.1">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
            <constraint name="Dummy2.2" statusCode="1" lang="OCL" id="clientContext.2.2">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
         </constraints>
         <constraints categories="clientContextTest/one/twoA">
            <constraint name="Dummy2a.1" statusCode="1" lang="OCL" id="clientContext.2a.1">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
            <constraint name="Dummy2a.2" statusCode="1" lang="OCL" id="clientContext.2a.2">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
         </constraints>
         <constraints categories="clientContextTest/one/two/three">
            <constraint name="Dummy3.1" statusCode="1" lang="OCL" id="clientContext.3.1">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
            <constraint name="Dummy3.2" statusCode="1" lang="OCL" id="clientContext.3.2">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
         </constraints>
         <constraints categories="clientContextTest/one/two/threeA">
            <constraint name="Dummy3a.1" statusCode="1" lang="OCL" id="clientContext.3a.1">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
            <constraint name="Dummy3a.2" statusCode="1" lang="OCL" id="clientContext.3a.2">
               <message>Nothing to say.</message>
               <target class="EAnnotation"/>
               true
            </constraint>
         </constraints>
      </constraintProvider>
   </extension>
   <!-- A client-context only used for inclusion/exclusion testing -->
   <extension point="org.eclipse.emf.validation.constraintBindings">
      <clientContext
            id="org.eclipse.emf.validation.tests.testcontext">
          <!-- We are never enabled -->
          <enablement>
            <systemTest property="BOGUS_SYSTEM_PROPERTY" value="1"/>
         </enablement>
      </clientContext>
      <binding context="org.eclipse.emf.validation.tests.testcontext">
         <category ref="clientContextTest/one"/>
         <excludeCategory ref="clientContextTest/one/two"/>
         <category ref="clientContextTest/one/two/three"/>
         <excludeConstraint ref="org.eclipse.emf.validation.tests.clientContext.1.1"/>
         <excludeConstraint ref="org.eclipse.emf.validation.tests.clientContext.2a.1"/>
         <constraint ref="org.eclipse.emf.validation.tests.clientContext.2.2"/>
         <constraint ref="org.eclipse.emf.validation.tests.clientContext.3a.2"/>
      </binding>
   </extension>
</plugin>




/**
 * <copyright>
 * 
 * Copyright (c) 2008 Zeligsoft Inc. 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:
 *   Zeligsoft - Initial API and implementation
 * 
 * </copyright>
 *
 * $Id$
 */

package org.eclipse.emf.validation.internal.service.impl.tests;

import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.ecore.EcoreFactory;
import org.eclipse.emf.validation.IValidationContext;
import org.eclipse.emf.validation.internal.service.ClientContext;
import org.eclipse.emf.validation.internal.service.ClientContextManager;
import org.eclipse.emf.validation.internal.service.IClientContext;
import org.eclipse.emf.validation.model.EvaluationMode;
import org.eclipse.emf.validation.model.IModelConstraint;
import org.eclipse.emf.validation.service.ConstraintRegistry;
import org.eclipse.emf.validation.service.IConstraintDescriptor;
import org.eclipse.emf.validation.service.ModelValidationService;

/**
 * Tests the {@link ClientContext} class.
 * 
 * @author Christian W. Damus (cdamus)
 */
@SuppressWarnings("nls")
public class ClientContextTest
		extends TestCase {

	private IModelConstraint constraint1_1;

	private IModelConstraint constraint1_2;

	private IModelConstraint constraint2_1;

	private IModelConstraint constraint2_2;

	private IModelConstraint constraint2a_1;

	private IModelConstraint constraint2a_2;

	private IModelConstraint constraint3_1;

	private IModelConstraint constraint3_2;

	private IModelConstraint constraint3a_1;

	private IModelConstraint constraint3a_2;

	private IClientContext fixture;

	/**
	 * Initialize me with my name.
	 * 
	 * @param name
	 *            my name
	 */
	public ClientContextTest(String name) {
		super(name);
	}

	public static Test suite() {
		return new TestSuite(ClientContextTest.class, "Client context tests");
	}

	public void test_includedChildOfExcludedCategory() {
		assertTrue("Constraint is excluded", fixture.includes(constraint3_1));
		assertTrue("Constraint is excluded", fixture.includes(constraint3_2));
	}

	public void test_constraintExcludedFromIncludedCategory() {
		assertFalse("Constraint is included", fixture.includes(constraint1_1));
		assertTrue("Constraint is excluded", fixture.includes(constraint1_2));
	}

	public void test_constraintIncludedInExcludedCategory() {
		assertFalse("Constraint is included", fixture.includes(constraint2_1));
		assertTrue("Constraint is excluded", fixture.includes(constraint2_2));
	}

	public void test_constraintExcludedFromIncludedCategory_nested() {
		assertFalse("Constraint is included", fixture.includes(constraint2a_1));
		assertTrue("Constraint is excluded", fixture.includes(constraint2a_2));
	}

	public void test_constraintIncludedInExcludedCategory_nested() {
		assertFalse("Constraint is included", fixture.includes(constraint3a_1));
		assertTrue("Constraint is excluded", fixture.includes(constraint3a_2));
	}

	//
	// Test framework
	//

	@Override
	protected void setUp()
			throws Exception {

		super.setUp();

		fixture = ClientContextManager.getInstance().getClientContext(
			"org.eclipse.emf.validation.tests.testcontext");

		final String prefix = "org.eclipse.emf.validation.tests.clientContext.";
		final ConstraintRegistry reg = ConstraintRegistry.getInstance();

		// cause our test constraints to be created
		ModelValidationService.getInstance().newValidator(EvaluationMode.BATCH)
			.validate(EcoreFactory.eINSTANCE.createEAnnotation());

		constraint1_1 = new TestConstraint(reg.getDescriptor(prefix + "1.1"));
		constraint1_2 = new TestConstraint(reg.getDescriptor(prefix + "1.2"));
		constraint2_1 = new TestConstraint(reg.getDescriptor(prefix + "2.1"));
		constraint2_2 = new TestConstraint(reg.getDescriptor(prefix + "2.2"));
		constraint2a_1 = new TestConstraint(reg.getDescriptor(prefix + "2a.1"));
		constraint2a_2 = new TestConstraint(reg.getDescriptor(prefix + "2a.2"));
		constraint3_1 = new TestConstraint(reg.getDescriptor(prefix + "3.1"));
		constraint3_2 = new TestConstraint(reg.getDescriptor(prefix + "3.2"));
		constraint3a_1 = new TestConstraint(reg.getDescriptor(prefix + "3a.1"));
		constraint3a_2 = new TestConstraint(reg.getDescriptor(prefix + "3a.2"));
	}

	private static final class TestConstraint
			implements IModelConstraint {

		private IConstraintDescriptor desc;

		TestConstraint(IConstraintDescriptor desc) {
			this.desc = desc;
		}

		public IStatus validate(IValidationContext c) {
			return Status.OK_STATUS;
		}

		public IConstraintDescriptor getDescriptor() {
			return desc;
		}
	}
}

Return to bug 249496

Lines 470-473 Link Here

(-)plugin.xml (+92 lines)
470	</eclass>	470	</eclass>
471	</traversalStrategy>	471	</traversalStrategy>
472	</extension>	472	</extension>
		473
		474	<!-- Constraints only used for client-context inclusion/exclusion testing -->
		475	<extension name="Contraints for client-context testing" point="org.eclipse.emf.validation.constraintProviders">
		476	<category id="clientContextTest" name="JUnit Client Context Testing Context"/>
		477	<category id="clientContextTest/one" name="First level of nesting"/>
		478	<category id="clientContextTest/one/two" name="Second level of nesting"/>
		479	<category id="clientContextTest/one/twoA" name="Second level of nesting (A)"/>
		480	<category id="clientContextTest/one/two/three" name="Third level of nesting"/>
		481	<category id="clientContextTest/one/two/threeA" name="Third level of nesting (A)"/>
		482	<constraintProvider>
		483	<package namespaceUri="http://www.eclipse.org/emf/2002/Ecore" />
		484	<constraints categories="clientContextTest/one">
		485	<constraint name="Dummy1.1" statusCode="1" lang="OCL" id="clientContext.1.1">
		486	<message>Nothing to say.</message>
		487	<target class="EAnnotation"/>
		488	true
		489	</constraint>
		490	<constraint name="Dummy1.2" statusCode="1" lang="OCL" id="clientContext.1.2">
		491	<message>Nothing to say.</message>
		492	<target class="EAnnotation"/>
		493	true
		494	</constraint>
		495	</constraints>
		496	<constraints categories="clientContextTest/one/two">
		497	<constraint name="Dummy2.1" statusCode="1" lang="OCL" id="clientContext.2.1">
		498	<message>Nothing to say.</message>
		499	<target class="EAnnotation"/>
		500	true
		501	</constraint>
		502	<constraint name="Dummy2.2" statusCode="1" lang="OCL" id="clientContext.2.2">
		503	<message>Nothing to say.</message>
		504	<target class="EAnnotation"/>
		505	true
		506	</constraint>
		507	</constraints>
		508	<constraints categories="clientContextTest/one/twoA">
		509	<constraint name="Dummy2a.1" statusCode="1" lang="OCL" id="clientContext.2a.1">
		510	<message>Nothing to say.</message>
		511	<target class="EAnnotation"/>
		512	true
		513	</constraint>
		514	<constraint name="Dummy2a.2" statusCode="1" lang="OCL" id="clientContext.2a.2">
		515	<message>Nothing to say.</message>
		516	<target class="EAnnotation"/>
		517	true
		518	</constraint>
		519	</constraints>
		520	<constraints categories="clientContextTest/one/two/three">
		521	<constraint name="Dummy3.1" statusCode="1" lang="OCL" id="clientContext.3.1">
		522	<message>Nothing to say.</message>
		523	<target class="EAnnotation"/>
		524	true
		525	</constraint>
		526	<constraint name="Dummy3.2" statusCode="1" lang="OCL" id="clientContext.3.2">
		527	<message>Nothing to say.</message>
		528	<target class="EAnnotation"/>
		529	true
		530	</constraint>
		531	</constraints>
		532	<constraints categories="clientContextTest/one/two/threeA">
		533	<constraint name="Dummy3a.1" statusCode="1" lang="OCL" id="clientContext.3a.1">
		534	<message>Nothing to say.</message>
		535	<target class="EAnnotation"/>
		536	true
537	</constraint>
538	<constraint name="Dummy3a.2" statusCode="1" lang="OCL" id="clientContext.3a.2">
539	<message>Nothing to say.</message>
540	<target class="EAnnotation"/>
541	true
542	</constraint>
543	</constraints>
544	</constraintProvider>
545	</extension>
546	<!-- A client-context only used for inclusion/exclusion testing -->
547	<extension point="org.eclipse.emf.validation.constraintBindings">
548	<clientContext
549	id="org.eclipse.emf.validation.tests.testcontext">
550	<!-- We are never enabled -->
551	<enablement>
552	<systemTest property="BOGUS_SYSTEM_PROPERTY" value="1"/>
553	</enablement>
554	</clientContext>
555	<binding context="org.eclipse.emf.validation.tests.testcontext">
556	<category ref="clientContextTest/one"/>
557	<excludeCategory ref="clientContextTest/one/two"/>
558	<category ref="clientContextTest/one/two/three"/>
559	<excludeConstraint ref="org.eclipse.emf.validation.tests.clientContext.1.1"/>
560	<excludeConstraint ref="org.eclipse.emf.validation.tests.clientContext.2a.1"/>
561	<constraint ref="org.eclipse.emf.validation.tests.clientContext.2.2"/>
562	<constraint ref="org.eclipse.emf.validation.tests.clientContext.3a.2"/>
563	</binding>
564	</extension>
473	</plugin>	565	</plugin>

Added Link Here

(-)src/org/eclipse/emf/validation/internal/service/impl/tests/ClientContextTest.java (+156 lines)
1	/**
2	* <copyright>
3	*
4	* Copyright (c) 2008 Zeligsoft Inc. and others.
5	* All rights reserved. This program and the accompanying materials
6	* are made available under the terms of the Eclipse Public License v1.0
7	* which accompanies this distribution, and is available at
8	* http://www.eclipse.org/legal/epl-v10.html
9	*
10	* Contributors:
11	* Zeligsoft - Initial API and implementation
12	*
13	* </copyright>
14	*
15	* $Id$
16	*/
17
18	package org.eclipse.emf.validation.internal.service.impl.tests;
19
20	import junit.framework.Test;
21	import junit.framework.TestCase;
22	import junit.framework.TestSuite;
23
24	import org.eclipse.core.runtime.IStatus;
25	import org.eclipse.core.runtime.Status;
26	import org.eclipse.emf.ecore.EcoreFactory;
27	import org.eclipse.emf.validation.IValidationContext;
28	import org.eclipse.emf.validation.internal.service.ClientContext;
29	import org.eclipse.emf.validation.internal.service.ClientContextManager;
30	import org.eclipse.emf.validation.internal.service.IClientContext;
31	import org.eclipse.emf.validation.model.EvaluationMode;
32	import org.eclipse.emf.validation.model.IModelConstraint;
33	import org.eclipse.emf.validation.service.ConstraintRegistry;
34	import org.eclipse.emf.validation.service.IConstraintDescriptor;
35	import org.eclipse.emf.validation.service.ModelValidationService;
36
37	/**
38	* Tests the {@link ClientContext} class.
39	*
40	* @author Christian W. Damus (cdamus)
41	*/
42	@SuppressWarnings("nls")
43	public class ClientContextTest
44	extends TestCase {
45
46	private IModelConstraint constraint1_1;
47
48	private IModelConstraint constraint1_2;
49
50	private IModelConstraint constraint2_1;
51
52	private IModelConstraint constraint2_2;
53
54	private IModelConstraint constraint2a_1;
55
56	private IModelConstraint constraint2a_2;
57
58	private IModelConstraint constraint3_1;
59
60	private IModelConstraint constraint3_2;
61
62	private IModelConstraint constraint3a_1;
63
64	private IModelConstraint constraint3a_2;
65
66	private IClientContext fixture;
67
68	/**
69	* Initialize me with my name.
70	*
71	* @param name
72	* my name
73	*/
74	public ClientContextTest(String name) {
75	super(name);
76	}
77
78	public static Test suite() {
79	return new TestSuite(ClientContextTest.class, "Client context tests");
80	}
81
82	public void test_includedChildOfExcludedCategory() {
83	assertTrue("Constraint is excluded", fixture.includes(constraint3_1));
84	assertTrue("Constraint is excluded", fixture.includes(constraint3_2));
85	}
86
87	public void test_constraintExcludedFromIncludedCategory() {
88	assertFalse("Constraint is included", fixture.includes(constraint1_1));
89	assertTrue("Constraint is excluded", fixture.includes(constraint1_2));
90	}
91
92	public void test_constraintIncludedInExcludedCategory() {
93	assertFalse("Constraint is included", fixture.includes(constraint2_1));
94	assertTrue("Constraint is excluded", fixture.includes(constraint2_2));
95	}
96
97	public void test_constraintExcludedFromIncludedCategory_nested() {
98	assertFalse("Constraint is included", fixture.includes(constraint2a_1));
99	assertTrue("Constraint is excluded", fixture.includes(constraint2a_2));
100	}
101
102	public void test_constraintIncludedInExcludedCategory_nested() {
103	assertFalse("Constraint is included", fixture.includes(constraint3a_1));
104	assertTrue("Constraint is excluded", fixture.includes(constraint3a_2));
105	}
106
107	//
108	// Test framework
109	//
110
111	@Override
112	protected void setUp()
113	throws Exception {
114
115	super.setUp();
116
117	fixture = ClientContextManager.getInstance().getClientContext(
118	"org.eclipse.emf.validation.tests.testcontext");
119
120	final String prefix = "org.eclipse.emf.validation.tests.clientContext.";
121	final ConstraintRegistry reg = ConstraintRegistry.getInstance();
122
123	// cause our test constraints to be created
124	ModelValidationService.getInstance().newValidator(EvaluationMode.BATCH)
125	.validate(EcoreFactory.eINSTANCE.createEAnnotation());
126
127	constraint1_1 = new TestConstraint(reg.getDescriptor(prefix + "1.1"));
128	constraint1_2 = new TestConstraint(reg.getDescriptor(prefix + "1.2"));
129	constraint2_1 = new TestConstraint(reg.getDescriptor(prefix + "2.1"));
130	constraint2_2 = new TestConstraint(reg.getDescriptor(prefix + "2.2"));
131	constraint2a_1 = new TestConstraint(reg.getDescriptor(prefix + "2a.1"));
132	constraint2a_2 = new TestConstraint(reg.getDescriptor(prefix + "2a.2"));
133	constraint3_1 = new TestConstraint(reg.getDescriptor(prefix + "3.1"));
134	constraint3_2 = new TestConstraint(reg.getDescriptor(prefix + "3.2"));
135	constraint3a_1 = new TestConstraint(reg.getDescriptor(prefix + "3a.1"));
136	constraint3a_2 = new TestConstraint(reg.getDescriptor(prefix + "3a.2"));
137	}
138
139	private static final class TestConstraint
140	implements IModelConstraint {
141
142	private IConstraintDescriptor desc;
143
144	TestConstraint(IConstraintDescriptor desc) {
145	this.desc = desc;
146	}
147
148	public IStatus validate(IValidationContext c) {
149	return Status.OK_STATUS;
150	}
151
152	public IConstraintDescriptor getDescriptor() {
153	return desc;
154	}
155	}
156	}