Story/vspc 190 A user should be able to define the order spaces appear in the site menu of the public page

vspace/.classpath

@@ -27,26 +27,18 @@
 	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="org.eclipse.jst.component.dependency" value="/WEB-INF/lib"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="src" output="target/test-classes" path="target/generated-test-sources/test-annotations">
-		<attributes>
-			<attribute name="optional" value="true"/>
-			<attribute name="test" value="true"/>
-			<attribute name="maven.pomderived" value="true"/>
-			<attribute name="ignore_optional_problems" value="true"/>
-			<attribute name="m2e-apt" value="true"/>
-		</attributes>
-	</classpathentry>
 	<classpathentry kind="src" path="target/generated-sources/annotations">
 		<attributes>
 			<attribute name="optional" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="output" path="target/classes"/>
-</classpath>
+</classpath>

vspace/src/main/java/edu/asu/diging/vspace/core/aspects/ExhibitionDataAspect.java

@@ -29,6 +29,7 @@
 import edu.asu.diging.vspace.core.model.impl.Exhibition;
 import edu.asu.diging.vspace.core.model.impl.SpaceStatus;
 import edu.asu.diging.vspace.core.services.IExhibitionManager;
+import edu.asu.diging.vspace.core.services.IExhibitionSpaceOrderUtility;
 import edu.asu.diging.vspace.core.services.IModuleManager;
 import edu.asu.diging.vspace.core.services.ISpaceManager;
 import edu.asu.diging.vspace.web.exhibit.view.ExhibitionConstants;
