alfresco-community-repo/source/java/org/alfresco/web/config/ViewsConfigElement.java

/*
 * Copyright (C) 2005 Alfresco, Inc.
 *
 * Licensed under the Mozilla Public License version 1.1 
 * with a permitted attribution clause. You may obtain a
 * copy of the License at
 *
 *   http://www.alfresco.org/legal/license.txt
 *
 * 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.alfresco.web.config;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.alfresco.config.ConfigElement;
import org.alfresco.config.ConfigException;
import org.alfresco.config.element.ConfigElementAdapter;

/**
 * Custom config element that represents config values for views in the client
 * 
 * @author Gavin Cornwell
 */
public class ViewsConfigElement extends ConfigElementAdapter
{
   public static final String CONFIG_ELEMENT_ID = "views";
   public static final String VIEW_DETAILS = "details";
   public static final String VIEW_ICONS = "icons";
   public static final String VIEW_LIST = "list";
   public static final String VIEW_BUBBLE = "bubble";
   
   private static final String SEPARATOR = ":";
   
   // defaults
   private int defaultPageSize = 10;
   private String defaultView = "details";
   private String defaultSortColumn = "name";
   
   // list to store all the configured views
   private List<String> views = new ArrayList<String>(4);

   // map to store all the default views 
   private Map<String, String> defaultViews = new HashMap<String, String>(4);
   
   // map to store all default page sizes for configured client views
   private Map<String, Integer> pageSizes = new HashMap<String, Integer>(10);
   
   // map to store default sort columns for configured views
   private Map<String, String> sortColumns = new HashMap<String, String>(4);
   
   // list of pages that have been configured to have ascending sorts
   private List<String> descendingSorts = new ArrayList<String>(1);
   
   /**
    * Default Constructor
    */
   public ViewsConfigElement()
   {
      super(CONFIG_ELEMENT_ID);
      
      // add the default page sizes to the map
      this.pageSizes.put(VIEW_DETAILS, defaultPageSize);
      this.pageSizes.put(VIEW_LIST, defaultPageSize);
      this.pageSizes.put(VIEW_ICONS, 9);
      this.pageSizes.put(VIEW_BUBBLE, 5);
   }
   
   /**
    * Constructor
    * 
    * @param name Name of the element this config element represents
    */
   public ViewsConfigElement(String name)
   {
      super(name);
   }

   /**
    * @see org.alfresco.config.element.ConfigElementAdapter#getChildren()
    */
   @Override
   public List<ConfigElement> getChildren()
   {
      throw new ConfigException("Reading the views config via the generic interfaces is not supported");
   }
   
   /**
    * @see org.alfresco.config.element.ConfigElementAdapter#combine(org.alfresco.config.ConfigElement)
    */
   public ConfigElement combine(ConfigElement configElement)
   {
      ViewsConfigElement existingElement = (ViewsConfigElement)configElement;
      ViewsConfigElement newElement = new ViewsConfigElement();
      
      // copy all the config from this element into the new one
      for (String viewImpl : this.views)
      {
         newElement.addView(viewImpl);
      }
      
      for (String page : this.defaultViews.keySet())
      {
         newElement.addDefaultView(page, this.defaultViews.get(page));
      }
      
      for (String pageView : this.pageSizes.keySet())
      {
         if (pageView.indexOf(SEPARATOR) != -1)
         {
            String page = pageView.substring(0, pageView.indexOf(SEPARATOR));
            String view = pageView.substring(pageView.indexOf(SEPARATOR)+1);
            newElement.addDefaultPageSize(page, view, this.pageSizes.get(pageView).intValue());
         }
      }
      
      for (String page : this.sortColumns.keySet())
      {
         newElement.addDefaultSortColumn(page, this.sortColumns.get(page));
      }
      
      for (String page : this.descendingSorts)
      {
         newElement.addDescendingSort(page);
      }
      
      // copy all the config from the element to be combined into the new one
      for (String viewImpl : existingElement.getViews())
      {
         newElement.addView(viewImpl);
      }
      
      Map<String, String> existingDefaultViews = existingElement.getDefaultViews();
      for (String page : existingDefaultViews.keySet())
      {
         newElement.addDefaultView(page, existingDefaultViews.get(page));
      }
      
      Map<String, Integer> existingPageSizes = existingElement.getDefaultPageSizes();
      for (String pageView : existingPageSizes.keySet())
      {
         if (pageView.indexOf(SEPARATOR) != -1)
         {
            String page = pageView.substring(0, pageView.indexOf(SEPARATOR));
            String view = pageView.substring(pageView.indexOf(SEPARATOR)+1);
            newElement.addDefaultPageSize(page, view, existingPageSizes.get(pageView).intValue());
         }
      }
      
      Map<String, String> existingSortColumns = existingElement.getDefaultSortColumns();
      for (String page : existingSortColumns.keySet())
      {
         newElement.addDefaultSortColumn(page, existingSortColumns.get(page));
      }
      
      // TODO: There is a potential problem here - how would you remove the
      //       descending sort for a page
      for (String page : existingElement.getDescendingSorts())
      {
         newElement.addDescendingSort(page);
      }
      
      return newElement;
   }

