Package io.jmix.search.searching.impl

Class FullFieldNamesProvider

java.lang.Object

io.jmix.search.searching.impl.FullFieldNamesProvider

@Component("search_FullFieldNamesProvider")
public class FullFieldNamesProvider
extends Object

Contains a logic that substitutes an initial field name with the specific subfields. Calculating such subfields depends on the field type and user permissions for the field.

Field Summary

Fields

Modifier and Type	Field	Description
protected final SearchSecurityDecorator	securityDecorator

Constructor Summary

Constructors

Constructor	Description
FullFieldNamesProvider(SearchSecurityDecorator securityDecorator)

Method Summary

Modifier and Type	Method	Description
Set<String>	getFieldNamesForBaseField(MetaPropertyPath path, String fieldName)	Determines the fields to be substituted for a given property path and field name.
protected boolean	isFileRefProperty(Range range)
protected boolean	isReferenceProperty(Range range)

Methods inherited from class java.lang.Object

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

Field Details

securityDecorator

protected final SearchSecurityDecorator securityDecorator

Constructor Details

FullFieldNamesProvider

public FullFieldNamesProvider(SearchSecurityDecorator securityDecorator)

Method Details

getFieldNamesForBaseField

public Set<String> getFieldNamesForBaseField(MetaPropertyPath path,
 String fieldName)

Determines the fields to be substituted for a given property path and field name. The substitution is based on the field's type and the user's permissions. If the property is a file reference, specific subfields are returned. If the property is a reference and the user has permission to read its entity, the instance name field is returned. Otherwise, the original field name or no fields are returned.

Parameters:

path - the MetaPropertyPath representing the relative path to the property

fieldName - the base name of the field to be evaluated

Returns:

a set of field names to be substituted based on the field type and user permissions

isFileRefProperty

protected boolean isFileRefProperty(Range range)

isReferenceProperty

protected boolean isReferenceProperty(Range range)