Package adams.data.conversion

Class SpreadSheetRowFinderToRange

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable
    public class SpreadSheetRowFinderToRange
extends AbstractConversion
    Turns the rows that the specified row finder locates into a 1-based range string. Instead of a compressed range string (eg 1-4) it is also possible to output the individual indices (eg 1,2,3,4). 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -row-finder <adams.data.spreadsheet.rowfinder.RowFinder> (property: rowFinder)
    The row finder to use.
    default: adams.data.spreadsheet.rowfinder.NullFinder
 
    -individual-indices <boolean> (property: individualIndices)
    If enabled then individual indices (1,2,3,4) are output instead of compressed 
    ranges (1-4).
    default: false
 
    -index-separator <java.lang.String> (property: indexSeparator)
    The separator to use when outputting individual indices, eg comma or blank.
    default: ,
    Version:
    $Revision: 6556 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_RowFinder

        protected RowFinder m_RowFinder
        the RowFinder to apply.

      • m_IndividualIndices

        protected boolean m_IndividualIndices
        whether to output individual indices (1,2,3,4) rather than compressed ranges (1-4).

      • m_IndexSeparator

        protected String m_IndexSeparator
        the separator for the individual indices.

    • Constructor Detail

      • SpreadSheetRowFinderToRange

        public SpreadSheetRowFinderToRange()

    • Method Detail

      • setRowFinder

        public void setRowFinder​(RowFinder value)
        Sets the row finder to use.
        Parameters:
        value - the row finder

      • getRowFinder

        public RowFinder getRowFinder()
        Returns the row finder in use.
        Returns:
        the row finder

      • rowFinderTipText

        public String rowFinderTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setIndividualIndices

        public void setIndividualIndices​(boolean value)
        Sets whether to output individual indices (1,2,3,4) instead of compressed ranges (1-4).
        Parameters:
        value - true if to output individual indices

      • getIndividualIndices

        public boolean getIndividualIndices()
        Returns whether to output individual indices (1,2,3,4) instead of compressed ranges (1-4).
        Returns:
        true if to output individual indices

      • individualIndicesTipText

        public String individualIndicesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setIndexSeparator

        public void setIndexSeparator​(String value)
        Sets the separator for the individual indices.
        Parameters:
        value - the index separator

      • getIndexSeparator

        public String getIndexSeparator()
        Returns the separator for the individual indices.
        Returns:
        the index separator

      • indexSeparatorTipText

        public String indexSeparatorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui