Module is.codion.swing.common.model
Package is.codion.swing.common.model.component.table

Interface FilterTableModel.TableColumns<R,C>

Type Parameters:
R - the row type
C - the column identifier type
All Known Implementing Classes:
ClientMonitor.RemoteClientColumns, ClientUserMonitor.UserHistoryColumns, DomainGeneratorModel.EntityColumns, DomainGeneratorModel.SchemaColumns, ServerMonitor.DomainColumns, ServerMonitor.OperationColumns, ServerMonitor.ReportColumns
Enclosing interface:
FilterTableModel<R,C>
public static interface FilterTableModel.TableColumns<R,C>
Specifies the columns for a table model, their identifiers, their class and how to extract their value from a row instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    caption(C identifier)
    The default implementation simply returns identifier.toString()
    Class<?>
    columnClass(C identifier)
     
    default <T> @Nullable Comparable<T>
    comparable(R row, C identifier)
    Returns a Comparable instance for the given row and column.
    default Comparator<?>
    comparator(C identifier)
    Returns the comparator to use when comparing the values of the given column
    default Optional<String>
    description(C identifier)
    The default implementation returns an empty Optional.
    default String
    formatted(R row, C identifier)
    Returns a String representation of the value for the given row and column, an empty String in case of null.
    default C
    identifier(int index)
     
    List<C>
    identifiers()
    This method gets called quite often, so it is recommended to return a constant List instance, instead of creating one each time.
    @Nullable Object
    value(R row, C identifier)
    Returns a value for the given row and identifier

  • Method Details

    • identifiers

      List<C> identifiers()
      This method gets called quite often, so it is recommended to return a constant List instance, instead of creating one each time.
      Returns:
      the column identifiers

    • columnClass

      Class<?> columnClass(C identifier)
      Parameters:
      identifier - the column identifier
      Returns:
      the column class for the given column

    • value

      @Nullable Object value(R row, C identifier)
      Returns a value for the given row and identifier
      Parameters:
      row - the object representing a given row
      identifier - the column identifier
      Returns:
      a value for the given row and column

    • caption

      default String caption(C identifier)
      The default implementation simply returns identifier.toString()
      Parameters:
      identifier - the column identifier
      Returns:
      the caption for the given column

    • description

      default Optional<String> description(C identifier)
      The default implementation returns an empty Optional.
      Parameters:
      identifier - the column identifier
      Returns:
      the description for the given column

    • identifier

      default C identifier(int index)
      Parameters:
      index - the identifier index
      Returns:
      the identifier at the given index

    • formatted

      default String formatted(R row, C identifier)
      Returns a String representation of the value for the given row and column, an empty String in case of null.
      Parameters:
      row - the row
      identifier - the column identifier
      Returns:
      a String representation of the value for the given row and column, an empty String in case of null

    • comparable

      default <T> @Nullable Comparable<T> comparable(R row, C identifier)
      Returns a Comparable instance for the given row and column.

      Null is returned if the underlying column value is not a Comparable instance.

      Type Parameters:
      T - the column value type
      Parameters:
      row - the object representing a given row
      identifier - the column identifier
      Returns:
      a Comparable for the given row and column

    • comparator

      default Comparator<?> comparator(C identifier)
      Returns the comparator to use when comparing the values of the given column
      Parameters:
      identifier - the column identifier
      Returns:
      a Comparator for the given column