Package io.jmix.dynmodel

Interface DynamicModelSearchInfo

All Known Implementing Classes:
DynamicModelSearchInfoImpl
@NullMarked public interface DynamicModelSearchInfo
Reports what the Search add-on indexes for an entity besides the dynamic attributes marked searchable in the dynamic model.

A bean of this type exists only when the Search add-on is present. Its signature mentions no Search type, so the Admin UI can consume it without depending on the add-on.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isIndexedByApplicationDefinition(String entityName, String attributeName)
    Whether Search indexes the attribute because of an index definition declared by the application (@JmixEntitySearchIndex), rather than because it is marked searchable in the dynamic model.

  • Method Details

    • isIndexedByApplicationDefinition

      boolean isIndexedByApplicationDefinition(String entityName, String attributeName)
      Whether Search indexes the attribute because of an index definition declared by the application (@JmixEntitySearchIndex), rather than because it is marked searchable in the dynamic model. Such an attribute is indexed whatever its searchable flag says: most commonly the definition maps its properties with the wildcard "*", which resolves against the metadata generation and so covers every dynamic attribute of the entity.

      An attribute the published model does not know yet — one just added in the Admin UI — is reported as indexed when the application's definition already pulls in other dynamic attributes of the same entity, because the same definition will cover the new attribute once the model is applied.

      Parameters:
      entityName - entity name
      attributeName - attribute name
      Returns:
      whether the application's own index definition indexes the attribute