com.vaadin.data.util.PropertyValueGenerator Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.data.util;
import java.io.Serializable;
import com.vaadin.data.Container.Filter;
import com.vaadin.data.Item;
import com.vaadin.data.Property;
import com.vaadin.data.sort.SortOrder;
import com.vaadin.data.util.filter.UnsupportedFilterException;
/**
* PropertyValueGenerator for GeneratedPropertyContainer.
*
* @param
* Property data type
* @since 7.4
* @author Vaadin Ltd
*/
public abstract class PropertyValueGenerator implements Serializable {
/**
* Returns value for given Item. Used by GeneratedPropertyContainer when
* generating new properties.
*
* @param item
* currently handled item
* @param itemId
* item id for currently handled item
* @param propertyId
* id for this property
* @return generated value
*/
public abstract T getValue(Item item, Object itemId, Object propertyId);
/**
* Return Property type for this generator. This function is called when
* {@link Property#getType()} is called for generated property.
*
* @return type of generated property
*/
public abstract Class getType();
/**
* Translates sorting of the generated property in a specific direction to a
* set of property ids and directions in the underlying container.
*
* SortOrder is similar to (or the same as) the SortOrder already defined
* for Grid.
*
* The default implementation of this method returns an empty array, which
* means that the property will not be included in
* getSortableContainerPropertyIds(). Attempting to sort by that column
* throws UnsupportedOperationException.
*
* Returning null is not allowed.
*
* @param order
* a sort order for this property
* @return an array of sort orders describing how this property is sorted
*/
public SortOrder[] getSortProperties(SortOrder order) {
return new SortOrder[] {};
}
/**
* Return an updated filter that should be compatible with the underlying
* container.
*
* This function is called when setting a filter for this generated
* property. Returning null from this function causes
* GeneratedPropertyContainer to discard the filter and not use it.
*
* By default this function throws UnsupportedFilterException.
*
* @param filter
* original filter for this property
* @return modified filter that is compatible with the underlying container
* @throws UnsupportedFilterException
* if the implementation doesn't support modifying the provided
* filter
*/
public Filter modifyFilter(Filter filter)
throws UnsupportedFilterException {
throw new UnsupportedFilterException(
"Filter" + filter + " is not supported");
}
}