io.jmix.ui.component.propertyfilter

Class PropertyFilterSupport

java.lang.Object

io.jmix.ui.component.propertyfilter.PropertyFilterSupport

@Component(value="ui_PropertyFilterSupport")
public class PropertyFilterSupport
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.DataManager	dataManager
protected io.jmix.core.metamodel.datatype.DatatypeRegistry	datatypeRegistry
protected DateIntervalUtils	dateIntervalUtils
protected static java.util.List<java.lang.Class<?>>	dateTimeClasses
protected RelativeDateTimeMomentProvider	dateTimeMomentProvider
protected io.jmix.core.Messages	messages
protected io.jmix.core.MessageTools	messageTools
protected io.jmix.core.MetadataTools	metadataTools
protected static java.util.List<java.lang.Class<?>>	timeClasses

Constructor Summary

Constructors

Constructor and Description
PropertyFilterSupport(io.jmix.core.Messages messages, io.jmix.core.MessageTools messageTools, io.jmix.core.MetadataTools metadataTools, io.jmix.core.DataManager dataManager, io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry, DateIntervalUtils dateIntervalUtils, RelativeDateTimeMomentProvider dateTimeMomentProvider)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

dateTimeClasses

protected static final java.util.List<java.lang.Class<?>> dateTimeClasses

timeClasses

protected static final java.util.List<java.lang.Class<?>> timeClasses

messages

protected io.jmix.core.Messages messages

messageTools

protected io.jmix.core.MessageTools messageTools

metadataTools

protected io.jmix.core.MetadataTools metadataTools

dataManager

protected io.jmix.core.DataManager dataManager

datatypeRegistry

protected io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry

dateIntervalUtils

protected DateIntervalUtils dateIntervalUtils

dateTimeMomentProvider

protected RelativeDateTimeMomentProvider dateTimeMomentProvider

Constructor Detail

PropertyFilterSupport

@Autowired
public PropertyFilterSupport(io.jmix.core.Messages messages,
                                        io.jmix.core.MessageTools messageTools,
                                        io.jmix.core.MetadataTools metadataTools,
                                        io.jmix.core.DataManager dataManager,
                                        io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry,
                                        DateIntervalUtils dateIntervalUtils,
                                        @Nullable
                                        RelativeDateTimeMomentProvider dateTimeMomentProvider)

Method Detail

getOperationCaption

public java.lang.String getOperationCaption(PropertyFilter.Operation operation)

getPropertyFilterPrefix

public java.lang.String getPropertyFilterPrefix(@Nullable
                                                java.lang.String id,
                                                java.lang.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 java.lang.String getPropertyFilterCaption(io.jmix.core.metamodel.model.MetaClass metaClass,
                                                 java.lang.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 java.lang.String getPropertyFilterCaption(io.jmix.core.metamodel.model.MetaClass metaClass,
                                                 java.lang.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 java.util.EnumSet<PropertyFilter.Operation> getAvailableOperations(io.jmix.core.metamodel.model.MetaPropertyPath mpp)

getAvailableOperations

public java.util.EnumSet<PropertyFilter.Operation> getAvailableOperations(io.jmix.core.metamodel.model.MetaClass metaClass,
                                                                          java.lang.String property)

getDefaultOperation

public PropertyFilter.Operation getDefaultOperation(io.jmix.core.metamodel.model.MetaClass metaClass,
                                                    java.lang.String property)

isStringDatatype

protected boolean isStringDatatype(io.jmix.core.metamodel.model.MetaPropertyPath mpp)

toPropertyConditionOperation

public java.lang.String toPropertyConditionOperation(PropertyFilter.Operation operation)

formatDefaultValue

@Nullable
public java.lang.String formatDefaultValue(io.jmix.core.metamodel.model.MetaProperty metaProperty,
                                                     PropertyFilter.Operation.Type operationType,
                                                     @Nullable
                                                     java.lang.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 java.lang.String formatSingleDefaultValue(io.jmix.core.metamodel.model.Range range,
                                                              java.lang.Object value)

parseDefaultValue

@Nullable
public java.lang.Object parseDefaultValue(io.jmix.core.metamodel.model.MetaProperty metaProperty,
                                                    PropertyFilter.Operation.Type operationType,
                                                    @Nullable
                                                    java.lang.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 java.lang.Object parseSingleDefaultValue(io.jmix.core.metamodel.model.Range range,
                                                             java.lang.String value)