Class Column


  • public final class Column
    extends java.lang.Object
    Describes a column of a IStructuredResult.
    • Constructor Detail

      • Column

        public Column​(java.lang.String label)
        Build a column with the given label.
        Parameters:
        label - the top of the column
      • Column

        public Column​(java.lang.String label,
                      java.lang.Class<?> type)
        Build a column with the given label.
        Parameters:
        label - the top of the column
        type - a type of the column, such as float, int, Double
      • Column

        public Column​(java.lang.String label,
                      java.lang.Class<?> type,
                      Column.Alignment align,
                      Column.SortDirection direction,
                      java.text.Format formatter,
                      java.util.Comparator<?> comparator)
        Build a column with the given label.
        Parameters:
        label - the top of the column
        type - a type of the column, such as float, int, Double
        align - cell alignment - see Column.Alignment for the choices
        direction - sorting direction
        formatter - how to display items
        comparator - how to sort the items
    • Method Detail

      • formatting

        public Column formatting​(java.text.Format formatter)
        Formatter to format the column values.
        Parameters:
        formatter - the formatter
        Returns:
        the original column to allow chaining
      • aligning

        public Column aligning​(Column.Alignment align)
        Alignment of the column.
        Parameters:
        align - the alignment
        Returns:
        the original column to allow chaining
      • comparing

        public Column comparing​(java.util.Comparator<?> comparator)
        Comparator to sort the column. The row object will be passed to the comparator!
        Parameters:
        comparator - the comparator for sorting
        Returns:
        the original column to allow chaining
      • sorting

        public Column sorting​(Column.SortDirection direction)
        Initial sort direction of the column.
        Parameters:
        direction - the initial direction
        Returns:
        the original column to allow chaining
      • noTotals

        public Column noTotals()
        Indicates that no totals are to be calculated for the column even if the column contains numbers.
        Returns:
        the original column to allow chaining
      • decorator

        public Column decorator​(IDecorator decorator)
        Add a decorator to a column
        Parameters:
        decorator - the decorator to allow a prefix or suffix
        Returns:
        the original column to allow chaining
      • getType

        public java.lang.Class<?> getType()
      • getLabel

        public java.lang.String getLabel()
      • getComparator

        public java.util.Comparator<?> getComparator()
      • getFormatter

        public java.text.Format getFormatter()
      • getCalculateTotals

        public boolean getCalculateTotals()
      • isNumeric

        public boolean isNumeric()
        Returns true if the columns represents a numeric type, i.e. if it is assignable to number or one of the primitive numeric types.
        Returns:
        true if numeric
      • setData

        public java.lang.Object setData​(java.lang.Object key,
                                        java.lang.Object value)
      • getData

        public java.lang.Object getData​(java.lang.Object key)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object