Package io.jmix.groupgridflowui.data

Class BaseGroupPropertyDescriptor<E>

java.lang.Object

io.jmix.groupgridflowui.data.BaseGroupPropertyDescriptor<E>

Type Parameters:

E - item type

All Implemented Interfaces:

GroupPropertyDescriptor<E>

public class BaseGroupPropertyDescriptor<E>
extends Object
implements GroupPropertyDescriptor<E>

Base implementation of GroupPropertyDescriptor.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.flowui.component.groupgrid.data.GroupPropertyDescriptor

GroupPropertyDescriptor.GroupValueContext<E>

Field Summary

Fields

Modifier and Type	Field	Description
protected GroupProperty	property
protected List<String>	sortProperties
protected Function<GroupPropertyDescriptor.GroupValueContext<E>,Object>	valueProvider

Constructor Summary

Constructors

Constructor	Description
BaseGroupPropertyDescriptor(GroupProperty property, Function<GroupPropertyDescriptor.GroupValueContext<E>,Object> valueProvider)	Creates a new instance of BaseGroupPropertyDescriptor.
BaseGroupPropertyDescriptor(String propertyName, Function<GroupPropertyDescriptor.GroupValueContext<E>,Object> valueProvider)	Creates a new instance of BaseGroupPropertyDescriptor.

Method Summary

Modifier and Type	Method	Description
GroupProperty	getProperty()
List<String>	getSortProperties()
Function<GroupPropertyDescriptor.GroupValueContext<E>,Object>	getValueProvider()
BaseGroupPropertyDescriptor<E>	withSortProperties(List<String> sortProperties)	Sets the list of properties that are used to sort items if the group property is used for sorting.

Methods inherited from class java.lang.Object

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

Field Details

property

protected GroupProperty property

valueProvider

protected Function<GroupPropertyDescriptor.GroupValueContext<E>,Object> valueProvider

sortProperties

protected List<String> sortProperties

Constructor Details

BaseGroupPropertyDescriptor

public BaseGroupPropertyDescriptor(String propertyName,
 Function<GroupPropertyDescriptor.GroupValueContext<E>,Object> valueProvider)

Creates a new instance of BaseGroupPropertyDescriptor.

Parameters:

propertyName - name of the property that is used to group items

valueProvider - function that provides a value for the property

BaseGroupPropertyDescriptor

public BaseGroupPropertyDescriptor(GroupProperty property,
 Function<GroupPropertyDescriptor.GroupValueContext<E>,Object> valueProvider)

Creates a new instance of BaseGroupPropertyDescriptor.

Parameters:

property - property that is used to group items

valueProvider - function that provides a value for the property

Method Details

getProperty

public GroupProperty getProperty()

Specified by:

getProperty in interface GroupPropertyDescriptor<E>

Returns:

the property to be used for grouping

getValueProvider

public Function<GroupPropertyDescriptor.GroupValueContext<E>,Object> getValueProvider()

Specified by:

getValueProvider in interface GroupPropertyDescriptor<E>

Returns:

a function that provides the value of the custom property for the given item

withSortProperties

public BaseGroupPropertyDescriptor<E> withSortProperties(List<String> sortProperties)

Sets the list of properties that are used to sort items if the group property is used for sorting.

Parameters:

sortProperties - list of entity properties

Returns:

current instance

getSortProperties

public List<String> getSortProperties()

Specified by:

getSortProperties in interface GroupPropertyDescriptor<E>

Returns:

a list of properties that should be used for sorting the group property