Class ComparatorManager
- All Implemented Interfaces:
JPropertiesListener
You can declare a comparator in properties by following this syntax :
comparator.{Type short name}.{comparator name}: {comparator class Fully Qualified Name}
Example :
comparator.Article.intro: com.example.jcmsplugin.ArticleIntroComparator
When working with classes outside the generated package (such as Abstract class), the fully
qualified name associated with {Type short name} is required and must be declared
using this syntax :
comparator.{Type short name}: {type class Fully Qualified Name}
Example :
comparator.AbstractCalendarEvent: com.jalios.jcms.calendar.AbstractCalendarEvent comparator.AbstractCalendarEvent.duration: com.example.jcmsplugin.CalendarEventDurationComparator
public class CalendarEventDurationComparator<T extends AbstractCalendarEvent> implements Comparator<T>
public int compare(T cal1, T cal2) {
long cal1Duration = cal1 == null ? 0 : (cal1.getEndDate().getTime() - cal1.getStartDate().getTime());
long cal2Duration = cal2 == null ? 0 : (cal2.getEndDate().getTime() - cal2.getStartDate().getTime());
long diff = cal2Duration - cal1Duration;
return diff != 0 ? (int) diff : IdComparator.compareStorableId(cal1, cal2);
}
}
Portlet Query Foreach comparators :
Custom Comparators can be added to Portlet Query Foreach edit form.
To add your comparator, declare I18N labels in your plugin language properties by following this syntax :
comparator.pqf.{comparator name}: My Comparator
Warning : You MUST ensure that your comparator name does not conflicts
with any existing comparator declared for Publication type.
The order of comparators displayed in the sort menu of the Portlet Query Foreach edit form can be controlled by modifying the following property
# Comparator order for Portlet Query Foreach comparator-pqf.prefered-order: \ cdate mdate pdate edate sdate adate udate \ title author opauthor workspace reader \ type pstatus contentType dimensions size duration
- Since:
- jcms-7.1.0
-
Method Summary
Modifier and TypeMethodDescriptiongetCollationKeyWord(String name) static <T extends Storable>
Comparator<? super T> getComparator(Class<T> clazz, String comparatorName) Retrieve a new Comparator from its short identifier to sort instances of the specified class.static <T extends Storable>
Comparator<? super T> getComparator(Class<T> typeClazz, String comparatorName, boolean reverse) Retrieve a new Comparator from its short identifier to sort instances of the specified class.static <T extends Storable>
Comparator<? super T> getComparator(Class<T> typeClazz, String comparatorName, boolean reverse, Map<String, Object> contextMap) Retrieve a new Comparator from its short identifier to sort instances of the specified class.static <T extends Comparator<?>,V extends Storable>
Class<T> getComparatorClass(Class<V> typeClazz, String comparatorName) static StringgetComparatorLabel(String name, String lang) getComparatorNameSet(Class<? extends Storable> clazz) getComparisonMethod(String name) com.ibm.icu.text.CollatorgetIcuCollator(Locale locale, String classname) static ComparatorManagervoidvoidpropertiesChange(JProperties properties) Invoked after properties have been modified in JCMS and save on disk.
-
Method Details
-
getInstance
-
propertiesChange
Description copied from interface:JPropertiesListenerInvoked after properties have been modified in JCMS and save on disk.You cannot alter the value received in parameters.
Note that properties parameter may be null, a limited set of site properties, or all site properties.
To check that a property has been modified, reload the "current" property instead using
channel.getPropertiesorchannel.getProperty.- Specified by:
propertiesChangein interfaceJPropertiesListener- Parameters:
properties- the properties which have been submitted to change
-
initProperties
public void initProperties() -
getConfig
-
getComparator
public static <T extends Storable> Comparator<? super T> getComparator(Class<T> clazz, String comparatorName) Retrieve a new Comparator from its short identifier to sort instances of the specified class.- Type Parameters:
T- specialization of Storable- Parameters:
clazz- the Class of Storable to sortcomparatorName- the comparator name as declared in properties- Returns:
- a new instance of the requested Comparator, never return null (defaults to CdateComparator)
- Since:
- jcms-7.1.0
-
getComparator
public static <T extends Storable> Comparator<? super T> getComparator(Class<T> typeClazz, String comparatorName, boolean reverse) Retrieve a new Comparator from its short identifier to sort instances of the specified class.- Type Parameters:
T- specialization of Storable- Parameters:
typeClazz- the Class of Storable to sortcomparatorName- the comparator name as declared in propertiesreverse- a boolean indicating whether the comparator should have its behavior reversed (true) or unchanged (false)- Returns:
- a new instance of the requested Comparator, never return null (defaults to CdateComparator)
- Since:
- jcms-7.1.0
-
getComparator
public static <T extends Storable> Comparator<? super T> getComparator(Class<T> typeClazz, String comparatorName, boolean reverse, Map<String, Object> contextMap) Retrieve a new Comparator from its short identifier to sort instances of the specified class.- Type Parameters:
T- specialization of Storable- Parameters:
typeClazz- the Class of Storable to sortcomparatorName- the comparator name as declared in propertiesreverse- a boolean indicating whether the comparator should have its behavior reversed (true) or unchanged (false)contextMap- a Map containing any contextual information which might be needed by the Comparator implementation (seeBasicComparatorfor usage).
Warning : if your comparator is used for a "long term" collection, i.e. a collection that will be kept in memory for a long period of time (for example in a internal index), as opposed to a collection that would be discarded after a short period of time (for example after the end of the current HTTP request): DO NOT add Object to the contextMap that would retain pointer and memory to short lived Object (such as an Http request), otherwise you will create a memory leak.- Returns:
- a new instance of the requested Comparator, never return null (defaults to CdateComparator)
- Since:
- jcms-7.1.0
-
getComparatorClass
public static <T extends Comparator<?>,V extends Storable> Class<T> getComparatorClass(Class<V> typeClazz, String comparatorName) - Type Parameters:
T- specialization of ComparatorV- specialization of Storable- Parameters:
typeClazz- the Class of Storable to sortcomparatorName- the comparator name as declared in properties- Returns:
- a Comparator class, or null if none could be found with the specified parameters
-
getComparatorLabel
- Parameters:
name- the name of the comparatorlang- the lang of the label to get- Returns:
- the label of the comparator given its name, in the given lang.
- Since:
- jcms-8.0.2, 9.0.0
-
getComparatorNameSet
- Parameters:
clazz- the clazz to retrieve its Comparators' names- Returns:
- Set of the given clazz's Comparators' names
- Since:
- jcms-8.0.2, 9.0.0
-
getTypeSet
- Returns:
- the Storable classes having comparator(s).
- Since:
- jcms-8.0.2, 9.0.0
-
getCollationKeyWord
-
getComparisonMethod
-
getIcuCollator
-