You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by vk...@apache.org on 2009/03/22 23:35:26 UTC

svn commit: r757269 - in /portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager: ./ src/main/java/org/apache/jetspeed/om/folder/psml/

Author: vkumar
Date: Sun Mar 22 22:35:26 2009
New Revision: 757269

URL: http://svn.apache.org/viewvc?rev=757269&view=rev
Log:
Overriding the equals method for comparing the objects

Modified:
    portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/pom.xml
    portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuDefinitionImpl.java
    portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuExcludeDefinitionImpl.java
    portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuIncludeDefinitionImpl.java
    portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuOptionsDefinitionImpl.java
    portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuSeparatorDefinitionImpl.java

Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/pom.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/pom.xml?rev=757269&r1=757268&r2=757269&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/pom.xml (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/pom.xml Sun Mar 22 22:35:26 2009
@@ -81,6 +81,10 @@
             <artifactId>commons-collections</artifactId>
         </dependency>
         <dependency>
+        	<groupId>commons-lang</groupId>
+        	<artifactId>commons-lang</artifactId>
+        </dependency>        
+        <dependency>
             <groupId>commons-logging</groupId>
             <artifactId>commons-logging</artifactId>
         </dependency>

Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuDefinitionImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuDefinitionImpl.java?rev=757269&r1=757268&r2=757269&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuDefinitionImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuDefinitionImpl.java Sun Mar 22 22:35:26 2009
@@ -20,12 +20,11 @@
 import java.util.Iterator;
 import java.util.List;
 
+import org.apache.commons.lang.StringUtils;
 import org.apache.jetspeed.om.folder.MenuDefinition;
 
 /**
- * This class implements the MenuDefinition
- * interface in a persistent object form for use by
- * the page manager component.
+ * This class implements the MenuDefinition interface in a persistent object form for use by the page manager component.
  * 
  * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
  * @version $Id$
@@ -36,58 +35,46 @@
      * name - name of menu definition
      */
     private String name;
-
     /**
      * options - comma separated option paths specification for menu
      */
     private String options;
-
     /**
      * depth - depth of inclusion for folder options
      */
     private int depth;
-
     /**
      * paths - generate ordered path options for options
      */
     private boolean paths;
-
     /**
      * regexp - interpret specified optionsas regexp
      */
     private boolean regexp;
-
     /**
      * profile - profile locator name filter for options
      */
     private String profile;
-    
     /**
      * order - comma separated list of ordering patterns for options
      */
     private String order;
-    
     /**
      * skin - skin name for menu
      */
     private String skin;
-    
     /**
      * title - title for menu
      */
     private String title;
-
     /**
      * shortTitle - short title for menu
      */
     private String shortTitle;
-
     /**
-     * menuElements - ordered polymorphic list of menu options nested
-     *                menu, separator, include, and exclude definitions
+     * menuElements - ordered polymorphic list of menu options nested menu, separator, include, and exclude definitions
      */
     private List menuElements;
-
     /**
      * menuElementImpls - ordered homogeneous list of menu elements
      */
@@ -102,7 +89,7 @@
 
     /**
      * getName - get menu name
-     *
+     * 
      * @return menu name
      */
     public String getName()
@@ -112,8 +99,9 @@
 
     /**
      * setName - set menu name
-     *
-     * @param name menu name
+     * 
+     * @param name
+     *            menu name
      */
     public void setName(String name)
     {
@@ -122,7 +110,7 @@
 
     /**
      * getOptions - get comma separated menu options if not specified as elements
-     *
+     * 
      * @return option paths specification
      */
     public String getOptions()
@@ -132,8 +120,9 @@
 
     /**
      * setOptions - set comma separated menu options if not specified as elements
-     *
-     * @param options option paths specification
+     * 
+     * @param options
+     *            option paths specification
      */
     public void setOptions(String options)
     {
@@ -142,7 +131,7 @@
 
     /**
      * getDepth - get depth of inclusion for folder menu options
-     *
+     * 
      * @return inclusion depth
      */
     public int getDepth()
@@ -152,8 +141,9 @@
 
     /**
      * setDepth - set depth of inclusion for folder menu options
-     *
-     * @param depth inclusion depth
+     * 
+     * @param depth
+     *            inclusion depth
      */
     public void setDepth(int depth)
     {
@@ -162,27 +152,28 @@
 
     /**
      * isPaths - get generate ordered path options for specified options
-     *
+     * 
      * @return paths options flag
      */
     public boolean isPaths()
     {
         return paths;
     }
-    
+
     /**
      * setPaths - set generate ordered path options for specified options
-     *
-     * @param paths paths options flag
+     * 
+     * @param paths
+     *            paths options flag
      */
     public void setPaths(boolean paths)
     {
         this.paths = paths;
     }
-    
+
     /**
      * isRegexp - get regexp flag for interpreting specified options
-     *
+     * 
      * @return regexp flag
      */
     public boolean isRegexp()
@@ -192,8 +183,9 @@
 
     /**
      * setRegexp - set regexp flag for interpreting specified options
-     *
-     * @param regexp regexp flag
+     * 
+     * @param regexp
+     *            regexp flag
      */
     public void setRegexp(boolean regexp)
     {
@@ -202,7 +194,7 @@
 
     /**
      * getProfile - get profile locator used to filter specified options
-     *
+     * 
      * @return profile locator name
      */
     public String getProfile()
@@ -212,8 +204,9 @@
 
     /**
      * setProfile - set profile locator used to filter specified options
-     *
-     * @param locatorName profile locator name
+     * 
+     * @param locatorName
+     *            profile locator name
      */
     public void setProfile(String locatorName)
     {
@@ -222,7 +215,7 @@
 
     /**
      * getOrder - get comma separated regexp ordering patterns for options
-     *
+     * 
      * @return ordering patterns list
      */
     public String getOrder()
@@ -232,8 +225,9 @@
 
     /**
      * setOrder - set comma separated regexp ordering patterns for options
-     *
-     * @param order ordering patterns list
+     * 
+     * @param order
+     *            ordering patterns list
      */
     public void setOrder(String order)
     {
@@ -242,7 +236,7 @@
 
     /**
      * getSkin - get skin name for menu
-     *
+     * 
      * @return skin name
      */
     public String getSkin()
@@ -252,8 +246,9 @@
 
     /**
      * setSkin - set skin name for menu
-     *
-     * @param name skin name
+     * 
+     * @param name
+     *            skin name
      */
     public void setSkin(String name)
     {
@@ -262,7 +257,7 @@
 
     /**
      * getTitle - get default title for menu
-     *
+     * 
      * @return title text
      */
     public String getTitle()
@@ -272,8 +267,9 @@
 
     /**
      * setTitle - set default title for menu
-     *
-     * @param title title text
+     * 
+     * @param title
+     *            title text
      */
     public void setTitle(String title)
     {
@@ -282,18 +278,19 @@
 
     /**
      * getShortTitle - get default short title for menu
-     *
+     * 
      * @return short title text
      */
     public String getShortTitle()
     {
-        return shortTitle; 
+        return shortTitle;
     }
 
     /**
      * setShortTitle - set default short title for menu
-     *
-     * @param title short title text
+     * 
+     * @param title
+     *            short title text
      */
     public void setShortTitle(String title)
     {
@@ -301,10 +298,8 @@
     }
 
     /**
-     * getMenuElements - get ordered list of menu options,
-     *                   nested menus, separators, included
-     *                   menu, and excluded menu elements
-     *
+     * getMenuElements - get ordered list of menu options, nested menus, separators, included menu, and excluded menu elements
+     * 
      * @return element list
      */
     public List getMenuElements()
@@ -314,8 +309,9 @@
 
     /**
      * setMenuElements - set ordered list of menu elements
-     *
-     * @param elements element list
+     * 
+     * @param elements
+     *            element list
      */
     public void setMenuElements(List elements)
     {
@@ -324,7 +320,7 @@
 
     /**
      * getMenuElementImpls - get ordered list of wrapped menu elements
-     *
+     * 
      * @return element list
      */
     public List getMenuElementImpls()
@@ -333,10 +329,10 @@
     }
 
     /**
-     * setMenuElementImpls - set ordered list of menu elements using
-     *                       a list of wrapped menu elements
-     *
-     * @param elements element list
+     * setMenuElementImpls - set ordered list of menu elements using a list of wrapped menu elements
+     * 
+     * @param elements
+     *            element list
      */
     public void setMenuElementImpls(List elements)
     {
@@ -344,14 +340,12 @@
     }
 
     /**
-     * unmarshalled - notification that this instance has been
-     *                loaded from the persistent store
+     * unmarshalled - notification that this instance has been loaded from the persistent store
      */
     public void unmarshalled()
     {
         // notify super class implementation
         super.unmarshalled();
-
         // unwrap menu elements and propagate
         // unmarshalled notification
         if (menuElementImpls != null)
@@ -361,25 +355,23 @@
             while (menuElementIter.hasNext())
             {
                 // unwrap menu element
-                Object menuElement = ((MenuElementImpl)menuElementIter.next()).getElement();
+                Object menuElement = ((MenuElementImpl) menuElementIter.next()).getElement();
                 menuElements.add(menuElement);
-
                 // propagate unmarshalled notification
                 if (menuElement instanceof MenuMetadataImpl)
                 {
-                    ((MenuMetadataImpl)menuElement).unmarshalled();
+                    ((MenuMetadataImpl) menuElement).unmarshalled();
                 }
             }
         }
         else
         {
-            menuElements = null;            
+            menuElements = null;
         }
     }
 
     /**
-     * marshalling - notification that this instance is to
-     *               be saved to the persistent store
+     * marshalling - notification that this instance is to be saved to the persistent store
      */
     public void marshalling()
     {
@@ -394,17 +386,48 @@
                 // wrap menu element
                 Object menuElement = menuElementIter.next();
                 menuElementImpls.add(new MenuElementImpl(menuElement));
-
                 // propagate marshalling notification
                 if (menuElement instanceof MenuDefinitionImpl)
                 {
-                    ((MenuDefinitionImpl)menuElement).unmarshalled();
+                    ((MenuDefinitionImpl) menuElement).unmarshalled();
                 }
             }
         }
         else
         {
-            menuElementImpls = null;            
+            menuElementImpls = null;
+        }
+    }
+
+    /*
+     * (non-Javadoc)
+     * @see java.lang.Object#equals(java.lang.Object)
+     */
+    @Override
+    public boolean equals(Object obj)
+    {
+        if (!(obj instanceof MenuDefinition))
+        {
+            return false;
+        }
+        else
+        {
+            
+            MenuDefinition definition = (MenuDefinition) obj;
+            if (!StringUtils.equals(definition.getName(),name) || !StringUtils.equals(definition.getOptions(),options) || definition.getDepth() != depth ||
+                definition.isPaths() != paths || definition.isRegexp() != regexp || !StringUtils.equals(definition.getProfile(),profile) ||
+                !StringUtils.equals(definition.getOrder(),order) || !StringUtils.equals(definition.getSkin(),skin) || !StringUtils.equals(definition.getTitle(),title))
+            {
+                return false;
+            }
+            if (definition.getMenuElements() != null && menuElements != null)
+            {
+                if (definition.getMenuElements().size() != menuElements.size())
+                {
+                    return false;
+                }
+            }
+            return true;
         }
     }
 }

Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuExcludeDefinitionImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuExcludeDefinitionImpl.java?rev=757269&r1=757268&r2=757269&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuExcludeDefinitionImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuExcludeDefinitionImpl.java Sun Mar 22 22:35:26 2009
@@ -16,12 +16,11 @@
  */
 package org.apache.jetspeed.om.folder.psml;
 
+import org.apache.commons.lang.StringUtils;
 import org.apache.jetspeed.om.folder.MenuExcludeDefinition;
 
 /**
- * This class implements the MenuExcludeDefinition
- * interface in a persistent object form for use by
- * the page manager component.
+ * This class implements the MenuExcludeDefinition interface in a persistent object form for use by the page manager component.
  * 
  * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
  * @version $Id$
@@ -42,7 +41,7 @@
 
     /**
      * getName - get menu name with options to exclude
-     *
+     * 
      * @return menu name
      */
     public String getName()
@@ -52,11 +51,30 @@
 
     /**
      * setName - set menu name with options to exclude
-     *
-     * @param name menu name
+     * 
+     * @param name
+     *            menu name
      */
     public void setName(String name)
     {
         this.name = name;
     }
+
+    @Override
+    public boolean equals(Object obj)
+    {
+        if (!(obj instanceof MenuExcludeDefinition))
+        {
+            return false;
+        }
+        else
+        {
+            MenuExcludeDefinition definition = (MenuExcludeDefinition) obj;
+            if (!StringUtils.equals(definition.getName(), name))
+            {
+                return false;
+            }
+            return true;
+        }
+    }
 }

Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuIncludeDefinitionImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuIncludeDefinitionImpl.java?rev=757269&r1=757268&r2=757269&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuIncludeDefinitionImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuIncludeDefinitionImpl.java Sun Mar 22 22:35:26 2009
@@ -16,6 +16,7 @@
  */
 package org.apache.jetspeed.om.folder.psml;
 
+import org.apache.commons.lang.StringUtils;
 import org.apache.jetspeed.om.folder.MenuIncludeDefinition;
 
 /**
@@ -84,4 +85,22 @@
     {
         this.nest = nest;
     }
+    
+    @Override
+    public boolean equals(Object obj)
+    {
+        if (!(obj instanceof MenuIncludeDefinition))
+        {
+            return false;
+        }
+        else
+        {
+            MenuIncludeDefinition definition = (MenuIncludeDefinition) obj;
+            if (!StringUtils.equals(definition.getName(), name)|| definition.isNest()!=nest)
+            {
+                return false;
+            }
+            return true;
+        }
+    }
 }

Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuOptionsDefinitionImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuOptionsDefinitionImpl.java?rev=757269&r1=757268&r2=757269&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuOptionsDefinitionImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuOptionsDefinitionImpl.java Sun Mar 22 22:35:26 2009
@@ -16,12 +16,12 @@
  */
 package org.apache.jetspeed.om.folder.psml;
 
+import org.apache.commons.lang.StringUtils;
 import org.apache.jetspeed.om.folder.MenuOptionsDefinition;
+import org.apache.jetspeed.om.folder.MenuSeparatorDefinition;
 
 /**
- * This class implements the MenuOptionsDefinition
- * interface in a persistent object form for use by
- * the page manager component.
+ * This class implements the MenuOptionsDefinition interface in a persistent object form for use by the page manager component.
  * 
  * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
  * @version $Id$
@@ -32,37 +32,31 @@
      * options - comma separated option paths specification for menu
      */
     private String options;
-
     /**
      * depth - depth of inclusion for folder options
      */
     private int depth;
-
     /**
      * paths - generate ordered path options for options
      */
     private boolean paths;
-
     /**
      * regexp - interpret specified optionsas regexp
      */
     private boolean regexp;
-
     /**
      * profile - profile locator name filter for options
      */
     private String profile;
-    
     /**
      * order - comma separated list of ordering patterns for options
      */
     private String order;
-    
     /**
      * skin - skin name for menu
      */
     private String skin;
-    
+
     /**
      * MenuOptionsDefinitionImpl - constructor
      */
@@ -72,7 +66,7 @@
 
     /**
      * getOptions - get comma separated menu options
-     *
+     * 
      * @return option paths specification
      */
     public String getOptions()
@@ -82,8 +76,9 @@
 
     /**
      * setOptions - set comma separated menu options
-     *
-     * @param options option paths specification
+     * 
+     * @param options
+     *            option paths specification
      */
     public void setOptions(String options)
     {
@@ -92,7 +87,7 @@
 
     /**
      * getDepth - get depth of inclusion for folder options
-     *
+     * 
      * @return inclusion depth
      */
     public int getDepth()
@@ -102,8 +97,9 @@
 
     /**
      * setDepth - set depth of inclusion for folder options
-     *
-     * @param depth inclusion depth
+     * 
+     * @param depth
+     *            inclusion depth
      */
     public void setDepth(int depth)
     {
@@ -112,27 +108,28 @@
 
     /**
      * isPaths - get generate ordered path options
-     *
+     * 
      * @return paths options flag
      */
     public boolean isPaths()
     {
         return paths;
     }
-    
+
     /**
      * setPaths - set generate ordered path options
-     *
-     * @param paths paths options flag
+     * 
+     * @param paths
+     *            paths options flag
      */
     public void setPaths(boolean paths)
     {
         this.paths = paths;
     }
-    
+
     /**
      * isRegexp - get regexp flag for interpreting options
-     *
+     * 
      * @return regexp flag
      */
     public boolean isRegexp()
@@ -142,8 +139,9 @@
 
     /**
      * setRegexp - set regexp flag for interpreting options
-     *
-     * @param regexp regexp flag
+     * 
+     * @param regexp
+     *            regexp flag
      */
     public void setRegexp(boolean regexp)
     {
@@ -152,7 +150,7 @@
 
     /**
      * getProfile - get profile locator used to filter options
-     *
+     * 
      * @return profile locator name
      */
     public String getProfile()
@@ -162,8 +160,9 @@
 
     /**
      * setProfile - set profile locator used to filter options
-     *
-     * @param locatorName profile locator name
+     * 
+     * @param locatorName
+     *            profile locator name
      */
     public void setProfile(String locatorName)
     {
@@ -172,7 +171,7 @@
 
     /**
      * getOrder - get comma separated regexp ordering patterns
-     *
+     * 
      * @return ordering patterns list
      */
     public String getOrder()
@@ -182,8 +181,9 @@
 
     /**
      * setOrder - set comma separated regexp ordering patterns
-     *
-     * @param order ordering patterns list
+     * 
+     * @param order
+     *            ordering patterns list
      */
     public void setOrder(String order)
     {
@@ -192,7 +192,7 @@
 
     /**
      * getSkin - get skin name for options
-     *
+     * 
      * @return skin name
      */
     public String getSkin()
@@ -202,11 +202,32 @@
 
     /**
      * setSkin - set skin name for options
-     *
-     * @param name skin name
+     * 
+     * @param name
+     *            skin name
      */
     public void setSkin(String name)
     {
         skin = name;
     }
+
+    @Override
+    public boolean equals(Object obj)
+    {
+        if (!(obj instanceof MenuOptionsDefinition))
+        {
+            return false;
+        }
+        else
+        {
+            MenuOptionsDefinition definition = (MenuOptionsDefinition) obj;
+            if (!StringUtils.equals(definition.getOptions(), options) || !StringUtils.equals(definition.getProfile(), profile) ||
+                !StringUtils.equals(definition.getOrder(), order) || !StringUtils.equals(definition.getSkin(), skin) || definition.getDepth() != depth ||
+                definition.isPaths() != paths || definition.isRegexp() != regexp)
+            {
+                return false;
+            }
+            return true;
+        }
+    }
 }

Modified: portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuSeparatorDefinitionImpl.java
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuSeparatorDefinitionImpl.java?rev=757269&r1=757268&r2=757269&view=diff
==============================================================================
--- portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuSeparatorDefinitionImpl.java (original)
+++ portals/jetspeed-2/portal/trunk/components/jetspeed-page-manager/src/main/java/org/apache/jetspeed/om/folder/psml/MenuSeparatorDefinitionImpl.java Sun Mar 22 22:35:26 2009
@@ -16,6 +16,7 @@
  */
 package org.apache.jetspeed.om.folder.psml;
 
+import org.apache.commons.lang.StringUtils;
 import org.apache.jetspeed.om.folder.MenuSeparatorDefinition;
 
 /**
@@ -174,4 +175,22 @@
             }
         }
     }
+    @Override
+    public boolean equals(Object obj)
+    {
+        if (!(obj instanceof MenuSeparatorDefinition))
+        {
+            return false;
+        }
+        else
+        {
+            MenuSeparatorDefinition definition = (MenuSeparatorDefinition) obj;
+            if (!StringUtils.equals(definition.getTitle(), title)|| !StringUtils.equals(definition.getText(),text))
+            {
+                return false;
+            }
+            return true;
+        }
+    }
+    
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org