Package adams.data.spreadsheet

Class DataRowView

java.lang.Object

adams.data.spreadsheet.DataRowView

All Implemented Interfaces:

Mergeable<Row>, DataRow, Row, SpreadSheetColumnInsertionListener, Serializable

public class DataRowView
extends Object
implements DataRow

Provides a view to a data row.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected gnu.trove.list.array.TIntArrayList	m_Columns	the column subset (null for all).
protected SpreadSheet	m_Owner	the owning spreadsheet.
protected DataRow	m_Row	the wrapped row.

Constructor Summary

Constructors

Constructor	Description
DataRowView(SpreadSheet owner, DataRow row, int[] columns)	Initializes the view.

Method Summary

Modifier and Type	Method	Description
Cell	addCell(int columnIndex)	Adds a cell with the key of the cell in the header at the specified location.
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.
Collection<String>	cellKeys()	Returns a collection of all stored cell keys.
Collection<Cell>	cells()	Returns all cells.
void	clear()	Removes all cells.
protected int	getActualColumn(int columnIndex)	Returns the actual index of the column.
protected String	getActualColumn(String cellKey)	Returns the actual key of the column.
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.
String	getCellKey(int columnIndex)	Returns the cell key with the given column index.
DataRow	getClone(SpreadSheet owner)	Returns a clone of itself.
String	getContent(int columnIndex)	Returns the cell content with the given index.
DataRow	getDataRow()	Returns the underlying data row.
SpreadSheet	getOwner()	Returns the spreadsheet this row belongs to.
boolean	hasCell(int columnIndex)	Returns whether the row alread contains the cell at the specified location.
boolean	hasCell(String cellKey)	Returns whether the row alread contains the cell with the given key.
int	indexOf(Cell cell)	Returns the column this particular cell is in (must belong to this row!).
void	mergeWith(Row other)	Merges its own data with the one provided by the specified row.
Cell	newCell(Row owner)	Creates a new instance of a cell.
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.
void	spreadSheetColumnInserted(SpreadSheetColumnInsertionEvent e)	A column got inserted.
String	toString()	Returns the internal array of cells as string.

Methods inherited from class java.lang.Object

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

Field Detail

m_Owner

protected SpreadSheet m_Owner

the owning spreadsheet.

m_Row

protected DataRow m_Row

the wrapped row.

m_Columns

protected gnu.trove.list.array.TIntArrayList m_Columns

the column subset (null for all).

Constructor Detail

DataRowView

public DataRowView(SpreadSheet owner,
                   DataRow row,
                   int[] columns)

Initializes the view.

Parameters:

owner - the owning spreadsheet

row - the row to wrap

columns - the column subset, null for all

Method Detail

getActualColumn

protected int getActualColumn(int columnIndex)

Returns the actual index of the column.

Parameters:

columnIndex - the index

Returns:

the actual index

getActualColumn

protected String getActualColumn(String cellKey)

Returns the actual key of the column.

Parameters:

cellKey - the index

Returns:

the actual key, null if not found

addCell

public 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.
Not implemented!

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.
Not implemented!

Specified by:

removeCell in interface Row

Parameters:

columnIndex - the index of the column

Returns:

the removed cell, null if not removed

removeCell

public Cell removeCell(String cellKey)

Removes the cell at the specified index.
Not implemented!

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

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 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 Collection<String> cellKeys()

Returns a collection of all stored cell keys.

Specified by:

cellKeys in interface Row

Returns:

all cell keys

cells

public Collection<Cell> cells()

Returns all cells.

Specified by:

cells in interface Row

Returns:

the cells

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".
Not implemented!

Specified by:

removeMissing in interface Row

Returns:

true if any cell was removed

indexOf

public int indexOf(Cell cell)

Returns the column this particular cell is in (must belong to this row!).

Specified by:

indexOf in interface Row

Parameters:

cell - the cell to get the column index of

Returns:

the column index, -1 if not found

mergeWith

public void mergeWith(Row other)

Merges its own data with the one provided by the specified row.
Not implemented!

Specified by:

mergeWith in interface Mergeable<Row>

Specified by:

mergeWith in interface Row

Parameters:

other - the row to merge with

setOwner

public void setOwner(SpreadSheet owner)

Sets the spreadsheet this row belongs to.
Not implemented!

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

getClone

public DataRow getClone(SpreadSheet owner)

Returns a clone of itself.

Specified by:

getClone in interface DataRow

Specified by:

getClone in interface Row

Parameters:

owner - the new owner

Returns:

the clone

clear

public void clear()

Removes all cells.
Not implemented!

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

newCell

public Cell newCell(Row owner)

Creates a new instance of a cell.

Specified by:

newCell in interface Row

Parameters:

owner - the owner

Returns:

the cell

hasCell

public boolean hasCell(int columnIndex)

Returns whether the row alread contains the cell at the specified location.

Specified by:

hasCell in interface Row

Parameters:

columnIndex - the column index

Returns:

true if the cell already exists

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 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.
Not implemented!

Specified by:

addCell in interface Row

Parameters:

columnIndex - the index of the column to create

Returns:

the created cell or the already existing cell

spreadSheetColumnInserted

public void spreadSheetColumnInserted(SpreadSheetColumnInsertionEvent e)

A column got inserted.
Does nothing.

Specified by:

spreadSheetColumnInserted in interface DataRow

Specified by:

spreadSheetColumnInserted in interface SpreadSheetColumnInsertionListener

Parameters:

e - the insertion event

getDataRow

public DataRow getDataRow()

Returns the underlying data row.

Returns:

the row

toString

public String toString()

Returns the internal array of cells as string.

Specified by:

toString in interface Row

Overrides:

toString in class Object

Returns:

the values of the row