java.lang.Object
- adams.data.spreadsheet.DefaultSpreadSheet

All Implemented Interfaces:

CloneHandler<SpreadSheet>, LocaleSupporter, Mergeable<SpreadSheet>, SpreadSheet, Serializable

Direct Known Subclasses:

DefaultDataset
```
public class DefaultSpreadSheet
extends Object
implements SpreadSheet
```
Represents a generic spreadsheet object.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`COMMENT`	the line comment start.
`protected List<String>`	`m_Comments`	optional comments.
`protected Class`	`m_DataRowClass`	the default data row class to use.
`protected Constructor`	`m_DataRowConstructor`	the constructor for the datarow.
`protected DateFormat`	`m_DateFormat`	for formatting dates.
`protected DateFormat`	`m_DateTimeFormat`	for formatting date/times.
`protected DateFormat`	`m_DateTimeMsecFormat`	for formatting date/time msecs.
`protected HeaderRow`	`m_HeaderRow`	the header row.
`protected Locale`	`m_Locale`	the current locale.
`protected String`	`m_Name`	the name of the spreadsheet.
`protected NumberFormat`	`m_NumberFormat`	for number format.
`protected ArrayList<String>`	`m_RowKeys`	the row keys of the spreadsheet.
`protected HashMap<String,DataRow>`	`m_Rows`	the rows of the spreadsheet.
`protected SharedStringsTable`	`m_StringsTable`	for conserving memory.
`protected DateFormat`	`m_TimeFormat`	for formatting times.
`protected DateFormat`	`m_TimeMsecFormat`	for formatting times with msec.
`static String`	`MISSING_VALUE`	the default missing value.

Constructor Summary

Constructors
Constructor Description

