Class SearchParameters

java.lang.Object
io.fluxzero.sdk.modeling.SearchParameters
All Implemented Interfaces:
Substitutable<SearchParameters>
public class SearchParameters extends Object implements Substitutable<SearchParameters>
Represents configuration options extracted from the @Searchable annotation on a domain type. These parameters determine how the entity should be indexed and queried within the DocumentStore and related search infrastructure.

Instances of this class are typically created during reflective analysis of annotated classes and cached for repeated lookups. They encapsulate metadata relevant to how documents are indexed, timestamped, and grouped within collections.

Fields:

  • searchable – whether documents of this type should be indexed and searchable.
  • collection – name of the logical collection under which documents are grouped; if not specified, the simple name of the class is used.
  • timestampPath – expression to extract the primary timestamp (start time) from the object.
  • endPath – expression to extract the end timestamp (for ranged entities) from the object.
See Also:

  • Field Details

    • defaultSearchParameters

      public static final SearchParameters defaultSearchParameters
      Default instance with searchable=true, and no collection/timestamp configuration.

  • Constructor Details

    • SearchParameters

      public SearchParameters()

  • Method Details

    • substituteProperties

      public SearchParameters substituteProperties()
      Description copied from interface: Substitutable
      Replaces placeholders in the properties of the current resource with resolved values from application properties and returns a new instance of type T.
      Specified by:
      substituteProperties in interface Substitutable<SearchParameters>
      Returns:
      a new instance of the resource with substituted properties.