Package adams.data.conversion

Class SpreadSheetRowsToReport

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

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -row-report-names <adams.data.spreadsheet.SpreadSheetRowIndex> (property: rowReportNames)
    The (optional) row that contains the report names.
    default:
    example: An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -report-names-in-header <boolean> (property: reportNamesInHeader)
    Whether the report names are stored in the header.
    default: false
 
    -rows-report-values <adams.data.spreadsheet.SpreadSheetRowRange> (property: rowsReportValues)
    The rows in the spreadsheet that contain the report values.
    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
 
    -cols-report <adams.data.spreadsheet.SpreadSheetColumnRange> (property: columnsReport)
    The columns 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 '...'; 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.
 
    -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_RowReportNames

        protected SpreadSheetRowIndex m_RowReportNames
        the column with the report names.

      • m_ReportNamesInHeader

        protected boolean m_ReportNamesInHeader
        whether the report names are in the header row.

      • m_RowsReportValues

        protected SpreadSheetRowRange m_RowsReportValues
        the rows with report values.

      • m_Lenient

        protected boolean m_Lenient
        whether to skip over errors.

    • Constructor Detail

      • SpreadSheetRowsToReport

        public SpreadSheetRowsToReport()

    • Method Detail

      • setRowReportNames

        public void setRowReportNames​(SpreadSheetRowIndex value)
        Sets the row that contains the report names.
        Parameters:
        value - the row

      • getRowReportNames

        public SpreadSheetRowIndex getRowReportNames()
        Returns the row that contains the report names.
        Returns:
        the row

      • rowReportNamesTipText

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

      • setReportNamesInHeader

        public void setReportNamesInHeader​(boolean value)
        Sets whether the wave numbers are in the header.
        Parameters:
        value - true if in header

      • getReportNamesInHeader

        public boolean getReportNamesInHeader()
        Returns whether the report names are in the header.
        Returns:
        true if in header

      • reportNamesInHeaderTipText

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

      • setColumnsReport

        public void setColumnsReport​(SpreadSheetColumnRange value)
        Sets the columns with report.
        Parameters:
        value - the columns

      • getColumnsReport

        public SpreadSheetColumnRange getColumnsReport()
        Returns the columns with report.
        Returns:
        the columns

      • columnsReportTipText

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

      • setRowsReportValues

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

      • getRowsReportValues

        public SpreadSheetRowRange getRowsReportValues()
        Returns the rows with the report values.
        Returns:
        the rows

      • rowsReportValuesTipText

        public String rowsReportValuesTipText()
        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.