org.pharmgkb.common.io.google

Class GoogleSheetsHelper

java.lang.Object

org.pharmgkb.common.io.google.GoogleSheetsHelper

All Implemented Interfaces:

java.lang.AutoCloseable

public class GoogleSheetsHelper
extends java.lang.Object
implements java.lang.AutoCloseable

This is a helper class for working with the Google Sheets API.

This relies on the old GData API. Docs at https://developers.google.com/google-apps/spreadsheets/.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SHEETS_SCOPE

Constructor Summary

Constructors

Constructor and Description
GoogleSheetsHelper(GoogleApiHelper apiHelper, java.lang.String service)
GoogleSheetsHelper(java.lang.String userId, java.lang.String privateKey, java.lang.String service)

Method Summary

Modifier and Type	Method and Description
void	close()
void	exportToTsv(java.lang.String fileId, java.nio.file.Path tsvFile) Exports sheet with the specified ID to TSV.
void	exportToTsv(java.lang.String fileId, java.nio.file.Path tsvFile, int sheetNumber) Exports sheet with the specified ID to TSV.
void	exportToTsv(java.lang.String fileId, java.nio.file.Path tsvFile, java.lang.String sheetName) Exports sheet with the specified ID to TSV.
void	exportToTsv(java.net.URL url, java.nio.file.Path tsvFile) Exports the default sheet with the specified ID to TSV.
void	exportToTsv(java.net.URL url, java.nio.file.Path tsvFile, int sheetNumber) Exports the specified sheet with the specified ID to TSV.
void	exportToTsv(java.net.URL url, java.nio.file.Path tsvFile, java.lang.String sheetName) Exports the specified sheet with the specified ID to TSV.
com.google.gdata.client.spreadsheet.SpreadsheetService	getService()
java.util.List<com.google.gdata.data.spreadsheet.SpreadsheetEntry>	getSheets() Gets a list of all sheets for user.

Methods inherited from class java.lang.Object

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

Field Detail

SHEETS_SCOPE

public static final java.lang.String SHEETS_SCOPE

See Also:

Constant Field Values

Constructor Detail

GoogleSheetsHelper

public GoogleSheetsHelper(@Nonnull
                          java.lang.String userId,
                          @Nonnull
                          java.lang.String privateKey,
                          @Nonnull
                          java.lang.String service)
                   throws java.io.IOException,
                          java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

GoogleSheetsHelper

public GoogleSheetsHelper(@Nonnull
                          GoogleApiHelper apiHelper,
                          @Nonnull
                          java.lang.String service)
                   throws java.io.IOException,
                          java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

getService

public com.google.gdata.client.spreadsheet.SpreadsheetService getService()

getSheets

public java.util.List<com.google.gdata.data.spreadsheet.SpreadsheetEntry> getSheets()
                                                                             throws java.io.IOException,
                                                                                    com.google.gdata.util.ServiceException

Gets a list of all sheets for user.

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

exportToTsv

public void exportToTsv(java.lang.String fileId,
                        java.nio.file.Path tsvFile)
                 throws java.io.IOException,
                        com.google.gdata.util.ServiceException

Exports sheet with the specified ID to TSV.

Parameters:

fileId - a file Id from Google Drive

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

exportToTsv

public void exportToTsv(java.net.URL url,
                        java.nio.file.Path tsvFile)
                 throws java.io.IOException,
                        com.google.gdata.util.ServiceException

Exports the default sheet with the specified ID to TSV.

Parameters:

url - URL from BaseEntry.getId() ()}

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

exportToTsv

public void exportToTsv(java.lang.String fileId,
                        java.nio.file.Path tsvFile,
                        int sheetNumber)
                 throws java.io.IOException,
                        com.google.gdata.util.ServiceException

Exports sheet with the specified ID to TSV.

Parameters:

fileId - a file Id from Google Drive

sheetNumber - sheet number (starting at 0)

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

exportToTsv

public void exportToTsv(java.net.URL url,
                        java.nio.file.Path tsvFile,
                        int sheetNumber)
                 throws java.io.IOException,
                        com.google.gdata.util.ServiceException

Exports the specified sheet with the specified ID to TSV.

Parameters:

url - URL from BaseEntry.getId() ()}

sheetNumber - sheet number (starting at 0)

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

exportToTsv

public void exportToTsv(java.lang.String fileId,
                        java.nio.file.Path tsvFile,
                        java.lang.String sheetName)
                 throws java.io.IOException,
                        com.google.gdata.util.ServiceException

Exports sheet with the specified ID to TSV.

Parameters:

fileId - a file Id from Google Drive

sheetName - sheet name

Throws:

java.io.IOException

com.google.gdata.util.ServiceException

exportToTsv

public void exportToTsv(java.net.URL url,
                        java.nio.file.Path tsvFile,
                        java.lang.String sheetName)
                 throws java.io.IOException,
                        com.google.gdata.util.ServiceException

Exports the specified sheet with the specified ID to TSV.

Parameters:

url - URL from BaseEntry.getId() ()}

sheetName - sheet name

Throws:

java.io.IOException

com.google.gdata.util.ServiceException