@@ -49,6 +50,11 @@ public class ExhibitionDataAspect {
     @Autowired
     private AuthenticationFacade authFacade;
 
+
+    @Autowired
+    private IExhibitionSpaceOrderUtility exhibitionSpaceOrderUtility;
+
+
     @After("execution(public * edu.asu.diging.vspace.web..*Controller.*(..))")
     public void setExhibition(JoinPoint jp) {
         Object[] args = jp.getArgs();
@@ -69,6 +75,7 @@ public void setExhibition(JoinPoint jp) {
                          * spaces with null space status
                          */
                         publishedSpaces.addAll(spaceManager.getSpacesWithStatus(null));
+                        publishedSpaces = spaceManager.sortPublishedSpacesByGivenOrder(publishedSpaces);
                         ((Model) obj).addAttribute("publishedSpaces", publishedSpaces);
                     }
                 }

vspace/src/main/java/edu/asu/diging/vspace/core/data/SpacesCustomOrderRepository.java

@@ -0,0 +1,13 @@
+package edu.asu.diging.vspace.core.data;
+
+import org.javers.spring.annotation.JaversSpringDataAuditable;
+import org.springframework.data.repository.PagingAndSortingRepository;
+import org.springframework.stereotype.Repository;
+
+import edu.asu.diging.vspace.core.model.impl.SpacesCustomOrder;
+
+@Repository
+@JaversSpringDataAuditable
+public interface SpacesCustomOrderRepository extends PagingAndSortingRepository<SpacesCustomOrder, String> {
+
+}

vspace/src/main/java/edu/asu/diging/vspace/core/model/ExhibitionSpaceOrderMode.java

@@ -0,0 +1,28 @@
+package edu.asu.diging.vspace.core.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public enum ExhibitionSpaceOrderMode {
+    ALPHABETICAL("alphabetical"),
+    CREATION_DATE("creationDate"),
+    CUSTOM("custom");
+
+    private final String value;
+
+    private ExhibitionSpaceOrderMode(String value) {
+        this.value = value;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public static List<String> getAllValues() {
+        List<String> allValues = new ArrayList<>();
+        for(ExhibitionSpaceOrderMode order : ExhibitionSpaceOrderMode.values()) {
+            allValues.add(order.getValue());
+        }
+        return allValues;
+    }
+}

vspace/src/main/java/edu/asu/diging/vspace/core/model/IExhibition.java

@@ -2,6 +2,8 @@
 
 import java.util.List;
 
+import edu.asu.diging.vspace.core.model.impl.SpacesCustomOrder;
+
 public interface IExhibition extends IVSpaceElement {
 
     /*
@@ -38,4 +40,12 @@ public interface IExhibition extends IVSpaceElement {
 
     void setPreviewId(String previewId);
 
+    SpacesCustomOrder getSpacesCustomOrder();
+
+    void setSpacesCustomOrder(SpacesCustomOrder spacesCustomOrder);
+
+    void setSpaceOrderMode(ExhibitionSpaceOrderMode spaceOrderMode);
+
+    ExhibitionSpaceOrderMode getSpaceOrderMode();
+
 }

vspace/src/main/java/edu/asu/diging/vspace/core/model/ISpacesCustomOrder.java

@@ -0,0 +1,15 @@
+package edu.asu.diging.vspace.core.model;
+
+import java.util.List;
+
+public interface ISpacesCustomOrder extends IVSpaceElement { 
+
+    public String getCustomOrderName();
+
+    public void setCustomOrderName(String customOrderName);
+
+    public List<ISpace> getCustomOrderedSpaces();
+
+    public void setCustomOrderedSpaces(List<ISpace> customOrderedSpaces);
+
+}

vspace/src/main/java/edu/asu/diging/vspace/core/model/impl/Exhibition.java

@@ -1,26 +1,26 @@
 package edu.asu.diging.vspace.core.model.impl;
 
 import java.util.ArrayList;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Objects;
-import java.util.Set;
 
 import javax.persistence.CascadeType;
 import javax.persistence.Entity;
 import javax.persistence.EnumType;
 import javax.persistence.Enumerated;
 import javax.persistence.GeneratedValue;
 import javax.persistence.Id;
+import javax.persistence.JoinColumn;
 import javax.persistence.OneToMany;
 import javax.persistence.OneToOne;
+
 import org.hibernate.annotations.GenericGenerator;
 import org.hibernate.annotations.Parameter;
+
 import edu.asu.diging.vspace.core.model.ExhibitionModes;
-import edu.asu.diging.vspace.core.model.IContentBlock;
+import edu.asu.diging.vspace.core.model.ExhibitionSpaceOrderMode;
 import edu.asu.diging.vspace.core.model.IExhibition;
 import edu.asu.diging.vspace.core.model.IExhibitionLanguage;
-import edu.asu.diging.vspace.core.model.IExternalLink;
 import edu.asu.diging.vspace.core.model.ISpace;
 
 /**
@@ -47,6 +47,13 @@ public class Exhibition extends VSpaceElement implements IExhibition {
 
     private String customMessage;
 
+    @Enumerated(EnumType.STRING)
+    private ExhibitionSpaceOrderMode spaceOrderMode;
+
+    @OneToOne(targetEntity = SpacesCustomOrder.class)
+    @JoinColumn(name = "Space_Custom_Order_Id", referencedColumnName = "id")
+    private SpacesCustomOrder spacesCustomOrder;
+
     private boolean aboutPageConfigured;
 
     @OneToMany(targetEntity = ExhibitionLanguage.class, mappedBy = "exhibition", cascade = CascadeType.ALL, orphanRemoval=true)
@@ -123,6 +130,26 @@ public void setCustomMessage(String customMessage) {
     }
 
     @Override
+    public ExhibitionSpaceOrderMode getSpaceOrderMode() {
+        return spaceOrderMode;
+    }
+
+    @Override
+    public void setSpaceOrderMode(ExhibitionSpaceOrderMode spaceOrderMode) {
+        this.spaceOrderMode = spaceOrderMode;
+    }
+
+    @Override
+    public SpacesCustomOrder getSpacesCustomOrder() {
+        return spacesCustomOrder;
+    }
+
+    @Override
+    public void setSpacesCustomOrder(SpacesCustomOrder spacesCustomOrder) {
+        this.spacesCustomOrder = spacesCustomOrder;
+    }
+
+
     public boolean isAboutPageConfigured() {
         return aboutPageConfigured;
     }

vspace/src/main/java/edu/asu/diging/vspace/core/model/impl/SpacesCustomOrder.java

@@ -0,0 +1,70 @@
+package edu.asu.diging.vspace.core.model.impl;
+
+
+import java.util.List;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+import javax.persistence.Inheritance;
+import javax.persistence.InheritanceType;
+import javax.persistence.JoinColumn;
+import javax.persistence.JoinTable;
+import javax.persistence.ManyToMany;
+import javax.persistence.OrderColumn;
+
+import org.hibernate.annotations.GenericGenerator;
+import org.hibernate.annotations.Parameter;
+
+import edu.asu.diging.vspace.core.model.ISpace;
+import edu.asu.diging.vspace.core.model.ISpacesCustomOrder;
+
+@Entity
+@Inheritance(strategy = InheritanceType.JOINED)
+public class SpacesCustomOrder extends VSpaceElement implements ISpacesCustomOrder {
+
+    @Id
+    @GeneratedValue(generator = "customorder_id_generator")
+    @GenericGenerator(name = "customorder_id_generator",
+        parameters = @Parameter(name = "prefix", value = "SPC"),
+        strategy = "edu.asu.diging.vspace.core.data.IdGenerator")
+    private String id;
+
+    @Column(nullable=false)
+    private String customOrderName;
+
+    @ManyToMany(targetEntity = Space.class)
+    @JoinTable(name = "spaces_custom_orders",
+               joinColumns = @JoinColumn(name = "SpacesCustomOrder_Id", referencedColumnName="id"),
+               inverseJoinColumns = @JoinColumn(name = "Space_Id", referencedColumnName="id"))
+    @OrderColumn
+    private List<ISpace> customOrderedSpaces;
+
+    @Override
+    public String getId() {
+        return id;
+    }
+
+    @Override
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getCustomOrderName() {
+        return customOrderName;
+    }
+
+    public void setCustomOrderName(String customOrderName) {
+        this.customOrderName = customOrderName;
+    }
+
+    public List<ISpace> getCustomOrderedSpaces() {
+        return customOrderedSpaces;
+    }
+
+    public void setCustomOrderedSpaces(List<ISpace> customOrderedSpaces) {
+        this.customOrderedSpaces = customOrderedSpaces;
+    }
+
+}

vspace/src/main/java/edu/asu/diging/vspace/core/services/IExhibitionManager.java

@@ -2,6 +2,7 @@
 
 import java.util.List;
 
+import edu.asu.diging.vspace.core.model.ExhibitionSpaceOrderMode;
 import edu.asu.diging.vspace.core.model.IExhibition;
 import edu.asu.diging.vspace.core.model.impl.Exhibition;
 
@@ -33,6 +34,8 @@ public interface IExhibitionManager {
     List<IExhibition> findAll();
 
     IExhibition getStartExhibition();
+
+    IExhibition updateSpaceOrderMode(ExhibitionSpaceOrderMode mode);
 
     void updateExhibitionLanguages(Exhibition exhibition, List<String> languages, String defaultLanguage);
 

vspace/src/main/java/edu/asu/diging/vspace/core/services/IExhibitionSpaceOrderUtility.java

@@ -0,0 +1,12 @@
+package edu.asu.diging.vspace.core.services;
+
+import java.util.List;
+
+import edu.asu.diging.vspace.core.model.ExhibitionSpaceOrderMode;
+import edu.asu.diging.vspace.core.model.ISpace;
+
+public interface IExhibitionSpaceOrderUtility {
+
+    List<ISpace> sortSpaces(List<ISpace> publishedSpaces, ExhibitionSpaceOrderMode mode);
+
+}

vspace/src/main/java/edu/asu/diging/vspace/core/services/ISpaceManager.java

@@ -38,4 +38,7 @@ public interface ISpaceManager {
     Iterable<Space> addIncomingLinkInfoToSpaces(Iterable<Space> spaces);
 
     Page<ISpace> findByNameOrDescription(Pageable requestedPage,String searchText);
+
+    List<ISpace> sortPublishedSpacesByGivenOrder(List<ISpace> publishedSpaces);
+
 }

vspace/src/main/java/edu/asu/diging/vspace/core/services/ISpacesCustomOrderManager.java

@@ -0,0 +1,29 @@
+package edu.asu.diging.vspace.core.services;
+
+import java.util.List;
+
+import edu.asu.diging.vspace.core.model.ISpace;
+import edu.asu.diging.vspace.core.model.ISpacesCustomOrder;
+import edu.asu.diging.vspace.core.model.impl.SpacesCustomOrder;
+
+public interface ISpacesCustomOrderManager {
+
+    Iterable<SpacesCustomOrder> findAll();
+
+    void addSpaceToCustomOrders(ISpace space);
+
+    void save(Iterable<SpacesCustomOrder> spacesCustomOrder);
+
+    ISpacesCustomOrder get(String customSpaceOrderId);
+
+    void updateNameAndDescription(String spacesCustomOrderId, String title, String description);
+
+    void updateSpaces(String spacesCustomOrderId, List<String> spaceOrders);
+
+    ISpacesCustomOrder create(List<String> spaceOrders, String name, String description);
+
+    void setExhibitionSpacesCustomOrder(String customOrderId);
+
+    void delete(String id);
+
+}

vspace/src/main/java/edu/asu/diging/vspace/core/services/impl/ExhibitionManager.java

@@ -18,6 +18,7 @@
 import edu.asu.diging.vspace.core.data.ExhibitionRepository;
 import edu.asu.diging.vspace.core.exception.LanguageListConfigurationNotFoundException;
 import edu.asu.diging.vspace.core.factory.impl.ExhibitionFactory;
+import edu.asu.diging.vspace.core.model.ExhibitionSpaceOrderMode;
 import edu.asu.diging.vspace.core.model.IExhibition;
 import edu.asu.diging.vspace.core.model.IExhibitionLanguage;
 import edu.asu.diging.vspace.core.model.impl.Exhibition;
@@ -94,6 +95,7 @@ public IExhibition getStartExhibition() {
         }
         return exhibition;
     }
+
 
     /**
      * Updates the Exhibition with given list of languages. It fetches the language from exhibitionLanguageConfig using code.
@@ -151,4 +153,12 @@ private IExhibitionLanguage addExhibitionLanguage(Exhibition exhibition, Map lan
 
         return exhibitionLanguage;
     }
+
+    @Override
+    public IExhibition updateSpaceOrderMode(ExhibitionSpaceOrderMode mode) {
+        Exhibition exhibition = (Exhibition) getStartExhibition();
+        exhibition.setSpaceOrderMode(mode);
+        return exhibitRepo.save(exhibition);
+    }
+
 }