Interface ColumnByte

All Superinterfaces:
Column
All Known Implementing Classes:
ColumnByte.Renamed

public interface ColumnByte extends Column
A column of byte values used for compact storage of byte-oriented data and file-signature style checks.
  • Field Details

    • TYPE

      static final Column.Type TYPE
      Column type descriptor for primitive byte columns.
  • Method Details

    • builder

      static ColumnByte.Builder builder(ColumnName name)
      Creates a byte column builder for the supplied column name.
      Parameters:
      name - the column name
      Returns:
      a new byte column builder
    • getType

      default Column.Type getType()
      Description copied from interface: Column
      Returns the declared type of values stored in this column.
      Specified by:
      getType in interface Column
      Returns:
      the column value type
    • get

      byte get(int i)
      Returns the byte value at the supplied row.
      Parameters:
      i - the zero-based row index
      Returns:
      the byte value
    • getKeyedValue

      default ColumnByte.KeyedByte getKeyedValue(int i)
      Specified by:
      getKeyedValue in interface Column
    • firstKeyed

      default ColumnByte.KeyedByte firstKeyed()
      Specified by:
      firstKeyed in interface Column
    • lastKeyed

      default ColumnByte.KeyedByte lastKeyed()
      Specified by:
      lastKeyed in interface Column
    • toArray

      byte[] toArray(byte[] x)
      Copies the values into the provided array, allocating a new array when necessary.
      Parameters:
      x - the destination array, or null
      Returns:
      an array containing the column values
    • max

      default byte max()
      Returns the maximum set value in the column.
      Returns:
      maximum set value
    • min

      default byte min()
      Returns the minimum set value in the column.
      Returns:
      minimum set value
    • compare

      default int compare(int i, int j)
      Description copied from interface: Column
      Compares two row values from this column using the column's ordering semantics.
      Specified by:
      compare in interface Column
      Parameters:
      i - the first row index
      j - the second row index
      Returns:
      a negative number, zero, or a positive number as the first row is less than, equal to, or greater than the second
    • toString

      default String toString(int i)
      Description copied from interface: Column
      Formats the value at the supplied row for display.
      Specified by:
      toString in interface Column
      Parameters:
      i - the zero-based row index
      Returns:
      the formatted row value, or an empty string when unset
    • appendTo

      default void appendTo(int i, StringBuilder out, ToStringSettings settings)
      Description copied from interface: Column
      Appends the value at the supplied row using the provided rendering settings.
      Specified by:
      appendTo in interface Column
      Parameters:
      i - the zero-based row index
      out - the destination buffer
      settings - formatting settings to apply
    • selectRow

      default Column selectRow(int i)
      Description copied from interface: Column
      Returns a single-row column containing the value from the supplied row.
      Specified by:
      selectRow in interface Column
      Parameters:
      i - the row to extract
      Returns:
      a single-row column with the same column name
    • copy

      default ColumnByte copy(ColumnName x)
      Description copied from interface: Column
      Creates a copy of this column with the supplied column name.
      Specified by:
      copy in interface Column
      Parameters:
      x - the name to assign to the copy
      Returns:
      a column containing the same values under the new name
    • copy

      default ColumnByte copy(ColumnName x, RowPredicate include)
      Description copied from interface: Column
      Creates a copy of this column with the supplied column name, only retaining rows included by the supplied row predicate.
      Specified by:
      copy in interface Column
      Parameters:
      x - the name to assign to the copy
      include - row predicate indicating which source rows to copy
      Returns:
      a column containing copied values for included rows and unset values elsewhere
    • select

      default Selection select(BytePredicate predicate)
      Selects rows whose values satisfy the supplied predicate.
      Parameters:
      predicate - the predicate to test against each set value
      Returns:
      a selection containing the predicate result for each row
    • predicate

      default RowPredicate predicate(Column.Operator operator, CharSequence... values)
      Description copied from interface: Column
      Creates a row predicate by parsing the supplied comparison values according to this column's type.
      Specified by:
      predicate in interface Column
      Parameters:
      operator - comparison operator
      values - comparison values as text
      Returns:
      predicate evaluated by row index
    • predicate

      default RowPredicate predicate(Column.Operator operator, byte... values)
    • isXls

      boolean isXls()
      Indicates whether the byte values match the legacy XLS file signature.
      Returns:
      true when the column contents look like XLS bytes
    • isXlsx

      boolean isXlsx()
      Indicates whether the byte values match the XLSX file signature.
      Returns:
      true when the column contents look like XLSX bytes