[RESSUP-1356] Add Sort ID to Custom Attribute Document

coeus-db/coeus-db-sql/src/main/resources/co/kuali/coeus/data/migration/sql/oracle/kc/bootstrap/V1601_002__RESSUP-1356.sql

@@ -0,0 +1,5 @@
+-- RESSUP-1356
+
+ALTER TABLE CUSTOM_ATTRIBUTE_DOCUMENT ADD SORT_ID NUMBER(12,0);
+
+

coeus-impl/src/main/java/org/kuali/coeus/common/framework/custom/CustomAttributeSortIdComparator.java

@@ -0,0 +1,49 @@
+package org.kuali.coeus.common.framework.custom;
+
+import java.util.Comparator;
+
+import org.kuali.coeus.common.framework.custom.attr.CustomAttributeDocument;
+
+   /**  Add Sort ID to Custom Attribute Document Maintenance Document */
+   /**
+    *
+    * 1. If SORT_IDs for all the custom data fields have been defined, then display them based on the 
+    *    SORT_ID in ascending order from the top to the bottom under the Full Group Name: *** sub panel
+    *    
+    * 2. If none of the custom data fields has SORT_ID defined, then display them alphabetically
+    * 
+    * 3. If some of the custom data fields have SORT_ID defined while the rest do not, then display all of the fields with a SORT_ID first, 
+    *    organized by sort ID. Then list the ones without a SORT_ID in alphabetical order.
+    *
+    */
+   public class CustomAttributeSortIdComparator implements Comparator<CustomAttributeDocument> {
+
+	   private static final int MAX_CUSTOM_DATA_SORT_ID = 999999;
+
+	   public int compare(CustomAttributeDocument cad1, CustomAttributeDocument cad2) {
+		   try {
+			   String label1 = cad1.getCustomAttribute().getLabel();
+	           String label2 = cad2.getCustomAttribute().getLabel();
+	           if (label1 == null) {
+	               label1 = "";
+	           }
+	           if (label2 == null) {
+	               label2 = "";
+	           }
+
+	           if(cad1.getSortId() == null) {
+				   cad1.setSortId(new Integer(MAX_CUSTOM_DATA_SORT_ID));
+			   }
+			   if(cad2.getSortId() == null) {
+				   cad2.setSortId(new Integer(MAX_CUSTOM_DATA_SORT_ID));
+			   }
+
+			   int sortIdComp = cad1.getSortId().compareTo(cad2.getSortId());
+			   return ((sortIdComp == 0) ? label1.compareTo(label2) : sortIdComp);
+		   }
+           catch (Exception e) {
+               return 0;
+           }
+	   }
+   }
+

coeus-impl/src/main/java/org/kuali/coeus/common/framework/custom/CustomDataHelperBase.java

@@ -1,18 +1,18 @@
 /*
  * Kuali Coeus, a comprehensive research administration system for higher education.
- * 
+ *
  * Copyright 2005-2015 Kuali, Inc.
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
  * published by the Free Software Foundation, either version 3 of the
  * License, or (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
@@ -24,6 +24,7 @@
 import org.kuali.coeus.common.framework.auth.task.TaskAuthorizationService;
 import org.kuali.coeus.sys.framework.service.KcServiceLocator;
 import org.kuali.rice.krad.util.GlobalVariables;
+import org.kuali.coeus.common.framework.custom.CustomAttributeSortIdComparator;
 
 import java.io.Serializable;
 import java.util.*;
@@ -33,24 +34,24 @@
  * The CustomDataHelperBase is the base class for all Custom Data Helper classes.
  */
 public abstract class CustomDataHelperBase<T extends DocumentCustomData> implements Serializable {
-        
+
     private SortedMap<String, List> customAttributeGroups = new TreeMap<String, List>();
-   
+
     /*
      * Is the end-user allowed to modify the custom data values?
      */
     private boolean modifyCustomData = false;
 
-    
+
     protected abstract T getNewCustomData();
 
-    public abstract boolean documentNotRouted(); 
-        
+    public abstract boolean documentNotRouted();
+
     public abstract List<T> getCustomDataList();
-    
+
     public abstract Map<String, CustomAttributeDocument> getCustomAttributeDocuments();
-    
-    
+
+
     /**
      * This method builds the custom data collections used on the form and populates the values from the collection of AwardCustomData on the Award.
      * @param customAttributeGroups
@@ -59,7 +60,7 @@ public abstract class CustomDataHelperBase<T extends DocumentCustomData> impleme
     public void buildCustomDataCollectionsOnExistingDocument(SortedMap<String, List> customAttributeGroups) {
         boolean documentNotRouted = false;
         documentNotRouted = documentNotRouted();
-        
+
         /*
          * Going through all customDataDocs and adding the custom ones already in the document
          */
@@ -74,9 +75,9 @@ public void buildCustomDataCollectionsOnExistingDocument(SortedMap<String, List>
                 }
             }
         }
