Class SortableEntry

java.lang.Object

io.fluxzero.common.api.search.SortableEntry

All Implemented Interfaces:

Comparable<SortableEntry>

public class SortableEntry
extends Object
implements Comparable<SortableEntry>

Represents a sortable entry in a Document for use in search operations.

SortableEntry values are primarily used to support efficient sorting and range filtering in the document store (e.g., numeric or timestamp-based queries). Each entry consists of a name (field path) and a pre-normalized, lexicographically sortable value as a String.

Values are formatted using a normalization strategy depending on their type:

• Numbers: Encoded into padded, base-10 fixed-width strings for fast and correct range comparisons
• Timestamps: Formatted using SearchUtils.ISO_FULL
• Other values: Normalized to lowercase using SearchUtils.normalize(String)

Example Use Cases

• Sorting search results by timestamp or numeric score
• Enabling fast BetweenConstraint evaluation
• Filtering or grouping based on normalized values

See Also:

• Document
• BetweenConstraint

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<SortableEntry>	comparator	Comparator used to lexicographically compare entries based on name and value.

Constructor Summary

Constructors

Constructor	Description
SortableEntry(String name, Object value)	Constructs a new SortableEntry by formatting the given object into a normalized, sortable string.
SortableEntry(String name, String value)	Constructs an entry from an already encoded maximum.
SortableEntry(String name, String value, String minimum)	Constructs an entry from encoded extrema; a missing minimum retains the maximum-only representation.

Method Summary

Modifier and Type	Method	Description
int	compareTo(SortableEntry o)
static String	formatSortable(Object value)	Formats the given object into a sortable string depending on its type.
SortableEntry	merge(SortableEntry other)	Combines entries at one normalized path without changing the maximum's original escaped path.
String	minimumOrValue()	Returns the minimum, retaining maximum semantics for legacy entries.
static String	toSortableString(Number number)	Converts a Number to a lexicographically sortable zero-padded string.

Methods inherited from class Object

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

Field Details

comparator

public static final Comparator<SortableEntry> comparator

Comparator used to lexicographically compare entries based on name and value.

Constructor Details

SortableEntry

public SortableEntry(String name,
 String value,
 String minimum)

Constructs an entry from encoded extrema; a missing minimum retains the maximum-only representation.

SortableEntry

public SortableEntry(String name,
 String value)

Constructs an entry from an already encoded maximum.

SortableEntry

public SortableEntry(String name,
 Object value)

Constructs a new SortableEntry by formatting the given object into a normalized, sortable string.

Parameters:

name - the field name or path

value - the raw object value (e.g., Number, Instant, or String)

Method Details

minimumOrValue

public String minimumOrValue()

Returns the minimum, retaining maximum semantics for legacy entries.

merge

public SortableEntry merge(SortableEntry other)

Combines entries at one normalized path without changing the maximum's original escaped path.

formatSortable

public static String formatSortable(Object value)

Formats the given object into a sortable string depending on its type.

• For Numbers: Encoded as zero-padded base-10
• For Instants: Formatted as ISO-8601 string
• Other objects: Normalized string representation

compareTo

public int compareTo(@NotNull
 SortableEntry o)

Specified by:

compareTo in interface Comparable<SortableEntry>

toSortableString

public static String toSortableString(Number number)

Converts a Number to a lexicographically sortable zero-padded string.