content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library 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
   * Lesser General Public License for more details.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.file.collectors;
  
  import org.opencms.file.CmsObject;
  import org.opencms.file.CmsProperty;
  import org.opencms.file.CmsPropertyDefinition;
  import org.opencms.file.CmsResource;
  import org.opencms.main.CmsException;
  import org.opencms.util.CmsStringUtil;
  import org.opencms.util.CmsUUID;
  
  import java.io.Serializable;
  import java.text.Collator;
  import java.util.Comparator;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  /**
   * Comparator for sorting resource objects based on priority and title.<p>
   *
   * Serves as {@link java.util.Comparator} for resources and as comparator key for the resource
   * at the same time. Uses lazy initializing of comparator keys in a resource.<p>
   *
   * @since 6.0.0
   */
  public class CmsPriorityTitleResourceComparator implements Serializable, Comparator<CmsResource> {
  
      /** Serial version UID required for safe serialization. */
      private static final long serialVersionUID = -6815638350803584422L;
  
      /** The current OpenCms user context. */
      private transient CmsObject m_cms;
  
      /** The internal map of comparator keys. */
      private Map<CmsUUID, CmsPriorityTitleResourceComparator> m_keys;
  
      /** The priority of this comparator key. */
      private int m_priority;
  
      /** The title of this comparator key. */
      private String m_title;
  
      /**
       * Creates a new instance of this comparator key.<p>
       *
       * @param cms the current OpenCms user context
       */
      public CmsPriorityTitleResourceComparator(CmsObject cms) {
  
          m_cms = cms;
          m_keys = new HashMap<CmsUUID, CmsPriorityTitleResourceComparator>();
      }
  
      /**
       * Creates a new instance of this comparator key.<p>
       *
       * @param resource the resource to create the key for
       * @param cms the current OpenCms user context
       *
       * @return a new instance of this comparator key
       */
      private static CmsPriorityTitleResourceComparator create(CmsResource resource, CmsObject cms) {
  
          CmsPriorityTitleResourceComparator result = new CmsPriorityTitleResourceComparator(null);
          result.init(resource, cms);
          return result;
      }
  
      /**
       * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
       */
      public int compare(CmsResource res0, CmsResource res1) {
  
          if (res0 == res1) {
              return 0;
          }
  
          CmsPriorityTitleResourceComparator key0 = m_keys.get(res0.getStructureId());
          CmsPriorityTitleResourceComparator key1 = m_keys.get(res1.getStructureId());
  
          if (key0 == null) {
              // initialize key if null
              key0 = CmsPriorityTitleResourceComparator.create(res0, m_cms);
              m_keys.put(res0.getStructureId(), key0);
          }
          if (key1 == null) {
              // initialize key if null
              key1 = CmsPriorityTitleResourceComparator.create(res1, m_cms);
              m_keys.put(res1.getStructureId(), key1);
          }
  
          if (key0.getPriority() > key1.getPriority()) {
              return -1;
          }
  
          if (key0.getPriority() < key1.getPriority()) {
              return 1;
          }
  
          // sort by title property depending on the locale
          Collator collator = Collator.getInstance(m_cms.getRequestContext().getLocale());
          return collator.compare(key0.getTitle(), key1.getTitle());
      }
  
      /**
       * Returns the priority of this resource comparator key.<p>
       *
       * @return the priority of this resource comparator key
       */
      public int getPriority() {
  
          return m_priority;
      }
  
      /**
       * Returns the title of this resource comparator key.<p>
       *
       * @return the title of this resource comparator key
       */
      public String getTitle() {
  
          return m_title;
      }
  
      /**
       * Initializes the comparator key based on the member variables.<p>
       *
       * @param resource the resource to use
       * @param cms the current OpenCms user contxt
       */
      private void init(CmsResource resource, CmsObject cms) {
  
          List<CmsProperty> properties;
  
          try {
              properties = cms.readPropertyObjects(resource, false);
          } catch (CmsException e) {
              m_priority = 0;
              m_title = "";
              return;
          }
  
          try {
              m_priority = Integer.parseInt(
                  CmsProperty.get(CmsPriorityResourceCollector.PROPERTY_PRIORITY, properties).getValue());
          } catch (NumberFormatException e) {
              m_priority = CmsPriorityResourceCollector.PRIORITY_STANDARD;
          }
  
          m_title = CmsProperty.get(CmsPropertyDefinition.PROPERTY_TITLE, properties).getValue();
          if (CmsStringUtil.isEmpty(m_title)) {
              m_title = "";
          }
      }
  }