Package io.deephaven.engine.util

Interface ColumnFormatting

public interface ColumnFormatting
Container for utilities to work with magic String values used to indicate formatted rows and columns.

  • Method Details

    • isFormattingColumn

      static boolean isFormattingColumn(String columnName)
      Returns true if this column name is a hidden formatting column.
      Parameters:
      columnName - the column name to check
      Returns:
      true if the columnName is a formatting column; false otherwise

    • getRowStyleFormatColumn

      static String getRowStyleFormatColumn()
      Returns:
      The name of the row style formatting column

    • isRowStyleFormatColumn

      static boolean isRowStyleFormatColumn(@NotNull @NotNull String columnName)
      Returns true if this column name is a hidden row style formatting column.
      Parameters:
      columnName - the column name to check
      Returns:
      true if the columnName is a row style formatting column; false otherwise

    • getStyleFormatColumn

      static String getStyleFormatColumn(String baseColumn)
      Parameters:
      baseColumn - the column name, or the wildcard name for row formats
      Returns:
      The name of the style formatting column for the specified base column.

    • isStyleFormatColumn

      static boolean isStyleFormatColumn(@NotNull @NotNull String columnName)
      Returns true if this column name is a hidden style formatting column.
      Parameters:
      columnName - the column name to check
      Returns:
      true if the columnName is a style formatting column; false otherwise

    • getNumberFormatColumn

      static String getNumberFormatColumn(String baseColumn)
      Parameters:
      baseColumn - the column name
      Returns:
      The name of the number formatting column for the specified base column.

    • isNumberFormatColumn

      static boolean isNumberFormatColumn(@NotNull @NotNull String columnName)
      Returns true if this column name is a hidden number formatting column.
      Parameters:
      columnName - the column name to check
      Returns:
      true if the columnName is a number formatting column; false otherwise

    • getDateFormatColumn

      static String getDateFormatColumn(String baseColumn)
      Parameters:
      baseColumn - the column name
      Returns:
      The name of the date formatting column for the specified base column.

    • isDateFormatColumn

      static boolean isDateFormatColumn(@NotNull @NotNull String columnName)
      Returns true if this column name is a hidden date formatting column.
      Parameters:
      columnName - the column name to check
      Returns:
      true if the columnName is a date formatting column; false otherwise

    • getFormatBaseColumn

      static String getFormatBaseColumn(@NotNull @NotNull String columnName)
      Returns the base column name from a formatting column name.
      Parameters:
      columnName - the column name
      Returns:
      the base column name formatted by columnName