Package adams.data.spreadsheet

Class SpreadSheetColumnRange

java.lang.Object

adams.core.Range

adams.core.AbstractDataBackedRange<SpreadSheet>

adams.data.spreadsheet.SpreadSheetColumnRange

All Implemented Interfaces:

CloneHandler<Range>, CustomDisplayStringProvider, ExampleProvider, HelpProvider, Serializable, Comparable<Range>

public class SpreadSheetColumnRange
extends AbstractDataBackedRange<SpreadSheet>

Extended Range class that also allows column names for specifying column positions (names are case-insensitive, just like placeholders for 'first', 'second', etc). If column names contain "-" or "," then they need to be surrounded by double-quotes.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.core.AbstractDataBackedRange

AbstractDataBackedRange.InvertedStringLengthComparator

Nested classes/interfaces inherited from class adams.core.Range

Range.SubRange

Field Summary

Fields inherited from class adams.core.AbstractDataBackedRange

m_Data, m_Indices, m_Names

Fields inherited from class adams.core.Range

ALL, FIRST, INV_END, INV_START, LAST, LAST_1, LAST_2, m_ActualRange, m_Inverted, m_Max, m_Range, m_Raw, m_SubRanges, NUMERIC_START, RANGE, SECOND, SEPARATOR, THIRD

Constructor Summary

Constructors

Constructor	Description
SpreadSheetColumnRange()	Initializes with no range.
SpreadSheetColumnRange(String range)	Initializes with the given range, but no maximum.
SpreadSheetColumnRange(String range, int max)	Initializes with the given range and maximum.

Method Summary

Modifier and Type	Method	Description
SpreadSheetColumnRange	getClone()	Returns a clone of the object.
String	getExample()	Returns the example.
protected String	getName(SpreadSheet data, int colIndex)	Returns the column name at the specified index.
protected int	getNumNames(SpreadSheet data)	Returns the number of columns the dataset has.
SpreadSheet	getSpreadSheet()	Returns the underlying spreadsheet.
void	setSpreadSheet(SpreadSheet value)	Sets the spreadsheet to use for interpreting the column name.
void	setSpreadSheetColumns(String[] cols)	Sets the columns to use.
void	setSpreadSheetColumns(List<String> cols)	Sets the columns to use.

Methods inherited from class adams.core.AbstractDataBackedRange

canReplaceInvalidChars, escapeName, getData, getIndices, getIndices, getIntIndices, getIntSegments, getNames, initialize, initLookUp, isInRange, isName, parse, reset, setData, splitList, splitRange, unescapeName

Methods inherited from class adams.core.Range

clean, compareTo, equals, getActualRange, getHelpDescription, getHelpIcon, getHelpTitle, getHelpURL, getIntIndices, getIntSegments, getMax, getRange, getSubRanges, hashCode, hasRange, isAllRange, isEmpty, isInRange, isInverted, isPlaceholder, isValid, parse, parse, parsePlaceholder, setIndices, setIndices, setInverted, setMax, setRange, toDisplay, toExplicitRange, toRange, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpreadSheetColumnRange

public SpreadSheetColumnRange()

Initializes with no range.

SpreadSheetColumnRange

public SpreadSheetColumnRange(String range)

Initializes with the given range, but no maximum.

Parameters:

range - the range to use

SpreadSheetColumnRange

public SpreadSheetColumnRange(String range,
                              int max)

Initializes with the given range and maximum.

Parameters:

range - the range to use

max - the maximum of the 1-based index (e.g., use "10" to allow "1-10" or -1 for uninitialized)

Method Detail

setSpreadSheet

public void setSpreadSheet(SpreadSheet value)

Sets the spreadsheet to use for interpreting the column name.

Parameters:

value - the spreadsheet to use, can be null

setSpreadSheetColumns

public void setSpreadSheetColumns(List<String> cols)

Sets the columns to use. Constructs a spreadsheet on-the-fly.

Parameters:

cols - the columns in the spreadsheet

setSpreadSheetColumns

public void setSpreadSheetColumns(String[] cols)

Sets the columns to use. Constructs a spreadsheet on-the-fly.

Parameters:

cols - the columns in the spreadsheet

getSpreadSheet

public SpreadSheet getSpreadSheet()

Returns the underlying spreadsheet.

Returns:

the underlying spreadsheet, null if none set

See Also:

AbstractDataBackedRange.getData()

getClone

public SpreadSheetColumnRange getClone()

Returns a clone of the object.

Specified by:

getClone in interface CloneHandler<Range>

Overrides:

getClone in class AbstractDataBackedRange<SpreadSheet>

Returns:

the clone

getNumNames

protected int getNumNames(SpreadSheet data)

Returns the number of columns the dataset has.

Specified by:

getNumNames in class AbstractDataBackedRange<SpreadSheet>

Parameters:

data - the dataset to retrieve the number of columns

getName

protected String getName(SpreadSheet data,
                         int colIndex)

Returns the column name at the specified index.

Specified by:

getName in class AbstractDataBackedRange<SpreadSheet>

Parameters:

data - the dataset to use

colIndex - the column index

Returns:

the column name

getExample

public String getExample()

Returns the example.

Specified by:

getExample in interface ExampleProvider

Overrides:

getExample in class Range

Returns:

the example