SortKey class

Description taken from OpenDJ SDK!!!

A search result sort key as defined in RFC 2891 is used to specify how search result entries should be ordered. Sort keys are used with the server side sort request control {@link org.forgerock.opendj.ldap.controls.ServerSideSortRequestControl}, but could also be used for performing client side sorting as well.

The following example illustrates how a single sort key may be used to sort entries as they are returned from a search operation using the {@code cn} attribute as the sort key:

Connection connection = ...;
SearchRequest request = ...;

Comparator<Entry> comparator = SortKey.comparator('cn');
Set<SearchResultEntry>; results = TreeSet<SearchResultEntry>(comparator);

connection.search(request, results);

A sort key includes an attribute description and a boolean value that indicates whether the sort should be ascending or descending. It may also contain a specific ordering matching rule that should be used for the sorting process, although if none is provided it will use the default ordering matching rule for the attribute type.

RFC 2891 - LDAP Control Extension for Server Side Sorting of Search Results http:tools.ietf.org/html/rfc2891

Constructors

SortKey(String attributeDescription, [String? orderMatchingRule, bool isReverseOrder = false])

Properties

attributeDescription ↔ String

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isReverseOrder ↔ bool

getter/setter pair

orderMatchingRule ↔ String?

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited