Package org.bremersee.comparator

Class ComparatorBuilder.DefaultComparatorBuilder

java.lang.Object

org.bremersee.comparator.ComparatorBuilder.DefaultComparatorBuilder

All Implemented Interfaces:

ComparatorBuilder

Enclosing interface:

ComparatorBuilder

public static class ComparatorBuilder.DefaultComparatorBuilder
extends Object
implements ComparatorBuilder

The default comparator builder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.bremersee.comparator.ComparatorBuilder

ComparatorBuilder.DefaultComparatorBuilder

Constructor Summary

Constructors

Constructor	Description
DefaultComparatorBuilder()

Method Summary

Modifier and Type	Method	Description
ComparatorBuilder	add(String field, boolean asc, boolean ignoreCase, boolean nullIsFirst, ValueExtractor valueExtractor)	Creates and adds a value comparator for the given field name or path to this builder.
ComparatorBuilder	add(String field, ValueExtractor valueExtractor, Comparator<?> comparator)	Adds the given comparator for the given field name or path to this builder.
Comparator<Object>	build()	Build comparator.
ComparatorBuilder	fromWellKnownText(String wkt, WellKnownTextParser wktParser)	Creates and adds value comparators for the given well known text description (see ComparatorField.toWkt(), ComparatorFields.toWkt() and WellKnownTextParser).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.bremersee.comparator.ComparatorBuilder

add, add, add, add, add, addAll, addAll, addAll, addAll, fromWellKnownText

Constructor Detail

DefaultComparatorBuilder

public DefaultComparatorBuilder()

Method Detail

add

public ComparatorBuilder add(String field,
                             ValueExtractor valueExtractor,
                             Comparator<?> comparator)

Description copied from interface: ComparatorBuilder

Adds the given comparator for the given field name or path to this builder. A custom value extractor can be specified.

Specified by:

add in interface ComparatorBuilder

Parameters:

field - the field name or path (can be null)

valueExtractor - the value extractor (can be null)

comparator - the comparator (can be null - then no comparator is added)

Returns:

the comparator builder

add

public ComparatorBuilder add(String field,
                             boolean asc,
                             boolean ignoreCase,
                             boolean nullIsFirst,
                             ValueExtractor valueExtractor)

Description copied from interface: ComparatorBuilder

Creates and adds a value comparator for the given field name or path to this builder. A custom value extractor can be specified.

Specified by:

add in interface ComparatorBuilder

Parameters:

field - the field name or path (can be null)

asc - true for an ascending order, false for a descending order

ignoreCase - true for a case insensitive order, false for a case sensitive order

nullIsFirst - specifies the order of null values

valueExtractor - the value extractor

Returns:

the comparator builder

fromWellKnownText

public ComparatorBuilder fromWellKnownText(String wkt,
                                           WellKnownTextParser wktParser)

Description copied from interface: ComparatorBuilder

Creates and adds value comparators for the given well known text description (see ComparatorField.toWkt(), ComparatorFields.toWkt() and WellKnownTextParser).

The syntax of the field ordering depends on the WellKnownTextParser. The default is

 fieldNameOrPath0,asc,ignoreCase,nullIsFirst|fieldNameOrPath1,asc,ignoreCase,nullIsFirst
 

For example

 person.lastName,asc,true,false|person.firstName,asc,true,false
 

Specified by:

fromWellKnownText in interface ComparatorBuilder

Parameters:

wkt - the well known text (field ordering description)

wktParser - the well known text parser (can be null)

Returns:

the comparator builder

build

public Comparator<Object> build()

Description copied from interface: ComparatorBuilder

Build comparator.

Specified by:

build in interface ComparatorBuilder

Returns:

the comparator