DefaultSpreadSheet()
default constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addComment(String comment)`	Adds the comment to the internal list of comments.
`void`	`addComment(List<String> comment)`	Adds the comments to the internal list of comments.
`DataRow`	`addRow()`	Appends a row to the spreadsheet.
`DataRow`	`addRow(String rowKey)`	Adds a row with the given key to the list and returns the created object.
`void`	`assign(SpreadSheet sheet)`	Clears this spreadsheet and copies all the data from the given one.
`void`	`calculate()`	Triggers all formula cells to recalculate their values.
`void`	`clear()`	Removes all cells, but leaves comments.
`String`	`equalsHeader(SpreadSheet other)`	Compares the header of this spreadsheet with the other one.
`Cell`	`getCell(int rowIndex, int columnIndex)`	Returns the corresponding cell or null if not found.
`int`	`getCellIndex(String cellKey)`	Returns the cell index of the specified cell (in the header row).
`String`	`getCellPosition(String rowKey, String cellKey)`	Returns the position of the cell or null if not found.
`List<String>`	`getCellValues(int colIndex)`	Returns the unique string values of the specified column.
`List<String>`	`getCellValues(String colKey)`	Returns the unique string values of the specified column.
`SpreadSheet`	`getClone()`	Returns a clone of itself.
`int`	`getColumnCount()`	Returns the number of columns.
`String`	`getColumnName(int colIndex)`	Returns the name of the specified column.
`List<String>`	`getColumnNames()`	Returns a list of the names of all columns (i.e., the content the header row cells).
`List<String>`	`getComments()`	Returns the comments.
`Cell.ContentType`	`getContentType(int columnIndex)`	Returns the pure content type of the given column, if available.
`Collection<Cell.ContentType>`	`getContentTypes(int columnIndex)`	Returns the all content types of the given column, if available.
`Class`	`getDataRowClass()`	Returns the class used for rows.
`DateFormat`	`getDateFormat()`	Returns the date formatter.
`DateFormat`	`getDateTimeFormat()`	Returns the date/time formatter.
`DateFormat`	`getDateTimeMsecFormat()`	Returns the date/time msec formatter.
`SpreadSheet`	`getHeader()`	Returns the a spreadsheet with the same header and comments.
`HeaderRow`	`getHeaderRow()`	Returns the header row.
`Locale`	`getLocale()`	Returns the current locale.
`String`	`getName()`	Returns the name of the spreadsheet.
`NumberFormat`	`getNumberFormat()`	Returns the number formatter.
`DataRow`	`getRow(int rowIndex)`	Returns the row at the specified index.
`DataRow`	`getRow(String rowKey)`	Returns the row associated with the given row key, null if not found.
`int`	`getRowCount()`	Returns the number of rows currently stored.
`int`	`getRowIndex(String rowKey)`	Returns the row index of the specified row.
`String`	`getRowKey(int rowIndex)`	Returns the row key at the specified index.
`SharedStringsTable`	`getSharedStringsTable()`	Returns the table for shared strings.
`DateFormat`	`getTimeFormat()`	Returns the time formatter.
`DateFormat`	`getTimeMsecFormat()`	Returns the time/msec formatter.
`TimeZone`	`getTimeZone()`	Returns the currently used timezone.
`boolean`	`hasCell(int rowIndex, int columnIndex)`	Checks whether the cell with the given indices already exists.
`boolean`	`hasName()`	Returns whether the spreadsheet has a name.
`boolean`	`hasRow(int rowIndex)`	Returns whether the spreadsheet already contains the row with the given index.
`boolean`	`hasRow(String rowKey)`	Returns whether the spreadsheet already contains the row with the given key.
`protected void`	`initialize()`	Initializes the members.
`void`	`insertColumn(int columnIndex, String header)`	Inserts a column at the specified location.
`void`	`insertColumn(int columnIndex, String header, String initial)`	Inserts a column at the specified location.
`void`	`insertColumn(int columnIndex, String header, String initial, boolean forceString)`	Inserts a column at the specified location.
`DataRow`	`insertRow(int index)`	Inserts a row at the specified location.
`boolean`	`isContentType(int columnIndex, Cell.ContentType type)`	Checks whether the given column is of the specific content type or not.
`boolean`	`isDateLenient()`	Returns whether the parsing of dates is lenient or not.
`boolean`	`isDateTimeLenient()`	Returns whether the parsing of date/times is lenient or not.
`boolean`	`isDateTimeMsecLenient()`	Returns whether the parsing of date/time msecs is lenient or not.
`boolean`	`isNumeric(int columnIndex)`	Checks whether the given column is numeric or not.
`boolean`	`isNumeric(int columnIndex, boolean allowMissing)`	Checks whether the given column is numeric or not.
`boolean`	`isTimeLenient()`	Returns whether the parsing of times is lenient or not.
`boolean`	`isTimeMsecLenient()`	Returns whether the parsing of times/msec is lenient or not.
`static void`	`main(String[] args)`
`void`	`mergeWith(SpreadSheet other)`	Puts the content of the provided spreadsheet on the right.
`Cell`	`newCell()`	Creates a new cell.
`SpreadSheet`	`newInstance()`	Returns a new instance.
`protected DataRow`	`newRow()`	Creates a new row instance.
`boolean`	`removeColumn(int columnIndex)`	Removes the specified column.
`boolean`	`removeColumn(String columnKey)`	Removes the specified column.
`boolean`	`removeMissing()`	Removes all cells marked "missing".
`Row`	`removeRow(int rowIndex)`	Removes the specified row.
`Row`	`removeRow(String rowKey)`	Removes the specified row.
`Collection<String>`	`rowKeys()`	Returns a collection of all row keys.
`Collection<DataRow>`	`rows()`	Returns all rows.
`void`	`setDataRowClass(Class cls)`	Sets the default data row class to use.
`void`	`setDateLenient(boolean value)`	Sets whether parsing of dates is to be lenient or not.
`void`	`setDateTimeLenient(boolean value)`	Sets whether parsing of date/times is to be lenient or not.
`void`	`setDateTimeMsecLenient(boolean value)`	Sets whether parsing of date/time mses is to be lenient or not.
`void`	`setLocale(Locale value)`	Sets the locale.
`void`	`setName(String value)`	Sets the name of the spreadsheet.
`void`	`setTimeLenient(boolean value)`	Sets whether parsing of times is to be lenient or not.
`void`	`setTimeMsecLenient(boolean value)`	Sets whether parsing of times/msec is to be lenient or not.
`void`	`setTimeZone(TimeZone value)`	Sets the timezone to use.
`void`	`sort(int index, boolean asc)`	Sorts the rows based on the values in the specified column.
`void`	`sort(RowComparator comp)`	Sorts the rows using the given comparator.
`void`	`sort(RowComparator comp, boolean unique)`	Sorts the rows using the given comparator.
`void`	`sortRowKeys()`	Sorts the rows according to the row keys.
`void`	`sortRowKeys(Comparator<String> comp)`	Sorts the rows according to the row keys.
`Object[][]`	`toMatrix()`	Returns the spreadsheet as matrix, with the header as the first row.
`String`	`toString()`	Returns the spreadsheet as string, i.e., CSV formatted.
`SpreadSheet`	`toView(int[] rows, int[] columns)`	Creates a view of the spreadsheet with the specified rows/columns.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - COMMENT
```
public static final String COMMENT
```
    the line comment start.
    
    See Also:
    
    Constant Field Values
  - MISSING_VALUE
```
public static final String MISSING_VALUE
```
    the default missing value.
    
    See Also:
    
    Constant Field Values
  - m_RowKeys
```
protected ArrayList<String> m_RowKeys
```
    the row keys of the spreadsheet.
  - m_Rows
```
protected HashMap<String,DataRow> m_Rows
```
    the rows of the spreadsheet.
  - m_HeaderRow
```
protected HeaderRow m_HeaderRow
```
    the header row.
  - m_Comments
```
protected List<String> m_Comments
```
    optional comments.
  - m_Name
```
protected String m_Name
```
    the name of the spreadsheet.
  - m_DateFormat
```
protected DateFormat m_DateFormat
```
    for formatting dates.
  - m_DateTimeFormat
```
protected DateFormat m_DateTimeFormat
```
    for formatting date/times.
  - m_DateTimeMsecFormat
```
protected DateFormat m_DateTimeMsecFormat
```
    for formatting date/time msecs.
  - m_TimeFormat
```
protected DateFormat m_TimeFormat
```
    for formatting times.
  - m_TimeMsecFormat
```
protected DateFormat m_TimeMsecFormat
```
    for formatting times with msec.
  - m_NumberFormat
```
protected NumberFormat m_NumberFormat
```
    for number format.
  - m_Locale
```
protected Locale m_Locale
```
    the current locale.
  - m_StringsTable
```
protected SharedStringsTable m_StringsTable
```
    for conserving memory.
  - m_DataRowClass
```
protected Class m_DataRowClass
```
    the default data row class to use.
  - m_DataRowConstructor
```
protected transient Constructor m_DataRowConstructor
```
    the constructor for the datarow.
- Constructor Detail
  - DefaultSpreadSheet
```
public DefaultSpreadSheet()
```
    default constructor.
- Method Detail
  - initialize
```
protected void initialize()
```
    Initializes the members.
  - assign
```
public void assign(SpreadSheet sheet)
```
    Clears this spreadsheet and copies all the data from the given one.
    
    Specified by:
    
    assign in interface SpreadSheet
    
    Parameters:
    
    sheet - the data to copy
  - setDataRowClass
```
public void setDataRowClass(Class cls)
```
    Sets the default data row class to use. Must implement DataRow.
    
    Specified by:
    
    setDataRowClass in interface SpreadSheet
    
    Parameters:
    
    cls - the class, null resets it to the default one
    
    Throws:
    
    IllegalArgumentException - if class does not implement DataRow
  - getDataRowClass
```
public Class getDataRowClass()
```
    Returns the class used for rows.
    
    Specified by:
    
    getDataRowClass in interface SpreadSheet
    
    Returns:
    
    the class
  - newInstance
```
public SpreadSheet newInstance()
```
    Returns a new instance.
    
    Specified by:
    
    newInstance in interface SpreadSheet
    
    Returns:
    
    the new instance, null if failed to create new instance
  - getClone
```
public SpreadSheet getClone()
```
    Returns a clone of itself.
    
    Specified by:
    
    getClone in interface CloneHandler<SpreadSheet>
    
    Specified by:
    
    getClone in interface SpreadSheet
    
    Returns:
    
    the clone
  - getHeader
```
public SpreadSheet getHeader()
```
    Returns the a spreadsheet with the same header and comments.
    
    Specified by:
    
    getHeader in interface SpreadSheet
    
    Returns:
    
    the spreadsheet
  - getDateFormat
```
public DateFormat getDateFormat()
```
    Returns the date formatter.
    
    Specified by:
    
    getDateFormat in interface SpreadSheet
    
    Returns:
    
    the formatter
    
    See Also:
    
    DateUtils.getDateFormatter()
  - getDateTimeFormat
```
public DateFormat getDateTimeFormat()
```
    Returns the date/time formatter.
    
    Specified by:
    
    getDateTimeFormat in interface SpreadSheet
    
    Returns:
    
    the formatter
    
    See Also:
    
    DateUtils.getTimestampFormatter()
  - getDateTimeMsecFormat
```
public DateFormat getDateTimeMsecFormat()
```
    Returns the date/time msec formatter.
    
    Specified by:
    
    getDateTimeMsecFormat in interface SpreadSheet
    
    Returns:
    
    the formatter
    
    See Also:
    
    DateUtils.getTimestampFormatterMsecs()
  - getTimeFormat
```
public DateFormat getTimeFormat()
```
    Returns the time formatter.
    
    Specified by:
    
    getTimeFormat in interface SpreadSheet
    
    Returns:
    
    the formatter
    
    See Also:
    
    DateUtils.getTimeFormatter()
  - getTimeMsecFormat
```
public DateFormat getTimeMsecFormat()
```
    Returns the time/msec formatter.
    
    Specified by:
    
    getTimeMsecFormat in interface SpreadSheet
    
    Returns:
    
    the formatter
    
    See Also:
    
    DateUtils.getTimeFormatterMsecs()
  - getNumberFormat
```
public NumberFormat getNumberFormat()
```
    Returns the number formatter.
    
    Specified by:
    
    getNumberFormat in interface SpreadSheet
    
    Returns:
    
    the formatter
  - setName
```
public void setName(String value)
```
    Sets the name of the spreadsheet.
    
    Specified by:
    
    setName in interface SpreadSheet
    
    Parameters:
    
    value - the name
  - getName
```
public String getName()
```
    Returns the name of the spreadsheet.
    
    Specified by:
    
    getName in interface SpreadSheet
    
    Returns:
    
    the name, can be null
  - hasName
```
public boolean hasName()
```
    Returns whether the spreadsheet has a name.
    
    Specified by:
    
    hasName in interface SpreadSheet
    
    Returns:
    
    true if the spreadsheet is named
  - addComment
```
public void addComment(String comment)
```
    Adds the comment to the internal list of comments. If the comment contains newlines, then it gets automatically split into multiple lines and added one by one.
    
    Specified by:
    
    addComment in interface SpreadSheet
    
    Parameters:
    
    comment - the comment to add
  - addComment
```
public void addComment(List<String> comment)
```
    Adds the comments to the internal list of comments.
    
    Specified by:
    
    addComment in interface SpreadSheet
    
    Parameters:
    
    comment - the comment to add
  - getComments
```
public List<String> getComments()
```
    Returns the comments.
    
    Specified by:
    
    getComments in interface SpreadSheet
    
    Returns:
    
    the comments
  - clear
```
public void clear()
```
    Removes all cells, but leaves comments.
    
    Specified by:
    
    clear in interface SpreadSheet
  - getHeaderRow
```
public HeaderRow getHeaderRow()
```
    Returns the header row.
    
    Specified by:
    
    getHeaderRow in interface SpreadSheet
    
    Returns:
    
    the row
  - getColumnName
```
public String getColumnName(int colIndex)
```
    Returns the name of the specified column.
    
    Specified by:
    
    getColumnName in interface SpreadSheet
    
    Parameters:
    
    colIndex - the index of the column
    
    Returns:
    
    the name of the column
  - getColumnNames
```
public List<String> getColumnNames()
```
    Returns a list of the names of all columns (i.e., the content the header row cells).
    
    Specified by:
    
    getColumnNames in interface SpreadSheet
    
    Returns:
    
    the names of the columns
  - hasRow
```
public boolean hasRow(int rowIndex)
```
    Returns whether the spreadsheet already contains the row with the given index.
    
    Specified by:
    
    hasRow in interface SpreadSheet
    
    Parameters:
    
    rowIndex - the index to look for
    
    Returns:
    
    true if the row already exists
  - hasRow
```
public boolean hasRow(String rowKey)
```
    Returns whether the spreadsheet already contains the row with the given key.
    
    Specified by:
    
    hasRow in interface SpreadSheet
    
    Parameters:
    
    rowKey - the key to look for
    
    Returns:
    
    true if the row already exists
  - newRow
```
protected DataRow newRow()
```
    Creates a new row instance.
    
    Returns:
    
    the new instance, null in case of an instantiation error
  - newCell
```
public Cell newCell()
```
    Creates a new cell.
    
    Specified by:
    
    newCell in interface SpreadSheet
    
    Returns:
    
    the new instance, null in case of an instantiation error
  - addRow
```
public DataRow addRow()
```
    Appends a row to the spreadsheet.
    
    Specified by:
    
    addRow in interface SpreadSheet
    
    Returns:
    
    the created row
  - addRow
```
public DataRow addRow(String rowKey)
```
    Adds a row with the given key to the list and returns the created object. If the row already exists, then this row is returned instead and no new object created.
    
    Specified by:
    
    addRow in interface SpreadSheet
    
    Parameters:
    
    rowKey - the key for the row to create
    
    Returns:
    
    the created row or the already existing row
  - insertRow
```
public DataRow insertRow(int index)
```
    Inserts a row at the specified location.
    
    Specified by:
    
    insertRow in interface SpreadSheet
    
    Parameters:
    
    index - the index where to insert the row
    
    Returns:
    
    the created row
  - removeRow
```
public Row removeRow(int rowIndex)
```
    Removes the specified row.
    
    Specified by:
    
    removeRow in interface SpreadSheet
    
    Parameters:
    
    rowIndex - the row to remove
    
    Returns:
    
    the row that was removed, null if none removed
  - removeRow
```
public Row removeRow(String rowKey)
```
    Removes the specified row.
    
    Specified by:
    
    removeRow in interface SpreadSheet
    
    Parameters:
    
    rowKey - the row to remove
    
    Returns:
    
    the row that was removed, null if none removed
  - insertColumn
```
public void insertColumn(int columnIndex,
                         String header)
```
    Inserts a column at the specified location.
    
    Specified by:
    
    insertColumn in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the position of the column
    
    header - the name of the column
  - insertColumn
```
public void insertColumn(int columnIndex,
                         String header,
                         String initial)
```
    Inserts a column at the specified location.
    
    Specified by:
    
    insertColumn in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the position of the column
    
    header - the name of the column
    
    initial - the initial value for the cells, "null" for missing values (in that case no cells are added)
  - insertColumn
```
public void insertColumn(int columnIndex,
                         String header,
                         String initial,
                         boolean forceString)
```
    Inserts a column at the specified location.
    
    Specified by:
    
    insertColumn in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the position of the column
    
    header - the name of the column
    
    initial - the initial value for the cells, "null" for missing values (in that case no cells are added)
    
    forceString - whether to enforce the value to be set as string
  - removeColumn
```
public boolean removeColumn(int columnIndex)
```
    Removes the specified column.
    
    Specified by:
    
    removeColumn in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the column to remove
    
    Returns:
    
    true if removed
  - removeColumn
```
public boolean removeColumn(String columnKey)
```
    Removes the specified column.
    
    Specified by:
    
    removeColumn in interface SpreadSheet
    
    Parameters:
    
    columnKey - the column to remove
    
    Returns:
    
    true if removed
  - getRow
```
public DataRow getRow(String rowKey)
```
    Returns the row associated with the given row key, null if not found.
    
    Specified by:
    
    getRow in interface SpreadSheet
    
    Parameters:
    
    rowKey - the key of the row to retrieve
    
    Returns:
    
    the row or null if not found
  - getRow
```
public DataRow getRow(int rowIndex)
```
    Returns the row at the specified index.
    
    Specified by:
    
    getRow in interface SpreadSheet
    
    Parameters:
    
    rowIndex - the 0-based index of the row to retrieve
    
    Returns:
    
    the row
  - getRowKey
```
public String getRowKey(int rowIndex)
```
    Returns the row key at the specified index.
    
    Specified by:
    
    getRowKey in interface SpreadSheet
    
    Parameters:
    
    rowIndex - the 0-based index of the row key to retrieve
    
    Returns:
    
    the row key
  - getRowIndex
```
public int getRowIndex(String rowKey)
```
    Returns the row index of the specified row.
    
    Specified by:
    
    getRowIndex in interface SpreadSheet
    
    Parameters:
    
    rowKey - the row identifier
    
    Returns:
    
    the 0-based row index, -1 if not found
  - getCellIndex
```
public int getCellIndex(String cellKey)
```
    Returns the cell index of the specified cell (in the header row).
    
    Specified by:
    
    getCellIndex in interface SpreadSheet
    
    Parameters:
    
    cellKey - the cell identifier
    
    Returns:
    
    the 0-based column index, -1 if not found
  - hasCell
```
public boolean hasCell(int rowIndex,
                       int columnIndex)
