Package adams.data.conversion

Class SpreadSheetColumnsToReport

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable
    public class SpreadSheetColumnsToReport
extends AbstractConversion
implements LenientModeSupporter
    Turns spreadsheet columns into reports. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -col-report-names <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: colReportNames)
    The (optional) column that contains the report names.
    default:
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -cols-report-values <adams.data.spreadsheet.SpreadSheetColumnRange> (property: colsReportValues)
    The columns to get the report values from.
    default:
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -rows-report <adams.data.spreadsheet.SpreadSheetRowRange> (property: rowsReport)
    The rows that contain report.
    default:
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -lenient <boolean> (property: lenient)
    If enabled, then errors (e.g., due to corrupt data) will not cause exceptions.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Lenient

        protected boolean m_Lenient
        whether to skip over errors.

    • Constructor Detail

      • SpreadSheetColumnsToReport

        public SpreadSheetColumnsToReport()

    • Method Detail

      • setColReportNames

        public void setColReportNames​(SpreadSheetColumnIndex value)
        Sets the column that contains the report names.
        Parameters:
        value - the column

      • getColReportNames

        public SpreadSheetColumnIndex getColReportNames()
        Returns the column that contains the report names.
        Returns:
        the column

      • colReportNamesTipText

        public String colReportNamesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setRowsReport

        public void setRowsReport​(SpreadSheetRowRange value)
        Sets the rows with report.
        Parameters:
        value - the rows

      • getRowsReport

        public SpreadSheetRowRange getRowsReport()
        Returns the rows with report.
        Returns:
        the rows

      • rowsReportTipText

        public String rowsReportTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setColsReportValues

        public void setColsReportValues​(SpreadSheetColumnRange value)
        Sets the columns to get the report values from.
        Parameters:
        value - the columns

      • getColsReportValues

        public SpreadSheetColumnRange getColsReportValues()
        Returns the columns to get the report values from.
        Returns:
        the columns

      • colsReportValuesTipText

        public String colsReportValuesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setLenient

        public void setLenient​(boolean value)
        Sets whether to skip over errors.
        Specified by:
        setLenient in interface LenientModeSupporter
        Parameters:
        value - true if to skip

      • getLenient

        public boolean getLenient()
        Returns whether whether to skip over errors.
        Specified by:
        getLenient in interface LenientModeSupporter
        Returns:
        true if to skip

      • lenientTipText

        public String lenientTipText()
        Returns the tip text for this property.
        Specified by:
        lenientTipText in interface LenientModeSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.