Package adams.data.spreadsheet

Class AbstractRow

java.lang.Object

adams.data.spreadsheet.AbstractRow

All Implemented Interfaces:

Mergeable<Row>, Row, Serializable

Direct Known Subclasses:

HeaderRow, SparseDataRow

public abstract class AbstractRow
extends Object
implements Row

Ancestor for row objects.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<String,Cell>	m_Cells	the cells of the row.
protected SpreadSheet	m_Owner	the owner.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRow(SpreadSheet owner)	default constructor.

Method Summary

Modifier and Type	Method	Description
abstract Cell	addCell(int columnIndex)	Adds a cell with the key of the cell in the header at the specified location.
abstract Cell	addCell(String cellKey)	Adds a cell with the given key to the list and returns the created object.
void	assign(Row row)	Obtains copies of the cells from the other row, but not the owner.
abstract Collection<String>	cellKeys()	Returns a collection of all stored cell keys.
void	clear()	Removes all cells.
Cell	getCell(int columnIndex)	Returns the cell with the given index, null if not found.
Cell	getCell(String cellKey)	Returns the cell with the given key, null if not found.
int	getCellCount()	Returns the number of cells stored in the row.
abstract String	getCellKey(int columnIndex)	Returns the cell key with the given column index.
String	getContent(int columnIndex)	Returns the cell content with the given index.
SpreadSheet	getOwner()	Returns the spreadsheet this row belongs to.
boolean	hasCell(String cellKey)	Returns whether the row alread contains the cell with the given key.
boolean	isEmpty(int columnIndex)	Returns whether the row has a non-empty/non-missing cell at the specified location.
boolean	isEmpty(String cellKey)	Returns whether the row has a non-empty/non-missing cell with the given key.
Cell	removeCell(int columnIndex)	Removes the cell at the specified index.
Cell	removeCell(String cellKey)	Removes the cell at the specified index.
boolean	removeMissing()	Removes all cells marked "missing".
void	setOwner(SpreadSheet owner)	Sets the spreadsheet this row belongs to.
String	toString()	Simply returns the internal hashtable of cells as string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.data.spreadsheet.Row

cells, getClone, hasCell, indexOf, mergeWith, newCell

Field Detail

m_Owner

protected SpreadSheet m_Owner

the owner.

m_Cells

protected HashMap<String,Cell> m_Cells

the cells of the row.

Constructor Detail

AbstractRow

protected AbstractRow(SpreadSheet owner)

default constructor.

Parameters:

owner - the spreadsheet this row belongs to

Method Detail

setOwner

public void setOwner(SpreadSheet owner)

Sets the spreadsheet this row belongs to.

Specified by:

setOwner in interface Row

Parameters:

owner - the owner

getOwner

public SpreadSheet getOwner()

Returns the spreadsheet this row belongs to.

Specified by:

getOwner in interface Row

Returns:

the owner

clear

public void clear()

Removes all cells.

Specified by:

clear in interface Row

assign

public void assign(Row row)

Obtains copies of the cells from the other row, but not the owner.

Specified by:

assign in interface Row

Parameters:

row - the row to get the cells from

hasCell

public boolean hasCell(String cellKey)

Returns whether the row alread contains the cell with the given key.

Specified by:

hasCell in interface Row

Parameters:

cellKey - the key to look for

Returns:

true if the cell already exists

addCell

public abstract Cell addCell(int columnIndex)

Adds a cell with the key of the cell in the header at the specified location. If the cell already exists, it returns that instead of creating one.

Specified by:

addCell in interface Row

Parameters:

columnIndex - the index of the column to create

Returns:

the created cell or the already existing cell

addCell

public abstract Cell addCell(String cellKey)

Adds a cell with the given key to the list and returns the created object. If the cell already exists, then this cell is returned instead and no new object created.

Specified by:

addCell in interface Row

Parameters:

cellKey - the key for the cell to create

Returns:

the created cell or the already existing cell

removeCell

public Cell removeCell(int columnIndex)

Removes the cell at the specified index.

Specified by:

removeCell in interface Row

Parameters:

columnIndex - the index of the column

Returns:

the removed cell, null if non removed

removeCell

public Cell removeCell(String cellKey)

Removes the cell at the specified index.

Specified by:

removeCell in interface Row

Parameters:

cellKey - the key of the cell to remove

Returns:

the removed cell, null if non removed

getCell

public Cell getCell(String cellKey)

Returns the cell with the given key, null if not found.

Specified by:

getCell in interface Row

Parameters:

cellKey - the cell to look for

Returns:

the cell or null if not found

getCell

public Cell getCell(int columnIndex)

Returns the cell with the given index, null if not found.

Specified by:

getCell in interface Row

Parameters:

columnIndex - the index of the column

Returns:

the cell or null if not found

isEmpty

public boolean isEmpty(int columnIndex)

Returns whether the row has a non-empty/non-missing cell at the specified location.

Specified by:

isEmpty in interface Row

Parameters:

columnIndex - the column index

Returns:

true if the cell already exists

isEmpty

public boolean isEmpty(String cellKey)

Returns whether the row has a non-empty/non-missing cell with the given key.

Specified by:

isEmpty in interface Row

Parameters:

cellKey - the key to look for

Returns:

true if the cell already exists

getContent

public String getContent(int columnIndex)

Returns the cell content with the given index.

Specified by:

getContent in interface Row

Parameters:

columnIndex - the index of the column

Returns:

the content or null if not found

getCellKey

public abstract String getCellKey(int columnIndex)

Returns the cell key with the given column index.

Specified by:

getCellKey in interface Row

Parameters:

columnIndex - the index of the column

Returns:

the cell key, null if invalid index

cellKeys

public abstract Collection<String> cellKeys()

Returns a collection of all stored cell keys.

Specified by:

cellKeys in interface Row

Returns:

all cell keys (not necessarily sorted)

getCellCount

public int getCellCount()

Returns the number of cells stored in the row.

Specified by:

getCellCount in interface Row

Returns:

the number of cells

removeMissing

public boolean removeMissing()

Removes all cells marked "missing".

Specified by:

removeMissing in interface Row

Returns:

whether any cell was removed

toString

public String toString()

Simply returns the internal hashtable of cells as string.

Specified by:

toString in interface Row

Overrides:

toString in class Object

Returns:

the values of the row