View Javadoc
1   /*
2    * Copyright (c) 2002-2018, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.directory.modules.multiview.util;
35  
36  import java.io.Serializable;
37  import java.util.Comparator;
38  
39  import org.apache.commons.lang3.math.NumberUtils;
40  
41  import fr.paris.lutece.util.ReferenceItem;
42  
43  /**
44   * Comparator for ReferenceItem
45   */
46  public class ReferenceItemComparator implements Comparator<ReferenceItem>, Serializable
47  {
48      // Generated UID
49      private static final long serialVersionUID = -177021185525287854L;
50  
51      /**
52       * {@inheritDoc}
53       */
54      @Override
55      public int compare( ReferenceItem referenceItemOne, ReferenceItem referenceItemTwo )
56      {
57          int nComparisonResult = NumberUtils.INTEGER_ZERO;
58  
59          if ( referenceItemOne != null )
60          {
61              if ( referenceItemTwo != null )
62              {
63                  String strReferenceItemNameOne = referenceItemOne.getName( );
64                  String strReferenceItemNameTwo = referenceItemTwo.getName( );
65  
66                  nComparisonResult = compareReferenceItemName( strReferenceItemNameOne, strReferenceItemNameTwo );
67              }
68              else
69              {
70                  nComparisonResult = NumberUtils.INTEGER_ONE;
71              }
72          }
73          else
74          {
75              if ( referenceItemTwo != null )
76              {
77                  nComparisonResult = NumberUtils.INTEGER_MINUS_ONE;
78              }
79              else
80              {
81                  nComparisonResult = NumberUtils.INTEGER_ZERO;
82              }
83          }
84  
85          return nComparisonResult;
86      }
87  
88      /**
89       * Make the comparison between the two given ReferenceItem names
90       * 
91       * @param strReferenceItemNameOne
92       *            The first name of the ReferenceItem to compare
93       * @param strReferenceItemNameTwo
94       *            The second name of the ReferenceItem to compare
95       * @return the comparison between the two given ReferenceItem names
96       */
97      private int compareReferenceItemName( String strReferenceItemNameOne, String strReferenceItemNameTwo )
98      {
99          int nComparisonResult = NumberUtils.INTEGER_ZERO;
100 
101         if ( strReferenceItemNameOne == null )
102         {
103             if ( strReferenceItemNameTwo != null )
104             {
105                 nComparisonResult = NumberUtils.INTEGER_MINUS_ONE;
106             }
107         }
108         else
109         {
110             if ( strReferenceItemNameTwo == null )
111             {
112                 nComparisonResult = NumberUtils.INTEGER_ONE;
113             }
114             else
115             {
116                 nComparisonResult = strReferenceItemNameOne.compareTo( strReferenceItemNameTwo );
117             }
118         }
119 
120         return nComparisonResult;
121     }
122 }