```
    Checks whether the cell with the given indices already exists.
    
    Specified by:
    
    hasCell in interface SpreadSheet
    
    Parameters:
    
    rowIndex - the index of the row to look for
    
    columnIndex - the index of the cell in the row to look for
    
    Returns:
    
    true if the cell exists
  - getCell
```
public Cell getCell(int rowIndex,
                    int columnIndex)
```
    Returns the corresponding cell or null if not found.
    
    Specified by:
    
    getCell in interface SpreadSheet
    
    Parameters:
    
    rowIndex - the index of the row the cell is in
    
    columnIndex - the column of the cell to retrieve
    
    Returns:
    
    the cell or null if not found
  - getCellPosition
```
public String getCellPosition(String rowKey,
                              String cellKey)
```
    Returns the position of the cell or null if not found. A position is a combination of a number of letters (for the column) and number (for the row).
    
    Specified by:
    
    getCellPosition in interface SpreadSheet
    
    Parameters:
    
    rowKey - the key of the row the cell is in
    
    cellKey - the key of the cell to retrieve
    
    Returns:
    
    the position string or null if not found
  - rowKeys
```
public Collection<String> rowKeys()
```
    Returns a collection of all row keys.
    
    Specified by:
    
    rowKeys in interface SpreadSheet
    
    Returns:
    
    the row keys
  - rows
```
public Collection<DataRow> rows()
```
    Returns all rows.
    
    Specified by:
    
    rows in interface SpreadSheet
    
    Returns:
    
    the rows
  - sortRowKeys
```
public void sortRowKeys()
```
    Sorts the rows according to the row keys.
    
    Specified by:
    
    sortRowKeys in interface SpreadSheet
    
    See Also:
    
    rowKeys()
  - sortRowKeys
```
public void sortRowKeys(Comparator<String> comp)
```
    Sorts the rows according to the row keys.
    
    Specified by:
    
    sortRowKeys in interface SpreadSheet
    
    Parameters:
    
    comp - the comparator to use
    
    See Also:
    
    rowKeys()
  - sort
```
public void sort(int index,
                 boolean asc)
