Package org.dashbuilder.comparator

Interface ComparatorByCriteria

All Superinterfaces:

Comparator

All Known Implementing Classes:

AbstractComparatorByCriteria

public interface ComparatorByCriteria
extends Comparator

Interface addressed to enable the comparison of objects using multiple comparison criteria.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ORDER_ASCENDING
static int	ORDER_DESCENDING
static int	ORDER_UNSPECIFIED

Method Summary

Modifier and Type	Method	Description
void	addSortCriteria(String criteriaId, int order)	Specifies a sort criteria for the comparator.
boolean	existCriteria(String criteriaId)	Check if a given criteria is applied in comparator.
String[]	getCriteriaIds()	Retrieve ids. for all criterias specified.
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.

Methods inherited from interface java.util.Comparator

compare, equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

ORDER_ASCENDING

static final int ORDER_ASCENDING

See Also:

Constant Field Values

ORDER_DESCENDING

static final int ORDER_DESCENDING

See Also:

Constant Field Values

ORDER_UNSPECIFIED

static final int ORDER_UNSPECIFIED

See Also:

Constant Field Values

Method Detail

addSortCriteria

void addSortCriteria(String criteriaId,
                     int order)

Specifies a sort criteria for the comparator.

Parameters:

criteriaId - The criteria to set.

order - The sort order. See ORDER_ constants defined.

removeSortCriteria

void removeSortCriteria(String criteriaId)

Removes a sort criteria.

Parameters:

criteriaId - The criteria to remove.

removeAllSortCriteria

void removeAllSortCriteria()

Removes all sort criterias.

getSortCriteriaOrdering

int getSortCriteriaOrdering(String criteriaId)

Retrieves the ordering specified for a given criteria.

Parameters:

criteriaId - The criteria to set. See CRITERIA_ constants defined.

getSortCriteriaPriority

int getSortCriteriaPriority(String criteriaId)

Retrieves the current priority for a given criteria. Priority is set when the criteria is specified. The first criteria specified is the most prioritary.

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.

getCriteriaIds

String[] getCriteriaIds()

Retrieve ids. for all criterias specified.

existCriteria

boolean existCriteria(String criteriaId)

Check if a given criteria is applied in comparator.