jbpm-form-modeler-common 6.0.0.CR2

org.jbpm.formModeler.service.comparator
Class AbstractComparatorByCriteria

java.lang.Object
  extended by org.jbpm.formModeler.service.comparator.AbstractComparatorByCriteria
All Implemented Interfaces:
Comparator, ComparatorByCriteria

public abstract class AbstractComparatorByCriteria
extends Object
implements ComparatorByCriteria

Base class for the implementation of custom comparators.


Field Summary
protected  Locale locale
          The criteria locale.
protected  ArrayList sortCriterias
          Sort criteria list.
 
Fields inherited from interface org.jbpm.formModeler.service.comparator.ComparatorByCriteria
ORDER_ASCENDING, ORDER_DESCENDING, ORDER_UNSPECIFIED
 
Constructor Summary
AbstractComparatorByCriteria()
           
 
Method Summary
 void addSortCriteria(String criteriaId, int order)
          Specifies a sort criteria for the comparator.
abstract  int compare(Object o1, Object o2)
          To be implemented by subclasses.
 boolean equals(Object obj)
           
 boolean existCriteria(String criteriaId)
          Check if a given criteria is applied in comparator.
 String[] getCriteriaIds()
          Retrieve ids. for all criterias specified.
 Locale getLocale()
          The criteria always belongs to a locale.
protected  Object[] getSortCriteria(String criteriaId)
           
 int getSortCriteriaOrdering(String criteriaId)
          Retrieves the ordering specified for a given criteria.
 int getSortCriteriaPriority(String criteriaId)
          Retrieves the current priority for a given criteria.
 void removeAllSortCriteria()
          Removes all sort criterias.
 void removeSortCriteria(String criteriaId)
          Removes a sort criteria.
 void setLocale(Locale locale)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

sortCriterias

protected ArrayList sortCriterias
Sort criteria list. Each entry contains a criteria properties array of int[2] (criteria id. and ordering mode). The position in the list determines the criteria priority in descending order: the first criteria into the list is the most prioritary.


locale

protected Locale locale
The criteria locale.

Constructor Detail

AbstractComparatorByCriteria

public AbstractComparatorByCriteria()
Method Detail

getLocale

public Locale getLocale()
Description copied from interface: ComparatorByCriteria
The criteria always belongs to a locale.

Specified by:
getLocale in interface ComparatorByCriteria

setLocale

public void setLocale(Locale locale)
Specified by:
setLocale in interface ComparatorByCriteria

addSortCriteria

public void addSortCriteria(String criteriaId,
                            int order)
Description copied from interface: ComparatorByCriteria
Specifies a sort criteria for the comparator.

Specified by:
addSortCriteria in interface ComparatorByCriteria
Parameters:
criteriaId - The criteria to set.
order - The sort order. See ORDER_ constants defined.

removeSortCriteria

public void removeSortCriteria(String criteriaId)
Description copied from interface: ComparatorByCriteria
Removes a sort criteria.

Specified by:
removeSortCriteria in interface ComparatorByCriteria
Parameters:
criteriaId - The criteria to remove.

removeAllSortCriteria

public void removeAllSortCriteria()
Description copied from interface: ComparatorByCriteria
Removes all sort criterias.

Specified by:
removeAllSortCriteria in interface ComparatorByCriteria

getSortCriteriaPriority

public int getSortCriteriaPriority(String criteriaId)
Description copied from interface: ComparatorByCriteria
Retrieves the current priority for a given criteria. Priority is set when the criteria is specified. The first criteria specified is the most prioritary.

Specified by:
getSortCriteriaPriority in interface ComparatorByCriteria
Parameters:
criteriaId - The criteria to set.
Returns:
The priority from 1 to <max. number of criterias>.
0 if criteria is not specified in this comparator.

getSortCriteriaOrdering

public int getSortCriteriaOrdering(String criteriaId)
Description copied from interface: ComparatorByCriteria
Retrieves the ordering specified for a given criteria.

Specified by:
getSortCriteriaOrdering in interface ComparatorByCriteria
Parameters:
criteriaId - The criteria to set. See CRITERIA_ constants defined.

getCriteriaIds

public String[] getCriteriaIds()
Description copied from interface: ComparatorByCriteria
Retrieve ids. for all criterias specified.

Specified by:
getCriteriaIds in interface ComparatorByCriteria

getSortCriteria

protected Object[] getSortCriteria(String criteriaId)

existCriteria

public boolean existCriteria(String criteriaId)
Description copied from interface: ComparatorByCriteria
Check if a given criteria is applied in comparator.

Specified by:
existCriteria in interface ComparatorByCriteria

equals

public boolean equals(Object obj)
Specified by:
equals in interface Comparator
Overrides:
equals in class Object

compare

public abstract int compare(Object o1,
                            Object o2)
To be implemented by subclasses.

Specified by:
compare in interface Comparator

jbpm-form-modeler-common 6.0.0.CR2

Copyright © 2001-2013 JBoss by Red Hat. All Rights Reserved.