Class BasicComparator<T extends Storable>

java.lang.Object
com.jalios.jstore.BasicStorable.CdateComparator<T>
com.jalios.jcms.comparator.BasicComparator<T>
Type Parameters:
T - specialization of Storable
All Implemented Interfaces:
Comparator<T>
Direct Known Subclasses:
AccessTokenExpirationDateComparator, Category.NameComparator, Data.DataNameComparator, Group.NameComparator, Member.FirstNameComparator, Member.NameComparator, Publication.TitleComparator, Publication.WorkspaceComparator, QueryResultSet.ScoreComparator, UITheme.UIThemeComparator, Workspace.NameComparator

public class BasicComparator<T extends Storable> extends BasicStorable.CdateComparator<T>
Basic comparator class providing advanced contextual informations and default comparison of Storable using their cdate.

The following fields are available to your implementation :

Use method compareString(String, String) for simpler, homogenous and configurable string comparison.

Example :

 // Sorts Article by alphabetical order of their "intro" field, using current language.
 // Declare this comparator using the following property :
 // comparator.Article.articleintro: com.example.jcms.comparator.MyArticleIntroComparator
 public class MyArticleIntroComparator extends BasicComparator<Article> {

   public int compare(Article p1, Article p2) {
     // object nullity check
     if (p1 == null) {
       return (p2 == null) ? 0 : -1;
     }
     if (p2 == null) {
      return 1;
     }

     // Retrieve Article introduction
     int res = compareString(p1.getIntro(language), p2.getIntro(language));
     if (res != 0) {
       return res;
     }
     return super.compare(p1, p2);
   }
 }
 
  • Field Details

  • Constructor Details

    • BasicComparator

      public BasicComparator()
  • Method Details

    • compareString

      public int compareString(String str1, String str2)
      Compare the two specified String using default method configured.

      Example of use :

        public int compare(Article p1, Article p2) {
           // object nullity check
           if (p1 == null) {
             return (p2 == null) ? 0 : -1;
           }
           if (p2 == null) {
            return 1;
           }
      
           // Retrieve Article introduction
           int res = compareString(p1.getIntro(language), p2.getIntro(language));
           if (res != 0) {
             return res;
           }
           return super.compare(m1, m2);
         }
         
      Default String comparison method can be configured globally or per class using property, see BasicComparator.StringComparisonMethod.
      Parameters:
      str1 - the first string to compare, null is authorized
      str2 - the second string to compare, null is authorized
      Returns:
      Returns an integer value. Value is less than zero if str1 is lexicographically less than str2, value is zero if str1 and str2 are equal and value is greater than str1 if this is lexicographically greater than str2.
      Since:
      jcms-10.0.4 / JCMS-8000