jmix-docs icon indicating copy to clipboard operation
jmix-docs copied to clipboard

Programmatic mapping in the "Search" add-on

Open fractal3000 opened this issue 5 months ago • 0 comments

Currently the documentation of the "Search" add-on is doesn't conain all the features of the programmatic mapping. It doesn't contain detailed information of the MappingDefinitionBuilder features. For example there is no the ability for defining a text configuration of the properties mapping.

 MappingDefinitionElement.builder()
 *                                 .includeProperties("description")
 *                                 .withFieldConfiguration(
 *                                         "{\n" +
 *                                         "    \"type\": \"text\",\n" +
 *                                         "    \"analyzer\": \"english\"\n" +
 *                                         "}"
 *                                 )
 *                                 .withPropertyValueExtractor(simplePropertyValueExtractor)
 *                                 .withOrder(1)
 *                                 .build()

There are a lot of information in the JavaDoc of the io.jmix.search.index.mapping.MappingDefinition class and in the io.jmix.search.index.mapping.MappingDefinitionElement class.

Additionally there are no description of the interfaces PropertyValueExtractor and FieldMappingStrategy that could have a custom implementation. They also have detailed JavaDocs.

fractal3000 avatar Sep 25 '24 15:09 fractal3000