Package io.jmix.search.searching

Class SearchFieldsProvider

java.lang.Object

io.jmix.search.searching.SearchFieldsProvider

@Component("search_SearchFieldsProvider")
public class SearchFieldsProvider
extends Object

A class for getting fields of the given index for the request query building. The class changes field names that are contained in the index field mapping with the full paths. Also, the class checks security rights for getting access to each field.

Field Summary

Fields

Modifier and Type	Field	Description
protected final FullFieldNamesProvider	fullFieldNamesProvider
protected final IndexConfigurationManager	indexConfigurationManager
protected final SearchSecurityDecorator	securityDecorator

Constructor Summary

Constructors

Constructor	Description
SearchFieldsProvider(IndexConfigurationManager indexConfigurationManager, FullFieldNamesProvider fullFieldNamesProvider, SearchSecurityDecorator securityDecorator)

Method Summary

Modifier and Type	Method	Description
protected static void	addRootInstanceField(Set<String> effectiveFieldsToSearch)
protected Set<String>	addSubfields(IndexConfiguration indexConfiguration, Set<String> fields, VirtualSubfieldsProvider virtualSubfieldsProvider)
Set<String>	resolveFields(IndexConfiguration indexConfiguration, VirtualSubfieldsProvider virtualSubfieldsProvider)	Returns fields with subfields of the given index for the request query building.

Methods inherited from class java.lang.Object

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

Field Details

indexConfigurationManager

protected final IndexConfigurationManager indexConfigurationManager

fullFieldNamesProvider

protected final FullFieldNamesProvider fullFieldNamesProvider

securityDecorator

protected final SearchSecurityDecorator securityDecorator

Constructor Details

SearchFieldsProvider

public SearchFieldsProvider(IndexConfigurationManager indexConfigurationManager,
 FullFieldNamesProvider fullFieldNamesProvider,
 SearchSecurityDecorator securityDecorator)

Method Details

resolveFields

public Set<String> resolveFields(IndexConfiguration indexConfiguration,
 VirtualSubfieldsProvider virtualSubfieldsProvider)

Returns fields with subfields of the given index for the request query building. The method takes into account if the current user has permission for the correspondent property reading or not. The method adds virtual subfields to the result if they are provided with the virtualSubfieldsProvider.

Parameters:

indexConfiguration - - index configuration for getting fields. The field names are getting from the correspondent IndexMappingConfiguration

virtualSubfieldsProvider - - a VirtualSubfieldsProvider for getting subfields.

Returns:

set of the fields for searching

addSubfields

protected Set<String> addSubfields(IndexConfiguration indexConfiguration,
 Set<String> fields,
 VirtualSubfieldsProvider virtualSubfieldsProvider)

addRootInstanceField

protected static void addRootInstanceField(Set<String> effectiveFieldsToSearch)