Package adams.data.spreadsheet

Class SpreadSheetRowIndex

java.lang.Object

adams.core.Index

adams.core.AbstractDataBackedIndex<SpreadSheet>

adams.data.spreadsheet.SpreadSheetRowIndex

All Implemented Interfaces:

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

public class SpreadSheetRowIndex
extends AbstractDataBackedIndex<SpreadSheet>

Extended Index class for SpreadSheet objects.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.AbstractDataBackedIndex

m_Data, m_Indices, m_Names

Fields inherited from class adams.core.Index

FIRST, LAST, LAST_1, LAST_2, m_Index, m_IntIndex, m_Max, m_Raw, NUMERIC_START, SECOND, THIRD

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SpreadSheetRowIndex	getClone()	Returns a clone of the object.
protected String	getName(SpreadSheet data, int colIndex)	Unused.
protected List<String>	getNames()	Returns the names.
protected int	getNumNames(SpreadSheet data)	Returns the number of rows the dataset has.
SpreadSheet	getSpreadSheet()	Returns the underlying spreadsheet.
void	setSpreadSheet(SpreadSheet value)	Sets the spreadsheet to use for interpreting the row name.

Methods inherited from class adams.core.AbstractDataBackedIndex

clean, getData, getIndices, getIntIndex, initialize, isName, parse, replaceName, setData

Methods inherited from class adams.core.Index

compareTo, equals, getExample, getHelpDescription, getHelpIcon, getHelpTitle, getHelpURL, getIndex, getIntIndex, getMax, hashCode, hasIndex, isEmpty, isPlaceholder, parsePlaceholder, reset, setIndex, setMax, toDisplay, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadSheetRowIndex

public SpreadSheetRowIndex()

Initializes with no index.

SpreadSheetRowIndex

public SpreadSheetRowIndex(String index)

Initializes with the given index, but no maximum.

Parameters:

index - the index to use

SpreadSheetRowIndex

public SpreadSheetRowIndex(String index,
                           int max)

Initializes with the given index and maximum.

Parameters:

index - the index 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 row name.

Parameters:

value - the spreadsheet to use, can be null

getSpreadSheet

public SpreadSheet getSpreadSheet()

Returns the underlying spreadsheet.

Returns:

the underlying spreadsheet, null if none set

See Also:

AbstractDataBackedIndex.getData()

getClone

public SpreadSheetRowIndex getClone()

Returns a clone of the object.

Specified by:

getClone in interface CloneHandler<Index>

Overrides:

getClone in class AbstractDataBackedIndex<SpreadSheet>

Returns:

the clone

getNumNames

protected int getNumNames(SpreadSheet data)

Returns the number of rows the dataset has.

Specified by:

getNumNames in class AbstractDataBackedIndex<SpreadSheet>

Parameters:

data - the dataset to retrieve the number of rows

getName

protected String getName(SpreadSheet data,
                         int colIndex)

Unused.

Specified by:

getName in class AbstractDataBackedIndex<SpreadSheet>

Parameters:

data - the dataset to use

colIndex - the row index

Returns:

the row name

getNames

protected List<String> getNames()

Returns the names.

Overrides:

getNames in class AbstractDataBackedIndex<SpreadSheet>

Returns:

the names