com.softicar.platform.common.container.data.table.IDataTableColumn Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of platform-common Show documentation

The SoftiCAR Platform is a lightweight, Java-based library to create interactive business web applications.

There is a newer version: 50.0.0

package com.softicar.platform.common.container.data.table;

import com.softicar.platform.common.core.i18n.IDisplayString;
import java.util.Collection;
import java.util.Comparator;
import java.util.Optional;
import java.util.stream.Collectors;

/**
 * Represents a table column of an {@link IDataTable}.
 *
 * @author Oliver Richers
 */
public interface IDataTableColumn {

	/**
	 * Returns the column title.
	 *
	 * @return column title (never null)
	 */
	IDisplayString getTitle();

	/**
	 * Returns the class of the values in this column.
	 *
	 * @return the column value class (never null)
	 */
	Class getValueClass();

	/**
	 * Returns the column value from the given table row.
	 *
	 * @param tableRow
	 *            the table row
	 * @return the value (may be null)
	 */
	V getValue(R tableRow);

	/**
	 * Returns a collection of all values in the given rows.
	 *
	 * @param tableRows
	 *            the table rows
	 * @return collection of all values (the returned collection of values has
	 *         exactly the same size as the given collection of table rows)
	 */
	default Collection getValues(Collection tableRows) {

		return tableRows//
			.stream()
			.map(row -> getValue(row))
			.collect(Collectors.toList());
	}

	/**
	 * Returns an optional value comparator.
	 *
	 * @return an {@link Optional} of {@link Comparator} (never null)
	 */
	default Optional> getValueComparator() {

		return Optional.empty();
	}

	/**
	 * Pre-fetches data for the given values.
	 * 
	 * For example, if this is a foreign-key column, this method un-stubs the
	 * given values.
	 *
	 * @param values
	 *            the values to prefetch data for
	 */
	void prefetchData(Collection values);
}