diff options
Diffstat (limited to 'sandbox/org.eclipse.papyrus.constraints/src/org/eclipse/papyrus/infra/constraints/constraints/AbstractConstraint.java')
| -rw-r--r-- | sandbox/org.eclipse.papyrus.constraints/src/org/eclipse/papyrus/infra/constraints/constraints/AbstractConstraint.java | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/sandbox/org.eclipse.papyrus.constraints/src/org/eclipse/papyrus/infra/constraints/constraints/AbstractConstraint.java b/sandbox/org.eclipse.papyrus.constraints/src/org/eclipse/papyrus/infra/constraints/constraints/AbstractConstraint.java new file mode 100644 index 00000000000..10a29f39841 --- /dev/null +++ b/sandbox/org.eclipse.papyrus.constraints/src/org/eclipse/papyrus/infra/constraints/constraints/AbstractConstraint.java @@ -0,0 +1,219 @@ +/*****************************************************************************
+ * Copyright (c) 2010 CEA LIST.
+ *
+ * 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:
+ * Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation
+ *****************************************************************************/
+package org.eclipse.papyrus.infra.constraints.constraints;
+
+import java.util.Iterator;
+
+import org.eclipse.jface.viewers.IStructuredSelection;
+import org.eclipse.papyrus.infra.constraints.Activator;
+import org.eclipse.papyrus.infra.constraints.ConfigProperty;
+import org.eclipse.papyrus.infra.constraints.ConstraintDescriptor;
+import org.eclipse.papyrus.infra.constraints.DisplayUnit;
+import org.eclipse.papyrus.infra.constraints.ReferenceProperty;
+import org.eclipse.papyrus.infra.constraints.SimpleConstraint;
+import org.eclipse.papyrus.infra.constraints.ValueProperty;
+
+/**
+ * An abstract implementation for the Constraint interface.
+ *
+ * @author Camille Letavernier
+ *
+ */
+public abstract class AbstractConstraint implements Constraint {
+
+ /**
+ * The descriptor used to instantiate this constraint.
+ * Contains some attributes for this constraint
+ */
+ protected ConstraintDescriptor descriptor;
+
+ /**
+ * The display unit (Section or View) associated to this constraint
+ */
+ protected DisplayUnit display;
+
+ public final void setConstraintDescriptor(ConstraintDescriptor descriptor) {
+ this.descriptor = descriptor;
+ display = getDisplay(descriptor);
+ if(descriptor instanceof SimpleConstraint) {
+ setDescriptor((SimpleConstraint)descriptor);
+ }
+ }
+
+ private DisplayUnit getDisplay(ConstraintDescriptor descriptor) {
+ if(descriptor.getDisplay() == null) {
+ if(descriptor.eContainer() instanceof ConstraintDescriptor) {
+ return getDisplay((ConstraintDescriptor)descriptor.eContainer());
+ }
+ }
+ return descriptor.getDisplay();
+ }
+
+ public DisplayUnit getDisplayUnit() {
+ return display;
+ }
+
+ /**
+ * A constraint for a Single element (Exactly one) overrides
+ * the same constraint for a multiple element (One or more)
+ */
+ public boolean overrides(Constraint constraint) {
+ if(equivalent(constraint)) {
+ if(getDisplayUnit().getElementMultiplicity() == 1) {
+ if(constraint.getDisplayUnit().getElementMultiplicity() != 1) {
+ return true;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Tests if two constraints are equivalent.
+ * Two constraints are equivalent if they have the same parameters.
+ * Two equivalent constraints may have different Display units, with
+ * different multiplicities.
+ *
+ * @param constraint
+ * @return
+ * True if this object is equivalent to the given constraint
+ */
+ protected abstract boolean equivalent(Constraint constraint);
+
+ public ConstraintDescriptor getDescriptor() {
+ return descriptor;
+ }
+
+ /**
+ * Returns the ConfigProperty corresponding to the given propertyName
+ *
+ * @param propertyName
+ * The name of the property to retrieve
+ * @return
+ * The ConfigProperty corresponding to the given propertyName
+ */
+ protected ConfigProperty getProperty(String propertyName) {
+ if(descriptor == null || !(descriptor instanceof SimpleConstraint)) {
+ Activator.log.warn("The constraint descriptor has not been set for this constraint : " + this); //$NON-NLS-1$
+ } else {
+ for(ConfigProperty property : ((SimpleConstraint)descriptor).getProperties()) {
+ if(property.getName().equals(propertyName)) {
+ return property;
+ }
+ }
+ }
+
+ Activator.log.warn("The property " + propertyName + " has not been set for constraint " + descriptor.getName()); //$NON-NLS-1$ //$NON-NLS-2$
+
+ return null;
+ }
+
+ /**
+ * Returns the value associated to the given property
+ *
+ * @param propertyName
+ * The name of the property for which we want to retrieve the value
+ * The name must correspond to a valid ValueProperty
+ * @return
+ * The value associated to the given property
+ *
+ * @see #getReferenceValue(String)
+ */
+ protected String getValue(String propertyName) {
+ ConfigProperty property = getProperty(propertyName);
+
+ if(property instanceof ValueProperty) {
+ return ((ValueProperty)property).getValue();
+ }
+
+ Activator.log.warn("The property " + propertyName + " is not a ValueProperty (Constraint " + descriptor.getName() + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+
+ return null;
+ }
+
+ /**
+ * Returns the value associated to the given property
+ *
+ * @param propertyName
+ * The name of the property for which we want to retrieve the value
+ * The name must correspond to a valid ReferenceProperty
+ * @return
+ * The value associated to the given property
+ *
+ * @see #getValue(String)
+ */
+ protected Object getReferenceValue(String propertyName) {
+ ConfigProperty property = getProperty(propertyName);
+ if(property instanceof ReferenceProperty) {
+ return ((ReferenceProperty)property).getValue();
+ }
+
+ Activator.log.warn("The property " + propertyName + " is not a ReferenceProperty (Constraint " + descriptor.getName() + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+
+ return null;
+ }
+
+ /**
+ * Sets the Constraint Descriptor for this constraint.
+ * The constraint descriptor may contain some parameters to configure this
+ * constraint.
+ * Implementors may override.
+ *
+ * @param descriptor
+ * The constraint descriptor to be associated to this constraint
+ *
+ * @see #setConstraintDescriptor(ConstraintDescriptor)
+ */
+ protected void setDescriptor(SimpleConstraint descriptor) {
+ //Implementors may override
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * The default implementation matches a selection iff the constraint matches
+ * each object of the selection.
+ */
+ public boolean match(IStructuredSelection selection) {
+ if(selection.isEmpty()) {
+ return false;
+ }
+
+
+ int elementMultiplicity;
+
+ elementMultiplicity = display.getElementMultiplicity();
+
+ int selectionSize = selection.size();
+ if(elementMultiplicity == 1) {
+ if(selectionSize == 1) {
+ if(match(selection.getFirstElement())) {
+ return true;
+ }
+ }
+ } else if(elementMultiplicity == selectionSize || elementMultiplicity < 0) {
+ Iterator<?> selectionIterator = selection.iterator();
+ while(selectionIterator.hasNext()) {
+ Object selectedItem = selectionIterator.next();
+ if(!match(selectedItem)) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ return false;
+ }
+
+}
|