Class SearchUtils

java.lang.Object

io.fluxzero.common.SearchUtils

public class SearchUtils
extends Object

Utility class for search-related functionality such as term normalization, path transformation, glob pattern matching, and primitive value extraction.

This class is used extensively during document indexing, querying, and filtering. It also includes utilities for path conversion between dot and slash notation, JSON normalization, and field escaping/unescaping.

Field Summary

Fields

Modifier and Type	Field	Description
static final DateTimeFormatter	ISO_FULL	Date-time formatter used to serialize or deserialize full ISO-8601 instant values with millisecond precision.
static final String	letterOrNumber	A character class used in regex patterns that includes letters and digits.
static final Pattern	termPattern	Pattern for extracting search terms and quoted phrases from a string.

Constructor Summary

Constructors

Constructor	Description
SearchUtils()

Method Summary

Modifier and Type	Method	Description
static Object	asIntegerOrString(String fieldName)	Attempts to convert a numeric string to an Integer, falling back to the original string otherwise.
static Object	asPrimitive(Object value)	Converts any non-primitive value to its string form.
static String	escapeFieldName(String fieldName)	Escapes slashes and quotes in field names for safe indexing.
static Predicate<String>	getGlobMatcher(String pattern)	Converts a standard POSIX Shell globbing pattern into a regular expression pattern.
static boolean	isInteger(String fieldName)	Checks whether the input string is a parseable integer.
static String	normalize(@NonNull String text)	Normalizes a string to lowercase and removes diacritics and leading/trailing whitespace.
static byte[]	normalizeJson(byte[] data)	Normalizes all string values in a JSON byte array by stripping accents and lowercasing.
static String	normalizePath(String queryPath)	Replaces unescaped dots in field paths with slashes.
static Instant	parseTimeProperty(String propertyPath, Object object, boolean end, Supplier<Instant> whenMissing)	Parses a time-related property from an object based on the specified property path.
static List<String>	splitInTerms(String query)	Extracts quoted phrases and standalone terms from a free-form query string.
static String	unescapeFieldName(String fieldName)	Unescapes slashes and quotes in field names.

Methods inherited from class Object

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

Field Details

letterOrNumber

public static final String letterOrNumber

A character class used in regex patterns that includes letters and digits.

See Also:

• Constant Field Values

termPattern

public static final Pattern termPattern

Pattern for extracting search terms and quoted phrases from a string.

ISO_FULL

public static final DateTimeFormatter ISO_FULL

Date-time formatter used to serialize or deserialize full ISO-8601 instant values with millisecond precision.

Constructor Details

SearchUtils

public SearchUtils()

Method Details

normalize

public static String normalize(@NonNull
 @NonNull String text)

Normalizes a string to lowercase and removes diacritics and leading/trailing whitespace.

normalizeJson

public static byte[] normalizeJson(byte[] data)

Normalizes all string values in a JSON byte array by stripping accents and lowercasing.

This is typically used during document indexing to enable consistent full-text search.

Parameters:

data - a raw JSON-encoded byte array

Returns:

a normalized version of the input data

getGlobMatcher

public static Predicate<String> getGlobMatcher(String pattern)

Converts a standard POSIX Shell globbing pattern into a regular expression pattern. The result can be used with the standard java.util.regex API to recognize strings which match the glob pattern.

From ...

See also, the POSIX Shell language: ...

Parameters:

pattern - A glob pattern.

Returns:

A regex pattern to recognize the given glob pattern.

isInteger

public static boolean isInteger(String fieldName)

Checks whether the input string is a parseable integer.

asIntegerOrString

public static Object asIntegerOrString(String fieldName)

Attempts to convert a numeric string to an Integer, falling back to the original string otherwise.

splitInTerms

public static List<String> splitInTerms(String query)

Extracts quoted phrases and standalone terms from a free-form query string.

Parameters:

query - the raw search string

Returns:

a list of normalized search terms

asPrimitive

public static Object asPrimitive(Object value)

Converts any non-primitive value to its string form.

normalizePath

public static String normalizePath(String queryPath)

Replaces unescaped dots in field paths with slashes.

This standardizes paths used in documents (e.g. a.b.c → a/b/c).

escapeFieldName

public static String escapeFieldName(String fieldName)

Escapes slashes and quotes in field names for safe indexing.

unescapeFieldName

public static String unescapeFieldName(String fieldName)

Unescapes slashes and quotes in field names.

parseTimeProperty

public static Instant parseTimeProperty(String propertyPath,
 Object object,
 boolean end,
 Supplier<Instant> whenMissing)

Parses a time-related property from an object based on the specified property path. The extracted property value can be of various types, such as LocalDate, LocalDateTime, TemporalAccessor, or String, and the method converts it to an Instant.

If the property is a LocalDate and the end flag is set to true, the result will represent the start of the next day; otherwise, it represents the start of the given day.