Package org.eclipse.epsilon.emc.spreadsheets.google

Class GSWorksheet

java.lang.Object

org.eclipse.epsilon.emc.spreadsheets.SpreadsheetWorksheet

org.eclipse.epsilon.emc.spreadsheets.google.GSWorksheet

public class GSWorksheet
extends SpreadsheetWorksheet

Field Summary

Fields inherited from class org.eclipse.epsilon.emc.spreadsheets.SpreadsheetWorksheet

alias, dataTypeStrict, existsInSpreadsheet, header, name

Constructor Summary

Constructors

Constructor	Description
GSWorksheet(GSModel model, com.google.gdata.data.spreadsheet.WorksheetEntry worksheetEntry, boolean existsInSpreadsheet)

Method Summary

Modifier and Type	Method	Description
SpreadsheetColumn	addColumn(ISpreadsheetMetadata.SpreadsheetColumnMetadata metadata)	Adds information about an existing header column to the worksheet.
protected void	checkThatWorksheetExists()	This method checks if this worksheet exists in the spreadsheet.
SpreadsheetColumn	createColumn(int columnIndex)	Creates a column with the specified column index
protected void	createInSpreadsheet()	The purpose of this method is to create this worksheet in the spreadsheet
void	delete()	Deletes this worksheet from the containing spreadsheet.
int	getColumnOffset()
java.lang.String	getDefaultEmptyCellValue()	This method returns the default value to be written to a cell when a new empty row is created in a worksheet that is not enforcing data type strictness.
com.google.gdata.data.spreadsheet.ListEntry	getListEntry(GSRow row)
java.net.URL	getListFeedURL()	Returns the List Feed URL for working with this worksheet.
int	getRowIndex(GSRow row)
java.util.List<SpreadsheetRow>	getRows()	Gets all rows contained by the worksheet
void	getSelf()
protected SpreadsheetRow	insertRow(java.util.Map<SpreadsheetColumn,java.lang.String> values)	Inserts a new row in the worksheet with given values in the given columns.
protected void	loadHeader()	Loads header row information - index and name - from the spreadsheet if the worksheet exists in the spreadsheet
void	removeRow(SpreadsheetRow row)	Deletes the given row from the actual worksheet.
void	writeHeaderCell(int columnIndex, java.lang.String columnName)

Methods inherited from class org.eclipse.epsilon.emc.spreadsheets.SpreadsheetWorksheet

addColumn, addRow, addRowWithValuesInColumns, addWorksheetMetadata, deleteRow, findRows, getAlias, getColumn, getColumn, getDoesNotExistInSpreadsheet, getExistsInSpreadsheet, getHeader, getModel, getName, getNonexistentWorksheetMessage, getValuesForEmptyRow, isDataTypeStrict, isIdentifiablyBy, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GSWorksheet

public GSWorksheet(GSModel model,
                   com.google.gdata.data.spreadsheet.WorksheetEntry worksheetEntry,
                   boolean existsInSpreadsheet)
            throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

loadHeader

protected void loadHeader()
                   throws EolModelLoadingException

Description copied from class: SpreadsheetWorksheet

Loads header row information - index and name - from the spreadsheet if the worksheet exists in the spreadsheet

Specified by:

loadHeader in class SpreadsheetWorksheet

Throws:

EolModelLoadingException

writeHeaderCell

public void writeHeaderCell(int columnIndex,
                            java.lang.String columnName)
                     throws java.lang.Exception

Throws:

java.lang.Exception

delete

public void delete()
            throws java.lang.Exception

Deletes this worksheet from the containing spreadsheet.

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

java.lang.Exception

addColumn

public SpreadsheetColumn addColumn(ISpreadsheetMetadata.SpreadsheetColumnMetadata metadata)

Description copied from class: SpreadsheetWorksheet

Adds information about an existing header column to the worksheet. If the column described by the given metadata does not exist the column is created.

Overrides:

addColumn in class SpreadsheetWorksheet

Returns:

SpreadsheetColumn

createColumn

public SpreadsheetColumn createColumn(int columnIndex)

Description copied from class: SpreadsheetWorksheet

Creates a column with the specified column index

Specified by:

createColumn in class SpreadsheetWorksheet

Returns:

column

getRows

public java.util.List<SpreadsheetRow> getRows()

Description copied from class: SpreadsheetWorksheet

Gets all rows contained by the worksheet

Specified by:

getRows in class SpreadsheetWorksheet

Returns:

List of rows

insertRow

protected SpreadsheetRow insertRow(java.util.Map<SpreadsheetColumn,java.lang.String> values)

Description copied from class: SpreadsheetWorksheet

Inserts a new row in the worksheet with given values in the given columns.

Specified by:

insertRow in class SpreadsheetWorksheet

Returns:

the newly created row

removeRow

public void removeRow(SpreadsheetRow row)

Description copied from class: SpreadsheetWorksheet

Deletes the given row from the actual worksheet.

Specified by:

removeRow in class SpreadsheetWorksheet

checkThatWorksheetExists

protected void checkThatWorksheetExists()

Description copied from class: SpreadsheetWorksheet

This method checks if this worksheet exists in the spreadsheet.

Overrides:

checkThatWorksheetExists in class SpreadsheetWorksheet

getDefaultEmptyCellValue

public java.lang.String getDefaultEmptyCellValue()

Description copied from class: SpreadsheetWorksheet

This method returns the default value to be written to a cell when a new empty row is created in a worksheet that is not enforcing data type strictness.

Specified by:

getDefaultEmptyCellValue in class SpreadsheetWorksheet

Returns:

String

getColumnOffset

public int getColumnOffset()

getListFeedURL

public java.net.URL getListFeedURL()
                            throws java.io.IOException,
                                   com.google.gdata.util.ServiceException

Returns the List Feed URL for working with this worksheet.

Returns:

URL

Throws:

com.google.gdata.util.ServiceException

java.io.IOException

getRowIndex

public int getRowIndex(GSRow row)

getListEntry

public com.google.gdata.data.spreadsheet.ListEntry getListEntry(GSRow row)
                                                         throws java.io.IOException,
                                                                com.google.gdata.util.ServiceException

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

createInSpreadsheet

protected void createInSpreadsheet()

Description copied from class: SpreadsheetWorksheet

The purpose of this method is to create this worksheet in the spreadsheet

Specified by:

createInSpreadsheet in class SpreadsheetWorksheet

getSelf

public void getSelf()
             throws java.lang.Exception

Throws:

java.lang.Exception