```
    Sorts the rows based on the values in the specified column.
    
    NB: the row keys will change!
    
    Specified by:
    
    sort in interface SpreadSheet
    
    Parameters:
    
    index - the index (0-based) of the column to sort on
    
    asc - wether sorting is ascending or descending
    
    See Also:
    
    sort(RowComparator)
  - sort
```
public void sort(RowComparator comp)
```
    Sorts the rows using the given comparator.
    
    NB: the row keys will change!
    
    Specified by:
    
    sort in interface SpreadSheet
    
    Parameters:
    
    comp - the row comparator to use
  - sort
```
public void sort(RowComparator comp,
                 boolean unique)
```
    Sorts the rows using the given comparator.
    
    NB: the row keys will change!
    
    Specified by:
    
    sort in interface SpreadSheet
    
    Parameters:
    
    comp - the row comparator to use
    
    unique - whether to drop any duplicate rows (based on row comparator)
  - getColumnCount
```
public int getColumnCount()
```
    Returns the number of columns.
    
    Specified by:
    
    getColumnCount in interface SpreadSheet
    
    Returns:
    
    the number of columns
  - getRowCount
```
public int getRowCount()
```
    Returns the number of rows currently stored.
    
    Specified by:
    
    getRowCount in interface SpreadSheet
    
    Returns:
    
    the number of rows
  - isNumeric
```
public boolean isNumeric(int columnIndex)
```
    Checks whether the given column is numeric or not. Does not accept missing values.
    
    Specified by:
    
    isNumeric in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the index of the column to check
    
    Returns:
    
    true if purely numeric
    
    See Also:
    
    getContentTypes(int)
  - isNumeric
```
public boolean isNumeric(int columnIndex,
                         boolean allowMissing)