   /**
    * Adds a configured view
    * 
    * @param renderer The implementation class of the view (the renderer)
    */
   /*package*/ void addView(String renderer)
   {
      this.views.add(renderer);
   }
   
   /**
    * Returns a map of configured views for the client
    * 
    * @return List of the implementation classes for the configured views
    */
   public List<String> getViews()
   {
      return this.views;
   }
   
   /**
    * Adds a default view setting
    * 
    * @param page The page to set the default view for
    * @param view The view name that will be the default
    */
   /*package*/ void addDefaultView(String page, String view)
   {
      this.defaultViews.put(page, view);
   }
   
   /**
    * Returns the default view for the given page
    * 
    * @param page The page to get the default view for
    * @return The defualt view, if there isn't a configured default for the
    *         given page 'details' will be returned
    */
   public String getDefaultView(String page)
   {
      String view = this.defaultViews.get(page);
      
      if (view == null)
      {
         view = this.defaultView;
      }
      
      return view;
   }

   /**
    * Returns a map of default views for each page
    * 
    * @return Map of default views
    */
   /*package*/ Map<String, String> getDefaultViews()
   {
      return this.defaultViews;
   }
   
   /**
    * Adds a configured page size to the internal store
    * 
    * @param page The name of the page i.e. browse, forums etc.
    * @param view The name of the view the size is for i.e. details, icons etc.
    * @param size The size of the page
    */
   /*package*/ void addDefaultPageSize(String page, String view, int size)
   {
      this.pageSizes.put(page + SEPARATOR + view, new Integer(size));
   }
   
   /**
    * Returns the page size for the given page and view combination
    * 
    * @param page The name of the page i.e. browse, forums etc.
    * @param view The name of the view the size is for i.e. details, icons etc.
    * @return The size of the requested page, if the combination doesn't exist
    *         the default for the view will be used, if the view doesn't exist either
    *         10 will be returned.
    */
   public int getDefaultPageSize(String page, String view)
   {
      Integer pageSize = this.pageSizes.get(page + SEPARATOR + view);
      
      // try just the view if the combination isn't present
      if (pageSize == null)
      {
         pageSize = this.pageSizes.get(view);
         
         // if the view is not present either default to 10
         if (pageSize == null)
         {
            pageSize = new Integer(10);
         }
      }
      
      return pageSize.intValue();
   }
   
   /**
    * Returns a map of page sizes
    * 
    * @return Map of page sizes
    */
   /*package*/ Map<String, Integer> getDefaultPageSizes()
   {
      return this.pageSizes;
   }

   /**
    * Adds a default sorting column for the given page 
    * 
    * @param page The name of the page i.e. browse, forums etc.
    * @param column The name of the column to initially sort by
    */
   /*package*/ void addDefaultSortColumn(String page, String column)
   {
      this.sortColumns.put(page, column);
   }
   
   /**
    * Returns the default sort column for the given page
    * 
    * @param page The name of the page i.e. browse, forums etc.
    * @return The name of the column to sort by, name is returned if 
    *         the page is not found
    */
   public String getDefaultSortColumn(String page)
   {
      String column = this.sortColumns.get(page);
      
      if (column == null)
      {
         column = this.defaultSortColumn;
      }
      
      return column;
   }
   
   /**
    * Returns a map of the sorted columns for each page
    * 
    * @return Map of sort columns
    */
   /*package*/ Map<String, String> getDefaultSortColumns()
   {
      return this.sortColumns;
   }
   
   /**
    * Sets the given page as using descending sorts
    * 
    * @param page The name of the page i.e. browse, forums etc.
    */
   /*package*/ void addDescendingSort(String page)
   {
      this.descendingSorts.add(page);
   }
   
   /**
    * Determines whether the given page has been
    * configured to use descending sorting by default
    * 
    * @param page The name of the page i.e. browse, forums etc.
    * @return true if the page should use descending sorts
    */
   public boolean hasDescendingSort(String page)
   {
      return this.descendingSorts.contains(page);
   }
   
   /**
    * Returns a list of pages that use a descending sort
    * 
    * @return List of pages that use a descending sort
    */
   /*package*/ List<String> getDescendingSorts()
   {
      return this.descendingSorts;
   }
}