Package io.jmix.ui.component.propertyfilter

Class PropertyFilterSupport

java.lang.Object

io.jmix.ui.component.propertyfilter.PropertyFilterSupport

Direct Known Subclasses:

DynAttrPropertyFilterSupport

@Component("ui_PropertyFilterSupport")
public class PropertyFilterSupport
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected DataManager	dataManager
protected DatatypeRegistry	datatypeRegistry
protected DateIntervalUtils	dateIntervalUtils
protected static final List<Class<?>>	dateTimeClasses
protected Messages	messages
protected MessageTools	messageTools
protected MetadataTools	metadataTools
protected static final List<Class<?>>	timeClasses

Constructor Summary

Constructors

Constructor	Description
PropertyFilterSupport(Messages messages, MessageTools messageTools, MetadataTools metadataTools, DataManager dataManager, DatatypeRegistry datatypeRegistry, DateIntervalUtils dateIntervalUtils)

Method Summary

Modifier and Type	Method	Description
String	formatDefaultValue(MetaProperty metaProperty, PropertyFilter.Operation.Type operationType, Object value)	Converts default value of value component to String
protected String	formatSingleDefaultValue(Range range, Object value)
EnumSet<PropertyFilter.Operation>	getAvailableOperations(MetaClass metaClass, String property)
EnumSet<PropertyFilter.Operation>	getAvailableOperations(MetaPropertyPath mpp)
PropertyFilter.Operation	getDefaultOperation(MetaClass metaClass, String property)
String	getOperationCaption(PropertyFilter.Operation operation)
String	getPropertyFilterCaption(MetaClass metaClass, String property)	Returns default caption for PropertyFilter.
String	getPropertyFilterCaption(MetaClass metaClass, String property, PropertyFilter.Operation operation, boolean operationCaptionVisible)	Returns default caption for PropertyFilter.
String	getPropertyFilterPrefix(String id, String property)	Returns the prefix for id of PropertyFilter.
protected boolean	isStringDatatype(MetaPropertyPath mpp)
Object	parseDefaultValue(MetaProperty metaProperty, PropertyFilter.Operation.Type operationType, String value)	Parses default value for value component from String
protected Object	parseSingleDefaultValue(Range range, String value)
String	toPropertyConditionOperation(PropertyFilter.Operation operation)

Methods inherited from class java.lang.Object

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

Field Details

dateTimeClasses

protected static final List<Class<?>> dateTimeClasses

timeClasses

protected static final List<Class<?>> timeClasses

messages

protected Messages messages

messageTools

protected MessageTools messageTools

metadataTools

protected MetadataTools metadataTools

dataManager

protected DataManager dataManager

datatypeRegistry

protected DatatypeRegistry datatypeRegistry

dateIntervalUtils

protected DateIntervalUtils dateIntervalUtils

Constructor Details

PropertyFilterSupport

@Autowired
public PropertyFilterSupport(Messages messages,
 MessageTools messageTools,
 MetadataTools metadataTools,
 DataManager dataManager,
 DatatypeRegistry datatypeRegistry,
 DateIntervalUtils dateIntervalUtils)

Method Details

getOperationCaption

public String getOperationCaption(PropertyFilter.Operation operation)

getPropertyFilterPrefix

public String getPropertyFilterPrefix(@Nullable
 String id,
 String property)

Returns the prefix for id of PropertyFilter. This prefix used for internal PropertyFilter components.

Parameters:

id - an id of property filter

property - a property

Returns:

a prefix

getPropertyFilterCaption

public String getPropertyFilterCaption(MetaClass metaClass,
 String property,
 PropertyFilter.Operation operation,
 boolean operationCaptionVisible)

Returns default caption for PropertyFilter.

Default caption consist of the related entity property caption and the operation caption (if the operation caption is configured to be visible), e.g. "Last name contains".

Parameters:

metaClass - an entity meta class associated with property filter

property - an entity attribute associated with property filter

operation - operation for which to show caption

operationCaptionVisible - whether to show operation caption

getPropertyFilterCaption

public String getPropertyFilterCaption(MetaClass metaClass,
 String property)

Returns default caption for PropertyFilter.

Parameters:

metaClass - an entity meta class associated with property filter

property - an entity attribute associated with property filter

getAvailableOperations

public EnumSet<PropertyFilter.Operation> getAvailableOperations(MetaPropertyPath mpp)

getAvailableOperations

public EnumSet<PropertyFilter.Operation> getAvailableOperations(MetaClass metaClass,
 String property)

getDefaultOperation

public PropertyFilter.Operation getDefaultOperation(MetaClass metaClass,
 String property)

isStringDatatype

protected boolean isStringDatatype(MetaPropertyPath mpp)

toPropertyConditionOperation

public String toPropertyConditionOperation(PropertyFilter.Operation operation)

formatDefaultValue

@Nullable
public String formatDefaultValue(MetaProperty metaProperty,
 PropertyFilter.Operation.Type operationType,
 @Nullable
 Object value)

Converts default value of value component to String

Parameters:

metaProperty - an entity attribute associated with filter

operationType - an operation type

value - a default value

Returns:

string default value

formatSingleDefaultValue

@Nullable
protected String formatSingleDefaultValue(Range range,
 Object value)

parseDefaultValue

@Nullable
public Object parseDefaultValue(MetaProperty metaProperty,
 PropertyFilter.Operation.Type operationType,
 @Nullable
 String value)

Parses default value for value component from String

Parameters:

metaProperty - an entity attribute associated with filter

operationType - an operation type

value - a string default value

Returns:

default value

parseSingleDefaultValue

@Nullable
protected Object parseSingleDefaultValue(Range range,
 String value)