```
    Checks whether the given column is numeric or not. Can accept missing values.
    
    Specified by:
    
    isNumeric in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the index of the column to check
    
    Returns:
    
    true if purely numeric
    
    See Also:
    
    getContentTypes(int)
  - isContentType
```
public boolean isContentType(int columnIndex,
                             Cell.ContentType type)
```
    Checks whether the given column is of the specific content type or not.
    
    Specified by:
    
    isContentType in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the index of the column to check
    
    type - the content type to check
    
    Returns:
    
    true if column purely consists of this content type
    
    See Also:
    
    getContentType(int)
  - getContentType
```
public Cell.ContentType getContentType(int columnIndex)
```
    Returns the pure content type of the given column, if available.
    
    Specified by:
    
    getContentType in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the index of the column to check
    
    Returns:
    
    the content type that this column consists of solely, null if mixed
  - getContentTypes
```
public Collection<Cell.ContentType> getContentTypes(int columnIndex)
```
    Returns the all content types of the given column, if available.
    
    Specified by:
    
    getContentTypes in interface SpreadSheet
    
    Parameters:
    
    columnIndex - the index of the column to check
    
    Returns:
    
    the content types that this column consists of
  - getCellValues
```
public List<String> getCellValues(String colKey)
```
    Returns the unique string values of the specified column. The returned list is sorted.
    
    Specified by:
    
    getCellValues in interface SpreadSheet
    
    Parameters:
    
    colKey - the column to retrieve the values for
    
    Returns:
    
    the sorted, list of unique values
  - getCellValues
```
public List<String> getCellValues(int colIndex)
```
    Returns the unique string values of the specified column. The returned list is sorted.
    
    Specified by:
    
    getCellValues in interface SpreadSheet
    
    Parameters:
    
    colIndex - the column to retrieve the values for
    
    Returns:
    
    the sorted, list of unique values
  - equalsHeader
```
public String equalsHeader(SpreadSheet other)
```
    Compares the header of this spreadsheet with the other one.
    
    Specified by:
    
    equalsHeader in interface SpreadSheet
    
    Parameters:
    
    other - the other spreadsheet to compare with
    
    Returns:
    
    null if equal, otherwise details what differs
  - toString
```
public String toString()
```
    Returns the spreadsheet as string, i.e., CSV formatted.
    
    Specified by:
    
    toString in interface SpreadSheet
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string representation
  - toMatrix
```
public Object[][] toMatrix()
```
    Returns the spreadsheet as matrix, with the header as the first row. Missing values are represented as null values.
    
    Specified by:
    
    toMatrix in interface SpreadSheet
    
    Returns:
    
    the row-wise matrix
  - removeMissing
```
public boolean removeMissing()
```
    Removes all cells marked "missing".
    
    Specified by:
    
    removeMissing in interface SpreadSheet
    
    Returns:
    
    true if any cell was removed
  - getSharedStringsTable
```
public SharedStringsTable getSharedStringsTable()
```
    Returns the table for shared strings.
    
    Specified by:
    
    getSharedStringsTable in interface SpreadSheet
    
    Returns:
    
    the table
  - setDateLenient
```
public void setDateLenient(boolean value)
```
    Sets whether parsing of dates is to be lenient or not.
    
    Specified by:
    
    setDateLenient in interface SpreadSheet
    
    Parameters:
    
    value - if true lenient parsing is used, otherwise not
    
    See Also:
    
    DateFormat.setLenient(boolean)
  - isDateLenient
```
public boolean isDateLenient()
```
    Returns whether the parsing of dates is lenient or not.
    
    Specified by:
    
    isDateLenient in interface SpreadSheet
    
    Returns:
    
    true if parsing is lenient
    
    See Also:
    
    DateFormat.isLenient()
  - setDateTimeLenient
```
public void setDateTimeLenient(boolean value)
```
    Sets whether parsing of date/times is to be lenient or not.
    
    Specified by:
    
    setDateTimeLenient in interface SpreadSheet
    
    Parameters:
    
    value - if true lenient parsing is used, otherwise not
    
    See Also:
    
    DateFormat.setLenient(boolean)
  - isDateTimeLenient
```
public boolean isDateTimeLenient()
```
    Returns whether the parsing of date/times is lenient or not.
    
    Specified by:
    
    isDateTimeLenient in interface SpreadSheet
    
    Returns:
    
    true if parsing is lenient
    
    See Also:
    
    DateFormat.isLenient()
  - setDateTimeMsecLenient
```
public void setDateTimeMsecLenient(boolean value)
```
    Sets whether parsing of date/time mses is to be lenient or not.
    
    Specified by:
    
    setDateTimeMsecLenient in interface SpreadSheet
    
    Parameters:
    
    value - if true lenient parsing is used, otherwise not
    
    See Also:
    
    DateFormat.setLenient(boolean)
  - isDateTimeMsecLenient
```
public boolean isDateTimeMsecLenient()
```
    Returns whether the parsing of date/time msecs is lenient or not.
    
    Specified by:
    
    isDateTimeMsecLenient in interface SpreadSheet
    
    Returns:
    
    true if parsing is lenient
    
    See Also:
    
    DateFormat.isLenient()
  - setTimeLenient
```
public void setTimeLenient(boolean value)
```
    Sets whether parsing of times is to be lenient or not.
    
    Specified by:
    
    setTimeLenient in interface SpreadSheet
    
    Parameters:
    
    value - if true lenient parsing is used, otherwise not
  - isTimeLenient
```
public boolean isTimeLenient()
```
    Returns whether the parsing of times is lenient or not.
    
    Specified by:
    
    isTimeLenient in interface SpreadSheet
    
    Returns:
    
    true if parsing is lenient
  - setTimeMsecLenient
```
public void setTimeMsecLenient(boolean value)
```
    Sets whether parsing of times/msec is to be lenient or not.
    
    Specified by:
    
    setTimeMsecLenient in interface SpreadSheet
    
    Parameters:
    
    value - if true lenient parsing is used, otherwise not
  - isTimeMsecLenient
```
public boolean isTimeMsecLenient()
```
    Returns whether the parsing of times/msec is lenient or not.
    
    Specified by:
    
    isTimeMsecLenient in interface SpreadSheet
    
    Returns:
    
    true if parsing is lenient
  - setTimeZone
```
public void setTimeZone(TimeZone value)
```
    Sets the timezone to use.
    
    Specified by:
    
    setTimeZone in interface SpreadSheet
    
    Parameters:
    
    value - the new timezone
    
    See Also:
    
    DateFormat.setTimeZone(TimeZone)
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Returns the currently used timezone.
    
    Specified by:
    
    getTimeZone in interface SpreadSheet
    
    Returns:
    
    the current timezone
    
    See Also:
    
    DateFormat.getTimeZone()
  - setLocale
```
public void setLocale(Locale value)
```
    Sets the locale. Used in formatting/parsing numbers.
    
    Specified by:
    
    setLocale in interface LocaleSupporter
    
    Specified by:
    
    setLocale in interface SpreadSheet
    
    Parameters:
    
    value - the locale to use
  - getLocale
```
public Locale getLocale()
```
    Returns the current locale.
    
    Specified by:
    
    getLocale in interface LocaleSupporter
    
    Specified by:
    
    getLocale in interface SpreadSheet
    
    Returns:
    
    the locale
  - calculate
```
public void calculate()
```
    Triggers all formula cells to recalculate their values.
    
    Specified by:
    
    calculate in interface SpreadSheet
  - mergeWith
```
public void mergeWith(SpreadSheet other)
```
    Puts the content of the provided spreadsheet on the right.
    
    Specified by:
    
    mergeWith in interface Mergeable<SpreadSheet>
    
    Specified by:
    
    mergeWith in interface SpreadSheet
    
    Parameters:
    
    other - the spreadsheet to merge with
  - toView
```
public SpreadSheet toView(int[] rows,
                          int[] columns)