-        
+
         /*
-         * Go through all the custom data documents and if the document HAS NOT ROUTED and there are new custom data documents available, 
+         * Go through all the custom data documents and if the document HAS NOT ROUTED and there are new custom data documents available,
          * add those to the document as well.
          */
         if (documentNotRouted) {
@@ -97,9 +98,9 @@ protected void addToCustomDataList(Map.Entry<String, CustomAttributeDocument> cu
         newCustomData.setCustomAttribute(customAttributeDocumentEntry.getValue().getCustomAttribute());
         newCustomData.setCustomAttributeId(customAttributeDocumentEntry.getValue().getId().longValue());
         newCustomData.setValue(customAttributeDocumentEntry.getValue().getCustomAttribute().getDefaultValue());
-        getCustomDataList().add(newCustomData);    
+        getCustomDataList().add(newCustomData);
     }
-    
+
     protected boolean alreadyExists(List<CustomAttributeDocument> entriesInCurrentGroup, Entry<String, CustomAttributeDocument> customAttributeDocumentEntry) {
         for ( CustomAttributeDocument entry : entriesInCurrentGroup) {
             if (entry.getId() == Integer.parseInt(customAttributeDocumentEntry.getKey())) {
@@ -110,13 +111,13 @@ protected boolean alreadyExists(List<CustomAttributeDocument> entriesInCurrentGr
     }
 
     protected void addToGroup(String groupName, SortedMap<String, List> customAttributeGroups, Entry<String, CustomAttributeDocument> customAttributeDocument) {
-                List<CustomAttributeDocument> customAttributeDocumentList = customAttributeGroups.get(groupName);   
-                if (customAttributeDocumentList == null) {
-                    customAttributeDocumentList = new ArrayList<CustomAttributeDocument>();
-                    customAttributeGroups.put(groupName, customAttributeDocumentList);
-                }
-        customAttributeDocumentList.add(customAttributeDocument.getValue());
+        List<CustomAttributeDocument> customAttributeDocumentList = customAttributeGroups.get(groupName);
+        if (customAttributeDocumentList == null) {
+            customAttributeDocumentList = new ArrayList<CustomAttributeDocument>();
+            customAttributeGroups.put(groupName, customAttributeDocumentList);
         }
+        customAttributeDocumentList.add(customAttributeDocument.getValue());
+    }
 
     protected boolean isMatch(T documentCustomData, Entry<String, CustomAttributeDocument> customAttributeDocumentEntry) {
         return documentCustomData.getCustomAttributeId() == ((long)customAttributeDocumentEntry.getValue().getId());
@@ -130,24 +131,23 @@ protected boolean isMatch(T documentCustomData, Entry<String, CustomAttributeDoc
     public void buildCustomDataCollectionsOnNewDocument(SortedMap<String, List> customAttributeGroups) {
         for(Map.Entry<String, CustomAttributeDocument> customAttributeDocumentEntry:getCustomAttributeDocuments().entrySet()) {
             String groupName = customAttributeDocumentEntry.getValue().getCustomAttribute().getGroupName();
-            
+
             addToCustomDataList(customAttributeDocumentEntry);
-            
+
             if (StringUtils.isEmpty(groupName)) {
                 groupName = "No Group";
             }
-            
+
             List<CustomAttributeDocument> customAttributeDocumentList = customAttributeGroups.get(groupName);
             if (customAttributeDocumentList == null) {
                 customAttributeDocumentList = new ArrayList<CustomAttributeDocument>();
                 customAttributeGroups.put(groupName, customAttributeDocumentList);
-                
+
             }
             customAttributeDocumentList.add(getCustomAttributeDocuments().get(customAttributeDocumentEntry.getValue().getId().toString()));
-            Collections.sort(customAttributeDocumentList, new LabelComparator());
         }
     }
-    
+
     public void prepareCustomData() {
         initializePermissions();
         SortedMap<String, List> customAttributeGroups = new TreeMap<String, List>();
@@ -157,10 +157,32 @@ public void prepareCustomData() {
             buildCustomDataCollectionsOnNewDocument(customAttributeGroups);
         }
         setCustomAttributeGroups(customAttributeGroups);
+        sortCustomDataBySortId();
     }
-
+
+    protected void sortCustomDataBySortId() {
+        CustomAttributeSortIdComparator customAttributeDocumentComparator = new CustomAttributeSortIdComparator();
+        List<T> unsortedCustomDataList = new ArrayList<>(getCustomDataList());
+        List<CustomAttributeDocument> sortedCustomAttributeDocuments = new ArrayList<>(getCustomAttributeDocuments().values());
+        Collections.sort(sortedCustomAttributeDocuments, customAttributeDocumentComparator);
+        getCustomDataList().clear();
+
+        for (CustomAttributeDocument customAttributeDocument : sortedCustomAttributeDocuments) {
+            for (T customData : unsortedCustomDataList) {
+                if (customData.getCustomAttributeId().equals(customAttributeDocument.getId())) {
+                    getCustomDataList().add(customData);
+                    break;
+                }
+            }
+        }
+
+        for (List<CustomAttributeDocument> groupDocuments : getCustomAttributeGroups().values()) {
+            Collections.sort(groupDocuments, customAttributeDocumentComparator);
+        }
+    }
+
     /**
-     * 
+     *
      * This method takes in a groupName from the data entry and return a valid string to use in the Map functions later.
      * Note, data entry may create a null group name, which is invalid with the Map funcitons.
      * @param groupName
@@ -169,30 +191,30 @@ public void prepareCustomData() {
     public String getValidCustomAttributeGroupName(String groupName) {
         return groupName != null ? groupName : "Custom Data Group";
     }
-    
+
     /**
      * Initialize the permissions for viewing/editing the Custom Data web page.
      */
     public void initializePermissions() {
         modifyCustomData = canModifyCustomData();
     }
-    
+
     /**
      * Can the current user modify the custom data values?
      * @return true if can modify the custom data; otherwise false
      */
     public boolean canModifyCustomData() {
         return modifyCustomData;
     }
-    
+
     /**
      * Get the ModifyCustomData value.
      * @return the ModifyCustomData value
      */
     public boolean getModifyCustomData() {
         return modifyCustomData;
     }
-    
+
     /**
      * Sets the customAttributeGroups attribute value.
      * @param customAttributeGroups The customAttributeGroups to set.
@@ -208,7 +230,7 @@ public void setCustomAttributeGroups(SortedMap<String, List> customAttributeGrou
     public Map<String, List> getCustomAttributeGroups() {
         return customAttributeGroups;
     }
-    
+
     protected TaskAuthorizationService getTaskAuthorizationService() {
         return KcServiceLocator.getService(TaskAuthorizationService.class);
     }
@@ -218,29 +240,29 @@ protected TaskAuthorizationService getTaskAuthorizationService() {
      * @return the current session's userName
      */
     protected String getUserIdentifier() {
-         return GlobalVariables.getUserSession().getPrincipalId();
+        return GlobalVariables.getUserSession().getPrincipalId();
     }
 
     /**
      * Set the custom attribute content in workflow.
      */
-   public void setCustomAttributeContent(String documentNumber, String attributeName) {
-       getCustomAttributeService().setCustomAttributeKeyValue(documentNumber, getCustomAttributeDocuments(), attributeName, getUserIdentifier());
-   } 
-   
-   protected CustomAttributeService getCustomAttributeService() {
-       return KcServiceLocator.getService(CustomAttributeService.class);
-   }
-    
+    public void setCustomAttributeContent(String documentNumber, String attributeName) {
+        getCustomAttributeService().setCustomAttributeKeyValue(documentNumber, getCustomAttributeDocuments(), attributeName, getUserIdentifier());
+    }
+
+    protected CustomAttributeService getCustomAttributeService() {
+        return KcServiceLocator.getService(CustomAttributeService.class);
+    }
+
     /**
      * Sorts custom data attributes by label for alphabetical order on custom data panels.
      */
     public class LabelComparator implements Comparator
-    {    
+    {
         public LabelComparator(){}
-        
+
         public int compare(Object cad1, Object cad2 )
-        {    
+        {
             try
             {
                 String label1 = ((CustomAttributeDocument)cad1).getCustomAttribute().getLabel();
@@ -253,7 +275,7 @@ public int compare(Object cad1, Object cad2 )
                 {
                     label2 = "";
                 }
-                return label1.compareTo(label2);  
+                return label1.compareTo(label2);
             }
             catch (Exception e)
             {

coeus-impl/src/main/java/org/kuali/coeus/common/framework/custom/attr/CustomAttributeDocument.java

@@ -1,18 +1,18 @@
 /*
  * Kuali Coeus, a comprehensive research administration system for higher education.
- * 
+ *
  * Copyright 2005-2015 Kuali, Inc.
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as
  * published by the Free Software Foundation, either version 3 of the
  * License, or (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
@@ -24,7 +24,7 @@
 import org.kuali.rice.kew.doctype.bo.DocumentType;
 
 /**
- * 
+ *
  * This class bo of CustomAttributeDocument.
  */
 public class CustomAttributeDocument extends KcPersistableBusinessObjectBase implements MutableInactivatable, CustomAttributeDocumentContract {
@@ -43,6 +43,8 @@ public class CustomAttributeDocument extends KcPersistableBusinessObjectBase imp
 
     private boolean active;
 
+    private Integer sortId;
+
     public CustomAttributeDocument() {
         super();
     }
@@ -108,4 +110,8 @@ public DocumentType getDocumentType() {
     public void setDocumentType(DocumentType documentType) {
         this.documentType = documentType;
     }
+
+    public Integer getSortId() { return sortId; }
+
+    public void setSortId(Integer sortId) { this.sortId = sortId; }
 }