Remove declaration model component and validation rule - need to check for duplicate declarations in a different way.

Author: Gary Brown

integration/eclipse/plugins/org.scribble.protocol.designer/src/java/org/scribble/protocol/designer/editor/outliner/DefaultModelOutliner.java

@@ -41,9 +41,13 @@ public String getLabel(ModelReference ref, Object obj) {
 
 		if (ret == null) {
 
+			/* TODO:
+			 * Find way to extract name from protocol objects.
+			 * 
 			if (obj instanceof org.scribble.protocol.model.Declaration) {
 				ret = ((org.scribble.protocol.model.Declaration)obj).getName();
 			}
+			*/
 		}
 
 		return(ret);
@@ -64,9 +68,11 @@ public org.eclipse.swt.graphics.Image getImage(ModelReference ref, Object obj) {
 
 		if (ret == null) {
 
-			if (obj instanceof org.scribble.protocol.model.Declaration) {
-				ret = ScribbleImages.getImage("declaration.png");
-			} else if (obj instanceof org.scribble.protocol.model.Activity) {
+			/*
+			 * TODO:
+			 * Find way to derive images from the relevant model types
+			 */
+			if (obj instanceof org.scribble.protocol.model.Activity) {
 				ret = ScribbleImages.getImage("activity.png");
 			}
 		}

modules/org.scribble.protocol.conformance/src/main/java/org/scribble/protocol/conformance/impl/BehaviourList.java

@@ -158,7 +158,7 @@ protected java.util.Map<String,String> getNameMap(java.util.List<DeclarationBind
 		while (iter.hasNext()) {
 			DeclarationBinding db=iter.next();
 
-			ret.put(db.getBoundName(), db.getDeclaration().getName());
+			ret.put(db.getBoundName(), db.getLocalName());
 		}
 
 		return(ret);

modules/org.scribble.protocol.parser/src/main/java/org/scribble/protocol/parser/antlr/ProtocolTreeAdaptor.java

@@ -268,7 +268,7 @@ public void addChild(Object parent, Object child) {
 								java.util.List list=(java.util.List)
 										pds[i].getReadMethod().invoke(parent);
 
-								_log.finest("Adding "+child+" to list: "+
+								_log.info("Adding "+child+" to list: "+
 										list+" on parent "+parent);
 								list.add(child);
 							}

modules/org.scribble.protocol/src/main/java/org/scribble/protocol/model/Channel.java

@@ -19,7 +19,7 @@
 /**
  * This class represents the channel declaration.
  */
-public class Channel extends Declaration {
+public class Channel extends ModelObject {
 
 	private static final long serialVersionUID = 1158151945766114601L;
 

modules/org.scribble.protocol/src/main/java/org/scribble/protocol/model/DeclarationBinding.java

@@ -31,33 +31,33 @@ public DeclarationBinding() {
 	}
 
 	/**
-	 * This constructor initializes the declaration and bound
+	 * This constructor initializes the declaration (local name) and bound
 	 * name.
 	 * 
-	 * @param decl The declaration
+	 * @param localName The local name
 	 * @param boundName The bound name
 	 */
-	public DeclarationBinding(Declaration decl, String boundName) {
-		m_declaration = decl;
+	public DeclarationBinding(String localName, String boundName) {
+		m_localName = localName;
 		m_boundName = boundName;
 	}
 
 	/**
-	 * This method sets the declaration.
+	 * This method sets the local name.
 	 * 
-	 * @param decl The declaration
+	 * @param localName The local name
 	 */
-	public void setDeclaration(Declaration decl) {
-		m_declaration = decl;
+	public void setLocalName(String localName) {
+		m_localName = localName;
 	}
 
 	/**
-	 * This method returns the declaration.
+	 * This method returns the local name.
 	 * 
-	 * @return The declaration
+	 * @return The local name
 	 */
-	public Declaration getDeclaration() {
-		return(m_declaration);
+	public String getLocalName() {
+		return(m_localName);
 	}
 
 	/**
@@ -88,6 +88,6 @@ public void visit(Visitor visitor) {
 		visitor.visitDeclarationBinding(this);
 	}
 
-	private Declaration m_declaration=null;
+	private String m_localName=null;
 	private String m_boundName=null;
 }

modules/org.scribble.protocol/src/main/java/org/scribble/protocol/model/ModelInclude.java

@@ -42,15 +42,15 @@ public java.util.List<DeclarationBinding> getBindings() {
 	 * @param decl The declaration
 	 * @return The declaration binding, or null if not found
 	 */
-	public DeclarationBinding getDeclarationBinding(Declaration decl) {
+	public DeclarationBinding getDeclarationBinding(String declName) {
 		DeclarationBinding ret=null;
 
 		java.util.Iterator<DeclarationBinding> iter=getBindings().iterator();
 
 		while (ret == null && iter.hasNext()) {
 			ret = iter.next();
 
-			if (ret.getDeclaration() != decl) {
+			if (ret.getLocalName().equals(declName) == false) {
 				ret = null;
 			}
 		}

modules/org.scribble.protocol/src/main/java/org/scribble/protocol/model/Participant.java

@@ -20,7 +20,7 @@
  * This class represents a role.
  * 
  */
-public class Participant extends Declaration {
+public class Participant extends ModelObject {
 
 	private static final long serialVersionUID = 3368940100177769548L;
 

modules/org.scribble.protocol/src/main/java/org/scribble/protocol/model/Protocol.java

@@ -16,7 +16,6 @@
  */
 package org.scribble.protocol.model;
 
-
 /**
  * This class represents the protocol notation.
  */
@@ -231,77 +230,6 @@ public Protocol getSubProtocol(SubProtocolPath subPath) {
 		return(ret);
 	}
 
-	/**
-	 * This method return the top level declarations associated
-	 * with the definition.
-	 * 
-	 * @return The declarations
-	 */
-	public java.util.Set<Declaration> getDeclarations() {
-		java.util.Set<Declaration> ret=new java.util.HashSet<Declaration>();
-		
-		// Check if definition has a located role
-		if (getLocatedName().getParticipant() != null) {
-			ret.add(getLocatedName().getParticipant());
-		}
-		
-		// Check activities for suitable declarations
-		java.util.Iterator<Activity> iter=getBlock().getContents().iterator();
-		
-		while (iter.hasNext()) {
-			Activity act=iter.next();
-			
-			if (act instanceof ParticipantList) {
-				ret.addAll(((ParticipantList)act).getParticipants());
-			} else if (act instanceof ChannelList) {
-				ret.addAll(((ChannelList)act).getChannels());
-			}
-		}
-		
-		return(ret);
-	}
-		
-	/**
-	 * This method returns the named top level declaration,
-	 * associated with this definition.
-	 * 
-	 * @param name The declaration name
-	 * @return The declaration, or null if not found
-	 */
-	public Declaration getDeclaration(String name) {
-		Declaration ret=null;
-		
-		java.util.Iterator<Declaration> iter=getDeclarations().iterator();
-		while (ret == null && iter.hasNext()) {
-			ret = iter.next();
-			
-			if (ret.getName().equals(name) == false) {
-				ret = null;
-			}
-		}
-		
-		return(ret);
-	}
-	
-	/**
-	 * This method returns the list of roles defined at
-	 * the top level of the definition.
-	 * 
-	 * @return The list of roles
-	 */
-	public java.util.List<Participant> getRoles() {
-		java.util.List<Participant> ret=new java.util.Vector<Participant>();
-		
-		for (int i=0; i < getBlock().getContents().size(); i++) {
-		
-			if (getBlock().getContents().get(i) instanceof ParticipantList) {
-				ret.addAll(((ParticipantList)getBlock().getContents().get(i)).getParticipants());
-			}
-		}
-		
-		return(ret);
-	}
-	
 	/**
 	 * This method returns the optional located role
 	 * associated with the enclosing definition.

modules/org.scribble.protocol/src/main/java/org/scribble/protocol/model/Recursion.java

@@ -20,7 +20,7 @@
  * This class represents the RecursionBlock construct.
  * 
  */
-public class Recursion extends Declaration
+public class Recursion extends ModelObject
 				implements SinglePathBehaviour {
 
 	private static final long serialVersionUID = -3777899920653462575L;

modules/org.scribble.protocol/src/main/java/org/scribble/protocol/validation/rules/DeclarationValidatorUtil.java

@@ -0,0 +1,119 @@
+/*
+ * Copyright 2009 Scribble.org
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package org.scribble.protocol.validation.rules;
+
+import java.util.logging.Logger;
+
+import org.scribble.common.logging.Journal;
+import org.scribble.protocol.model.Activity;
+import org.scribble.protocol.model.Block;
+import org.scribble.protocol.model.ModelObject;
+import org.scribble.protocol.model.Protocol;
+import org.scribble.protocol.validation.ProtocolComponentValidatorRule;
+
+/**
+ * This class provides the validation util for the Declaration
+ * model component.
+ *
+ */
+public class DeclarationValidatorUtil {
+
+	private static final Logger _log=Logger.getLogger(DeclarationValidatorUtil.class.getName());
+	
+	/**
+	 * This method validates the supplied model object.
+	 * 
+	 * @param obj The model object being validated
+	 * @param logger The logger
+	 */
+	public static void validate(ModelObject obj,
+					Journal logger) {		
+		
+		/*
+		 * TODO: Change implementation so that the enclosing protocol is 
+		 * processed to build up the declarations within the scope,
+		 * and when the current declaration is checked, it should see
+		 * whether the name is already in the declarations.
+		 *
+		
+		// Check name has been defined
+		if (elem.getName() != null &&
+				elem.getName().trim().length() >= 0) {
+		
+			// Check all grouping constructs containing the
+			// declaration, to ensure that only one declaration
+			// exists with this name, in the scope
+			Block b=null;
+			Activity cur=elem;
+			
+			if (cur.getParent() instanceof Block) {
+				b = (Block)elem.getParent();
+			}
+			
+			while (cur != null && b != null) {
+				int index=b.indexOf(cur);
+				
+				if (index == -1) {
+					_log.warning("Declaration not part of parent block");
+					cur = null;
+				} else {
+					for (int i=0; i < index; i++) {
+						ModelObject mo=b.get(i);
+						
+						if (mo instanceof Declaration) {
+							Declaration decl=(Declaration)mo;
+							
+							if (decl.getName() != null &&
+									elem.getName().equals(decl.getName())) {
+								logger.error(org.scribble.common.util.MessageUtil.format(
+										java.util.PropertyResourceBundle.getBundle(
+										"org.scribble.protocol.validation.rules.Messages"),
+											"_EXISTING_DECLARATION",
+											new String[]{elem.getName()}),
+											obj.getProperties());
+								
+								// Quit loop
+								cur = null;
+							}
+						}
+					}
+					
+					if (cur != null) {
+						
+						if (b.getParent() instanceof Activity) {
+							cur = (Activity)b.getParent();
+							
+							// Only continue if the current object
+							// is not a definition, and it is contained
+							// inside a block
+							if ((cur instanceof Protocol) == false &&
+									cur.getParent() instanceof Block) {
+								b = (Block)cur.getParent();
+							} else {
+								b = null;
+							}
+						} else {
+							b = null;
+							cur = null;
+						}
+					}
+				}
+			}
+		}
+		*/
+	}
+}