```
    Creates a view of the spreadsheet with the specified rows/columns.
    
    Specified by:
    
    toView in interface SpreadSheet
    
    Parameters:
    
    columns - the columns to use, null for all
    
    rows - the rows to use, null for all
    
    Returns:
    
    the view
  - main
```
public static void main(String[] args)
```

Class DefaultSpreadSheet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMMENT

MISSING_VALUE

m_RowKeys

m_Rows

m_HeaderRow

m_Comments

m_Name

m_DateFormat

m_DateTimeFormat

m_DateTimeMsecFormat

m_TimeFormat

m_TimeMsecFormat

m_NumberFormat

m_Locale

m_StringsTable

m_DataRowClass

m_DataRowConstructor

Constructor Detail

DefaultSpreadSheet

Method Detail

initialize

assign

setDataRowClass

getDataRowClass

newInstance

getClone

getHeader

getDateFormat

getDateTimeFormat

getDateTimeMsecFormat

getTimeFormat

getTimeMsecFormat

getNumberFormat

setName

getName

hasName

addComment

addComment

getComments

clear

getHeaderRow

getColumnName

getColumnNames

hasRow

hasRow

newRow

newCell

addRow

addRow

insertRow

removeRow

removeRow

insertColumn

insertColumn

insertColumn

removeColumn

removeColumn

getRow

getRow

getRowKey

getRowIndex

getCellIndex

hasCell

getCell

getCellPosition

rowKeys

rows

sortRowKeys

sortRowKeys

sort

sort

sort

getColumnCount

getRowCount