GigaMap: ergonomic retrieval of annotation-generated indexers

[fh-ms]

What

Makes annotation-generated bitmap indexers easy to retrieve and reuse, and completes the typed getter surface for the generated indexer variants.

Before this PR, indexers created by IndexerGenerator were only reachable through the BitmapIndices getter API, and several generated variants (binary, bit-sliced, spatial, comparing, Instant, ZonedDateTime) had no matching getter at all — so a caller had to know the exact generated type and, for those variants, had no getter to call.

Changes

GeneratedIndices<E> — a typed, by-name handle to generated indexers IndexerGenerator.generateIndices(GigaMap) (and the static generate(...)) now return a GeneratedIndices<E> registry. Callers keep it and reuse the indexers like a hand-written public static final constant:

GeneratedIndices<Person> idx = IndexerGenerator.AnnotationBased(Person.class).generateIndices(gigaMap);
gigaMap.query(idx.getIndexerString("firstName").startsWith("J"));
gigaMap.query(idx.getIndexerLocalDate("dateOfBirth").after(LocalDate.of(2000, 1, 1)));

The held indexers resolve against the registered index by name, so they query correctly across reloads — re-run the (idempotent) generation on a loaded map to get a fresh handle.

Completed the BitmapIndices typed getter surface

Added getters for the previously unreachable generated variants: getIndexerInstant, getIndexerZonedDateTime, getIndexerComparing, getSpatialIndexer, getBinaryIndexer, getByteIndexerNumber, getByteIndexerInstant. Documented that the value-typed getters (getIndexerInteger, …) match only the low-cardinality (AUTO) variant, while @Index(binary=true) / kind=BINARY / kind=BIT_SLICED indexes live in the parallel BinaryIndexer / ByteIndexerNumber hierarchies.

SPI shape (review-driven)

• generateIndices(GigaMap) is now the primary generation SPI method and returns the handle; it is implemented directly (no delegation through the deprecated method).
• The released void generateIndices(BitmapIndices) keeps its signature (binary-compatible for callers) and is @deprecated in favour of the GigaMap variant.
• GeneratedIndices.all() returns an immutable snapshot (immure()) rather than the mutable backing table, honouring its documented contract.

Tests

• New IndexerRetrievalTest covers every new getter, the GeneratedIndices registry (typed convenience + raw get), and reuse after reload.
• All existing annotation tests migrated to generateIndices(GigaMap).
• gigamap annotation + retrieval suites and the lucene/jvector handler-based generation suites pass (gigamap 45; lucene+jvector 237, 9 skipped).

Compatibility

The only released method, void generateIndices(BitmapIndices), is unchanged in signature (deprecated, still functional), so published callers are unaffected.

[Copilot]

Pull request overview

This PR improves ergonomics and type-safety for working with annotation-generated bitmap indexers in GigaMap by (1) completing the typed getter surface on BitmapIndices for previously hard-to-retrieve generated indexer variants and (2) introducing a new GeneratedIndices<E> registry handle returned from generation so callers can keep and reuse typed, by-name indexer references (including after reload).

Changes:

• Extend BitmapIndices with additional typed getters for generator outputs (Instant, ZonedDateTime, spatial, comparing, binary, bit-sliced).
• Change IndexerGenerator.generateIndices(...) to return a new GeneratedIndices<E> registry handle (and add that new API type).
• Add tests and documentation demonstrating retrieval, querying, and reload behavior using the new APIs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
gigamap/gigamap/src/test/java/org/eclipse/store/gigamap/indexer/annotation/IndexerRetrievalTest.java	Adds tests validating new typed getters and the GeneratedIndices registry, including reload usage.
gigamap/gigamap/src/main/java/org/eclipse/store/gigamap/types/IndexerGenerator.java	Updates generation methods to return GeneratedIndices<E> and builds the by-name registry from generated indexers.
gigamap/gigamap/src/main/java/org/eclipse/store/gigamap/types/GeneratedIndices.java	Introduces a typed, by-name registry API mirroring BitmapIndices getter surface.
gigamap/gigamap/src/main/java/org/eclipse/store/gigamap/types/BitmapIndices.java	Adds missing typed getters for additional generated indexer kinds (instant, zoned date-time, spatial, comparing, binary, bit-sliced).
docs/modules/gigamap/pages/indexing/bitmap/defining.adoc	Documents keeping the returned GeneratedIndices handle and clarifies which getter APIs apply to which index variants.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.